style: Format JavaScript files #132
Closed
Conversation
This file contains 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
Also specifies supported Node.js engines, adds prettier as a dev dependency, and upgrades existing packages.
jordan-gillard
commented
Dec 4, 2022
Comment on lines
+49
to
51
| "volta": { | ||
| "node": "17.9.1" | ||
| } |
There was a problem hiding this comment.
Volta is super helpful for managing JS command line tools. It sets the Node CLI to use the one specified in the package.json file. It helps developers who use multiple Node versions (like I do). Highly recommend trying it out.
Totally fine to not use it - it is ignored by npm. So having this addition here is harmless.
|
@micuat Hey Naoto, please lmk what you think. I'd be happy to contribute further :) |
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.
Hey there! I recently discovered your library at an art show last night. I'm a professional dev, so thought I'd lend a hand. Would be happy to discuss other quality improvements like a test suite to avoid code regressions in the future, or even full-blown CI/CD. It would help avoid any future bugs :)
Summary of this PR
This PR adds Prettier as a dev dependency. Prettier is an industry standard code formatter that allows us to maintain uniform code style throughout projects. It also runs prettier on all non-
dist/JS files.Additionally, this PR adds the
"format"script topackage.jsonto make running Prettier easier. It also specifies this project's compatible node engines, since themeydadependency relies on Node versions between 10 and 17. You can see their engines listed here. You'll notice that the engines dependency in this package.json is for Node versions between 14 and 17, whilemeydaallows those between 10 and 17. This is intentional, because Node versions less than 14 are no longer maintained by the Node.js Release Working Group.Related: hydra-synth/hydra#220