completed-docs does not report any errors

[Rukenshia]

Bug Report

• TSLint version: 4.5.1
• TypeScript version: 2.0.2
• Running TSLint via: CLI

TypeScript code being linted

export function x() {
    return 1;
}

with tslint.json configuration:

{
  "rules": {
    "completed-docs": true
  }
}

Actual behavior

$ node_modules/.bin/tslint --type-check src/test.ts
Warning: The 'completed-docs' rule requires type checking

Expected behavior

Shouldn't I get a message about documentation missing? Sadly https://palantir.github.io/tslint/rules/completed-docs/ just displays a white page for me. Maybe I'm just using or imagining it wrong but ideally, I'd like to enforce everything being documented.

[ajafff]

For --type-check to work you also need to pass --project ./path/to/tsconfig.json as stated in the CLI documentation. Also the file you want to lint needs to be part of you project (included in tsconfig.json)

But maybe that should also be printed as error or warning ...

[Rukenshia]

Okay, that solved it. In the actual script I am running I just passed -p tsconfig.json, but tslint needs --project. I assumed I could pass it as -p like with tsc.