Skip to content

Commit

Permalink
Improve documentation of cli flag --project (palantir#3703)
Browse files Browse the repository at this point in the history
The current documentation of the cli flag `--project` is a little confusing as to which the path of a file or the path of a directory can be specified.

As both are valid options, updating the documentation to make it clear that either the path to a `tsconfig.json` file or the path to a directory containing a `tsconfig.json` file can be specified.
  • Loading branch information
a-xin authored and HyphnKnight committed Apr 9, 2018
1 parent a18e9f9 commit 7498d3b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/tslint-cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,10 @@ const options: Option[] = [
type: "string",
describe: "tsconfig.json file",
description: dedent`
The path or directory containing a tsconfig.json file that will be
used to determine which files will be linted. This flag also enables
rules that require the type checker.`,
The path to the tsconfig.json file or to the directory containing
the tsconfig.json file. The file will be used to determine which
files will be linted. This flag also enables rules that require the
type checker.`,
},
{
name: "type-check",
Expand Down

0 comments on commit 7498d3b

Please sign in to comment.