-
-
Notifications
You must be signed in to change notification settings - Fork 37
docs: Add section on type-only dependencies #156
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
Conversation
docs/typescript.md
Outdated
| ### Type-Only Dependencies | ||
| If package `a` imports only types from `b`, `b` be a dev or production dependency of `a`? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If package `a` imports only types from `b`, `b` be a dev or production dependency of `a`? | |
| If package `a` imports only types from package `b`, should `b` be a dev or production dependency of `a`? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going with @mcmire under the logic that it's clear from the context that b is a package.
Co-authored-by: Elliot Winkler <[email protected]>
|
Linking for reference:
|
|
The current header hierarchy was intended to keep guideline entries consistently at H4, and to leave room for sections to be organized with H3 sub-headings (as e.g. The entries that have been promoted to H3 are now at the same level as sub-chapter headers e.g. |
mcmire
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
|
@MajorLift I think it's aesthetically frustrating more than anything else, but happy to revert if anyone feels strongly about it. |
Adds a section explaining when you should list a type-only dependency as a dev vs. prod dependency. Also opportunistically fixes header hierarchy in TypeScript docs.
Note
Adds a new "Type-Only Dependencies" section and normalizes heading hierarchy in
docs/typescript.md.####to###for consistency acrossGeneric Types,Interfaces,Enums, andFunctionssections.Written by Cursor Bugbot for commit 5822978. This will update automatically on new commits. Configure here.