Improve the coverage of the README (#995) #1000
Conversation
|
Thanks, I made a bunch of tweaks, reverted unrelated formatting changes. Re the behavior of |
| Most options can be specified by a `"ts-node"` object in `tsconfig.json` using their programmatic, camelCase names. For example, to enable `--transpile-only`: | ||
|
|
||
| ```json | ||
| // tsconfig.json |
There was a problem hiding this comment.
Strictly speaking, comments are not allowed in JSON. Given the context is given in the line above, we could/should skip this here.
| * `readFile`: Custom TypeScript-compatible file reading function | ||
| * `fileExists`: Custom TypeScript-compatible file existence function | ||
|
|
||
| ### Options via tsconfig.json |
There was a problem hiding this comment.
I intentionally had this without a title in the CLI and Programmatic Options section as my understanding is that this only applies to those options (but not the CLI-only or programmatic-only options). Now we are mixing with the titles and sections what options are available and how to provide them. But given that neither approach is perfect, just do you what you think is best.
| * `--version` Prints version information | ||
| * `-h, --help` Prints the help text | ||
| * `-v, --version` Prints the version. `-vv` prints node and typescript compiler versions, too | ||
| * `-s, --script-mode` Resolve config relative to the directory of the passed script instead of the current directory. Changes default of `--dir` |
There was a problem hiding this comment.
Resolve -> Resolves for consistency
I leave it to you whether you want to create a new issue for this or not. Progress on this would be appreciated, though. 🤓 |
Preview available at https://github.com/KasparEtter/ts-node/tree/readme