Tslint: Describe how to run tslint with type checking form the command line

[scharf]

Bug Report

• __TSLint version__: 5.4.3
• __TypeScript version__: 2.3.4
• __Running TSLint via__: CLI

How to run tslint with type checking? I simply don't understand the documentation in docs/usage/type-checking/index.md

• What is this program snippet shown in the docu used for?
• Where to put it?
• How run tslint with --project form the command line?

When I run it

tslint --project admin/tslint.json "project/**/*.ts{,x}"

I get

Invalid source file: project/main.ts. Ensure that the files supplied to lint 
have a .ts, .tsx, .d.ts, .js or .jsx extension.

[ajafff]

--project needs to point to your tsconfig.json.
Try tslint --project admin/tsconfig.json
You also don't need to specify the files to lint. It will automatically include all files in the project.

Note to myself: we definitely need to report errors when loading tsconfig.json fails.

[scharf]

But how doestslint know which files belong to the project?

The documentation of --project says:

The location of a tsconfig.json file that will be used to determine which files will be linted.

What is a tsling project? How to create a project? I cannot find anything talking relevant about the concept of tslint projects.

[scharf]

Ah! Looking into files of PR #2688 I understand that by project you mean the tsconfig.json file!

[scharf]

I am slightly dyslexic and I confused tslint.json with tsconfig.json! Maybe a full example would help

tslint --config admin/tslint.json --project proj/tsconfig.json 

[adidahiya]

@scharf that's fair; a full example of using --project would certainly be helpful in the documentation.

[scharf]

In particular because the --config flag does not take the file that contains the string config (tsconfig.json) which causes a kind of Stroop effect.

Say the COLOR, not the word: