CLI - provide compiler switch --help about tslint

[ashwinr]

What exactly are you looking for with "--help"? Right now, it shows the list of possible arguments along with their description.

[am11]

There is no options --help. It shows the same for --any-invalid-switch. Try --help2, it will give the same output with an error Missing required arguments: f.

Normally, npm's provide --help argument with little more details, clarity and example usage. Try CoffeeScript, JsHint, LESS, SASS etc.

[ashwinr]

sure, we can remove the error for the "--help" argument.

[am11]

And add --help to the arguments list. :)

See here are the detailed docs for JsHint. http://www.jshint.com/docs/. It helped me implementing JsHintCompiler for Web Essentials. And TsLintCompiler was implemented seamlessly on top of it. But due to the lack of docs and usage help, I had to make some educated guesses (as TsLint is inspired by JsHint).

Thanks!

[gscshoyru]

Merged in from pull request #60. Closed.

[am11]

@gscshoyru, the issue still persists. Is this fix released?

PS C:\> node C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\bin\tslint -h
usage: C:\Program Files\nodejs\node.exe C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\bin\tslint

Options:
  -c, --config          configuration file
  -f, --file            file to lint
  -o, --out             output file
  -r, --rules-dir       rules directory
  -s, --formatters-dir  formatters directory
  -t, --format          output format (prose, json)  [default: "prose"]

Missing required arguments: f

Still showing Missing required arguments: f.

Also:

PS C:\> node C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\bin\tslint --help


_stream_writable.js:172
    encoding = state.defaultEncoding;
                    ^
TypeError: Cannot read property 'defaultEncoding' of undefined
    at Writable.write (_stream_writable.js:172:21)
    at Socket.write (net.js:613:40)
    at Object.Argv.self.showHelp (C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\node_modules\optimist\index.js:
180:9)
    at Object.<anonymous> (C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\bin\tslint-cli.js:60259:14)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Module.require (module.js:364:17)
    at require (module.js:380:17)
    at Object.<anonymous> (C:\Users\Adeel\AppData\Roaming\npm\node_modules\tslint\bin\tslint:3:1)
    at Module._compile (module.js:456:26)
    at Object.Module._extensions..js (module.js:474:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:312:12)
    at Function.Module.runMain (module.js:497:10)
    at startup (node.js:119:16)
    at node.js:902:3

[gscshoyru]

Sorry about that, this is fixed with this: #74 . My bad.

[am11]

Thanks. 👍