chore(scripts): align npm scripts and docs with Vue stack#3138
Merged
Conversation
- Add `dev` alias for `start` (cross-stack consistency) - Add `test:unit` alias for `test` (one-shot, mirrors Vue naming) - Add `format` script (prettier already installed, script was missing) - Document `prod`, `format`, `test:unit`, `release` strategy in CLAUDE.md - Update README and copilot-instructions to reflect all scripts
There was a problem hiding this comment.
Pull request overview
This PR aligns the Node stack's npm scripts and documentation with the Vue stack to establish cross-stack consistency for developer experience. The changes add standard script aliases (dev, test:unit, format) and update all documentation files to reflect these additions.
Changes:
- Added three npm script aliases in package.json:
dev(alias forstart),test:unit(alias fortest), andformat(runs Prettier) - Updated CLAUDE.md, README.md, and copilot-instructions.md to document the new scripts and clarify release strategies
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Added dev, test:unit, and format script aliases for cross-stack consistency |
| README.md | Updated documentation to include new script aliases in development, testing, and code quality sections |
| CLAUDE.md | Enhanced canonical commands table with new aliases and clarified release strategy (manual vs CI) |
| .github/copilot-instructions.md | Updated canonical commands list to include new aliases and release:auto for CI |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3138 +/- ##
=======================================
Coverage 89.49% 89.49%
=======================================
Files 52 52
Lines 1133 1133
Branches 217 217
=======================================
Hits 1014 1014
Misses 107 107
Partials 12 12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Summary
Aligns Node stack npm scripts and documentation with the Vue stack for cross-stack consistency.
Script changes (
package.json)devnpm run start(alias)test:unitnpm test(one-shot)formatprettier --write .(prettier was already installed)Documentation changes
dev,test:unit,format,prod, explicit release strategy (release= standard-version,release:auto= semantic-release)npm run devalias,test:unit,npm run formatin Code Quality sectiondev,test:unit,format,release:autoScope
lowValidation
npm run lintpassesnpm testpasses