Improve docs for --files option (#930)

TypeStrong · Jan 9, 2020 · 3401f59 · 3401f59
1 parent 1a0ace2
commit 3401f59
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -139,7 +139,7 @@ _Environment variable denoted in parentheses._
 * `-O, --compiler-options [opts]` JSON object to merge with compiler options (`TS_NODE_COMPILER_OPTIONS`)
 * `--dir` Specify working directory for config resolution (`TS_NODE_CWD`, default: `process.cwd()`)
 * `--scope` Scope compiler to files within `cwd` (`TS_NODE_SCOPE`, default: `false`)
-* `--files` Load files from `tsconfig.json` on startup (`TS_NODE_FILES`, default: `false`)
+* `--files` Load `files`, `include` and `exclude` from `tsconfig.json` on startup (`TS_NODE_FILES`, default: `false`)
 * `--pretty` Use pretty diagnostic formatter (`TS_NODE_PRETTY`, default: `false`)
 * `--skip-project` Skip project config resolution and loading (`TS_NODE_SKIP_PROJECT`, default: `false`)
 * `--skip-ignore` Skip ignore checks (`TS_NODE_SKIP_IGNORE`, default: `false`)
@@ -215,7 +215,7 @@ An alternative approach for definitions of third-party libraries are [triple-sla
 import UntypedJsLib from "untyped_js_lib"
 ```
 
-**Tip:** If you _must_ use `files`, enable `--files` flags or set `TS_NODE_FILES=true`.
+**Tip:** If you _must_ use `files`, `include`, or `exclude`, enable `--files` flags or set `TS_NODE_FILES=true`.
 
 ## Watching and Restarting
 

diff --git a/src/bin.ts b/src/bin.ts
@@ -130,7 +130,7 @@ export function main (argv: string[]) {
 
     --dir                          Specify working directory for config resolution
     --scope                        Scope compiler to files within \`cwd\` only
-    --files                        Load files from \`tsconfig.json\` on startup
+    --files                        Load \`files\`, \`include\` and \`exclude\` from \`tsconfig.json\` on startup
     --pretty                       Use pretty diagnostic formatter (usually enabled by default)
     --skip-project                 Skip reading \`tsconfig.json\`
     --skip-ignore                  Skip \`--ignore\` checks