[DX] Add Prettier for code formatting#947
Conversation
Signed-off-by: Bharath Valaboju <69413757+Bharath314@users.noreply.github.com>
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces Prettier for code formatting by adding configuration files and dependencies. However, the versions for prettier and its organize-imports plugin are invalid, leading to an incorrect typescript version in the lockfile. Feedback recommends using stable versions and adding npm scripts to improve the developer experience.
| "postcss-cli": "^11.0.0", | ||
| "prettier": "3.8.3", | ||
| "prettier-plugin-organize-imports": "^4.3.0" |
There was a problem hiding this comment.
There are a few issues with the added dependencies:
- Invalid Versions: The versions specified for
prettier(3.8.3) andprettier-plugin-organize-imports(^4.3.0) do not exist on the npm registry. This will cause installation failures. Please use valid, stable versions (e.g.,prettier@3.5.0andprettier-plugin-organize-imports@4.1.1). - Missing Scripts: To fulfill the "DX" (Developer Experience) goal of this PR, you should add npm scripts to the
scriptssection ofpackage.json. For example:"format": "prettier --write .", "format:check": "prettier --check ."
- Stability: It is recommended to use a stable, exact version for Prettier to ensure consistent formatting across different environments and avoid unexpected changes during updates.
| "postcss-cli": "^11.0.0", | |
| "prettier": "3.8.3", | |
| "prettier-plugin-organize-imports": "^4.3.0" | |
| "postcss-cli": "^11.0.0", | |
| "prettier": "3.5.0", | |
| "prettier-plugin-organize-imports": "^4.1.1" |
There was a problem hiding this comment.
Looks like those versions of prettier and the plugin aren't in gemini's training data yet 😆 . Should I add the npm scripts? That does look like a good idea.
| } | ||
| }, | ||
| "node_modules/typescript": { | ||
| "version": "6.0.2", |
There was a problem hiding this comment.
The version 6.0.2 for typescript is invalid as the current major version is 5. This likely indicates an issue with the dependency resolution or a typo during the lockfile generation, possibly caused by the invalid versions specified in package.json. Regenerating the lockfile after correcting the devDependencies should resolve this.
|
🚀 Preview deployment for PR #947 🌐 Preview URL: https://layer5io.github.io/docs/pr-preview/pr-947/ This preview will be updated automatically when you push new commits to this PR. |
1 participant
Notes for Reviewers
This PR fixes #91
I used the same
.prettierrcas layer5/sistentSigned commits