fix: add types to help with required nodemon usage #2204
Merged
+140
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nodemon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
remy
changed the title
|
🎉 This PR is included in version 3.1.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Jun 15, 2024
This was referenced Sep 27, 2024
This was referenced Oct 5, 2024
forivall
reviewed
Apr 8, 2025
Comment on lines
+107
to
+108
| restartable?: false | String; | ||
| colours?: Boolean; |
Contributor
There was a problem hiding this comment.
These should be the primitive types, not the object wrappers.
Suggested change
| restartable?: false | String; | |
| colours?: Boolean; | |
| restartable?: false | string; | |
| colours?: boolean; |
Comment on lines
+87
to
+89
| message: String; | ||
| /** contains the terminal escape codes to add colour, plus the "[nodemon]" prefix */ | ||
| colour: String; |
Contributor
There was a problem hiding this comment.
Suggested change
| message: String; | |
| /** contains the terminal escape codes to add colour, plus the "[nodemon]" prefix */ | |
| colour: String; | |
| message: string; | |
| /** contains the terminal escape codes to add colour, plus the "[nodemon]" prefix */ | |
| colour: string; |
| // TODO: Define the type of NodemonEventConfig | ||
| type NodemonEventConfig = any; | ||
|
|
||
| interface NodemonSettings { |
Contributor
There was a problem hiding this comment.
could add the jsdoc from the old DefinitelyTyped types for improved developer experience, as seen here:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/98e6d36d1a9b2c7ec918855454ef6b8642f8cf84/types/nodemon/index.d.ts#L116-L119
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hopefully helps devs use nodemon as required and adds some advice in tools like VS Code.