Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add precision regarding --files option #930

Merged
merged 2 commits into from
Jan 9, 2020
Merged

doc: add precision regarding --files option #930

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ee6d28
doc: add precision regarding `--files` option
ledenis Dec 26, 2019
12fc4b7
Rewording
ledenis Jan 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` and `include`/`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`)
Expand Down Expand Up @@ -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` or `include`/`exclude`, enable `--files` flags or set `TS_NODE_FILES=true`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: how about this phrasing, since some people combine "files" with "include"?

If you must use files, include, or exclude, enable ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, done. Also reworded the phrase above


## Watching and Restarting

Expand Down