chore: Add Prettier formatting validation to CI pipeline #454
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
Co-authored-by: jonathan <[email protected]>
package.json
Outdated
| "lint": "eslint . --ext .ts --config .eslintrc", | ||
| "postpack": "shx rm -f oclif.manifest.json", | ||
| "posttest": "yarn lint", | ||
| "posttest": "yarn lint && yarn format:check", |
Contributor
There was a problem hiding this comment.
should this be pretest instead of post?
Member
Author
There was a problem hiding this comment.
its probably fine to run the tests first as this won't change functionality.
Contributor
There was a problem hiding this comment.
mostly concerned that this will "fail" the build / task, and then require a full re-run... when this is the usually the fastest failure point
- DEVELOPMENT.md - src/api/customProperties.ts - src/commands/diff/index.ts - src/flags/var-alias/index.ts - src/utils/FileFilters.ts - src/utils/diff/diff.ts
- Add name to CI formatting step for better readability - Use specific glob patterns for prettier to improve performance - Move prettier check to pretest to fail fast before running tests
There was a problem hiding this comment.
Pull Request Overview
This PR integrates Prettier formatting checks into the CI pipeline and developer workflows.
- Adds
formatandformat:checkscripts topackage.json - Hooks
yarn format:checkinto the CI tests andpretestscript - Ensures consistent code formatting across the codebase
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils/diff/diff.ts | Reformatted executeDiff signature onto one line |
| src/utils/FileFilters.ts | Switched to single quotes in type references and added comma |
| src/commands/diff/index.ts | Broke long return expression into multiline for clarity |
| src/api/customProperties.ts | Expanded function parameters onto separate lines |
| package.json | Added Prettier scripts (format, format:check, pretest) |
| DEVELOPMENT.md | Inserted blank lines for better section separation |
| .github/workflows/tests.yml | Added “Check formatting” step before running tests in CI |
kaushalkapasi
approved these changes
Jul 11, 2025
jsalaber
approved these changes
Jul 14, 2025
jonathannorris
added a commit
that referenced
this pull request
Aug 11, 2025
* Add Prettier formatting checks to CI and package scripts Co-authored-by: jonathan <[email protected]> * Format code with prettier - DEVELOPMENT.md - src/api/customProperties.ts - src/commands/diff/index.ts - src/flags/var-alias/index.ts - src/utils/FileFilters.ts - src/utils/diff/diff.ts * Address PR comments - Add name to CI formatting step for better readability - Use specific glob patterns for prettier to improve performance - Move prettier check to pretest to fail fast before running tests --------- Co-authored-by: Cursor Agent <[email protected]>
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.
This PR adds prettier commands to the package.json and integrates formatting checks into the CI workflow to enforce consistent code formatting.
Changes:
formatandformat:checkscripts to package.jsonyarn format:checkduring the test pipelineposttestscript to include prettier validation alongside existing lintingImpact:
yarn formatto auto-format code locallyThe changes leverage existing prettier configuration (
.prettierrc.jsonand.prettierignore) already present in the repository.