-
-
Notifications
You must be signed in to change notification settings - Fork 535
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.
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
Docs: adding a more prevalent notes about using custom typings and '-r ts-node/register' and clearifying what they do #1074
Comments
Flags can also be specified within your tsconfig file: |
Marked as "help wanted" to indicate that this is a good candidate for a pull request. A few notes:
|
ah, missed that part. would probably be a good idea to put it on top of the description-list.
i figured. i added a comment about including a note for that on #1007 |
Closing because I doubt anyone will send us a PR for this, and I touched up the docs in #1682, so this is probably fixed. |
currently, my types are missing includes this on it's final line:
this is easily overlooked and issues and questions around this are posted regularly.
And while many of these are answered with the solution
--files
, this is not an option if the process is started vianode -r ts-node/register
(or for #1007node --loader ts-node/esm.mjs
) and the only mention in these discussions of using an env-variable i found is from #866 (which i only found because of a small mention in whatever thetopsites.net is)as noted in that issue:
for the first paragrapg: while it is now mentioned a few times in the readme, it's still very much hidden behind specific usecases and this mention:
is under the label of programmatic use which is largely unfitting since this is a shell command
for the second and third: this is still very much the case. since tsconfig has a 'files'-property that expects an array of files to include in the project, it is very misleading to use the same term for a toggle option. And this needs to be clearly stated in every paragraf talking about loading a tsconfig.json as 'loading a config' implies that the ts-compiler behaves the same with or without ts-node.
I would generally consider this less of a doccumentation flaw than a software flaw
As stated in my types are missing:
The page in the provided link mentions "type package" exactly once
And while that does explain it, it's easy to overlook. The term "types package" doesn't really exist. there is no reference to what it is on the first google search page and in the TypeScript Handbook search-bar it doesnt yield any related results.
the code example of a declaration file makes it seem like it just has to be a
.d.ts
-moduleconclusion
I would consider this to be a high-priority issue, as it can form a major roadblock for using ts-node in a production-grade development environment.
The text was updated successfully, but these errors were encountered: