Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 1.43 KB

README.md

File metadata and controls

68 lines (55 loc) · 1.43 KB
Raw

Installation

This command line is for checking for words inside folders, for example to check if there are breakpoints to inspect the source code.

Run the command

    go get github.com/mrkaspa/gospector
    cd github.com/mrkaspa/gospector
    godep restore
    go install

Use the command

    gospector --help
    NAME:
       gospector - Check the README.md here httpds://github.com/mrkaspa/gospector
    
    USAGE:
       gospector [global options] command [command options] [arguments...]
    
    VERSION:
       1.0.0
    
    COMMANDS:
    GLOBAL OPTIONS:
       --dir value     Directory to gospect
       --config value  Config file for gospector
       --help, -h      show help
       --version, -v   print the version

Provide a valid dir and if it contains a file gospector.json valid you don't have to provide it explicitly.

A gospector.json looks like this:

{
  "rules": [
    {
      "trailing_spaces": true,
      "extensions": [
        ".rb"
      ],
      "words": [
        "puts"
      ]
    },
    {
      "trailing_spaces": true,  
      "extensions": [
        ".js"
      ],
      "words": [
        "console.log",
        "console.info"
      ]
    }
  ],
  "subdirs": ["spec", "webpack"],
  "excluded": ["app/assets"]
}

With this configuration I want to check when I have some puts inside a *rb files and console.log, console.info inside *.js files inside the spec and webpack folders.