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

Improve the coverage of the README (#995) #1000

Merged
merged 7 commits into from
Apr 20, 2020
Merged

Improve the coverage of the README (#995) #1000

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d0d3263
Improve the coverage of the README (#995)
KasparEtter Apr 7, 2020
0800638
Revert formatting changes
cspotcode Apr 8, 2020
5130f9b
revert formatting changes
cspotcode Apr 8, 2020
05388ec
revert formatting changes
cspotcode Apr 8, 2020
984fc74
Add explanation for -vv flag
cspotcode Apr 8, 2020
e973116
tweaking docs
cspotcode Apr 8, 2020
36de7d4
more tweaks
cspotcode Apr 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
more tweaks
  • Loading branch information
@cspotcode
cspotcode committed Apr 8, 2020
commit 36de7d435df7ff5559638c1ff9098e3dab92cd81
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ Passing CLI arguments via shebang is allowed on Mac but not Linux. For example,

```
#!/usr/bin/env ts-node --script-mode --transpile-only --files
// This shebang is not portable. It only works on Mac
```

### Programmatic
Expand Down Expand Up @@ -146,7 +147,7 @@ Create a new Node.js configuration and add `-r ts-node/register` to "Node parame

**Typescript Node** loads `tsconfig.json` automatically. Use `--skip-project` to skip loading the `tsconfig.json`.

By default, it is located relative to `--dir`. In `--script-mode`, this is the directory containing the script. Otherwise it is `process.cwd()`.
It is resolved relative to `--dir` using [the same search behavior as `tsc`](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html). In `--script-mode`, this is the directory containing the script. Otherwise it is resolved relative to `process.cwd()`, which matches the behavior of `tsc`.

Use `--project` to specify the path to your `tsconfig.json`, ignoring `--dir`.

Expand Down