-
-
-
-
- Installation
-
-Local (in your project’s working directory):
-
-
-$ npm install tslint typescript --save-dev
-
-
-Global:
-
-
-$ npm install tslint typescript -g
-
-
-Peer dependencies
-
-The typescript module is a peer dependency of TSLint, which allows you to update the compiler independently from the
-linter. This also means that tslint will have to use the same version of tsc used to actually compile your sources.
-
-Breaking changes in the latest dev release of typescript@next might break something in the linter if we haven’t built against that release yet. If this happens to you, you can try:
-
-
- - picking up
tslint@next, which may have some bugfixes not released in tslint@latest
-(see release notes here).
- - rolling back
typescript to a known working version.
-
-
-Usage
-
-Please ensure that the TypeScript source files compile correctly before running the linter.
-
-Usage: tslint [options] [file ...]
-
-Options:
-
-
--c, --config configuration file
---force return status code 0 even if there are lint errors
--h, --help display detailed help
--i, --init generate a tslint.json config file in the current working directory
--o, --out output file
--r, --rules-dir rules directory
--s, --formatters-dir formatters directory
--e, --exclude exclude globs from path expansion
--t, --format output format (prose, json, verbose, pmd, msbuild, checkstyle, vso) [default: "prose"]
---test test that tslint produces the correct output for the specified directory
--v, --version current version
-
-
-By default, TSLint looks for a configuration file named tslint.json in the directory
-of the file being linted and, if not found, searches ancestor directories. Check out the rules section for more details on what rules are available.
-
-tslint accepts the following command-line options:
-
-```
--c, –config:
- The location of the configuration file that tslint will use to
- determine which rules are activated and what options to provide
- to the rules. If no option is specified, the config file named
- tslint.json is used, so long as it exists in the path.
- The format of the file is { rules: { /* rules list / } },
- where / rules list */ is a key: value comma-seperated list of
- rulename: rule-options pairs. Rule-options can be either a
- boolean true/false value denoting whether the rule is used or not,
- or a list [boolean, …] where the boolean provides the same role
- as in the non-list case, and the rest of the list are options passed
- to the rule that will determine what it checks for (such as number
- of characters for the max-line-length rule, or what functions to ban
- for the ban rule).
-
--e, –exclude:
- A filename or glob which indicates files to exclude from linting.
- This option can be supplied multiple times if you need multiple
- globs to indicate which files to exclude.
-
-–force:
- Return status code 0 even if there are any lint errors.
- Useful while running as npm script.
-
--i, –init:
- Generates a tslint.json config file in the current working directory.
-
--o, –out:
- A filename to output the results to. By default, tslint outputs to
- stdout, which is usually the console where you’re running it from.
-
--r, –rules-dir:
- An additional rules directory, for user-created rules.
- tslint will always check its default rules directory, in
- node_modules/tslint/lib/rules, before checking the user-provided
- rules directory, so rules in the user-provided rules directory
- with the same name as the base rules will not be loaded.
-
--s, –formatters-dir:
- An additional formatters directory, for user-created formatters.
- Formatters are files that will format the tslint output, before
- writing it to stdout or the file passed in –out. The default
- directory, node_modules/tslint/build/formatters, will always be
- checked first, so user-created formatters with the same names
- as the base formatters will not be loaded.
-
--t, –format:
- The formatter to use to format the results of the linter before
- outputting it to stdout or the file passed in –out. The core
- formatters are prose (human readable), json (machine readable)
- and verbose. prose is the default if this option is not used.
- Other built-in options include pmd, msbuild, checkstyle, and vso.
- Additonal formatters can be added and used if the –formatters-dir
- option is set.
-
-–test:
- Runs tslint on the specified directory and checks if tslint’s output matches
- the expected output in .lint files. Automatically loads the tslint.json file in the
- specified directory as the configuration file for the tests. See the
- full tslint documentation for more details on how this can be used to test custom rules.
-
--v, –version:
- The current version of tslint.
-
--h, –help:
- Prints this help message.
-```
-
-
-