Skip to content

chore: update code style configuration with Prettier and ESLint integration #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sonmessia merged 1 commit into from
Dec 7, 2025
Merged

chore: update code style configuration with Prettier and ESLint integration #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/.prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"semi": false,
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Prettier configuration sets "semi": false, but the existing codebase uses semicolons consistently. When Prettier runs, it will remove semicolons from files.

Consider changing this to "semi": true to match the existing code style, or run Prettier on the entire codebase in this PR to complete the style migration.

Suggested change
"semi": false,
"semi": true,

Copilot uses AI. Check for mistakes.
"singleQuote": true,
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Prettier configuration sets "singleQuote": true, but the existing codebase uses double quotes consistently. When Prettier runs, it will reformat documentation and code files to use single quotes.

Consider changing this to "singleQuote": false to match the existing code style, or run Prettier on the entire codebase in this PR to complete the style migration.

Suggested change
"singleQuote": true,
"singleQuote": false,

Copilot uses AI. Check for mistakes.
"tabWidth": 2,
"trailingComma": "es5",
"printWidth": 100,
"bracketSpacing": true,
"endOfLine": "lf",
"overrides": [
{
"files": "*.md",
"options": {
"proseWrap": "preserve"
}
}
]
}
26 changes: 19 additions & 7 deletions docs/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 3 additions & 6 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
// Copyright (c) 2025 Green Wave Team
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT

{
"name": "greenwave-doc",
"version": "1.0.0",
Expand All @@ -17,7 +12,8 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
"typecheck": "tsc",
"format": "prettier --write ."
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format script runs prettier --write . without a .prettierignore file, which will attempt to format all files including package-lock.json, build artifacts, and other generated files that shouldn't be formatted.

Consider adding a .prettierignore file with common exclusions:

node_modules
dist
build
.docusaurus
package-lock.json
*.min.js
*.min.css
coverage

Copilot uses AI. Check for mistakes.
},
"dependencies": {
"@docusaurus/core": "3.9.2",
Expand All @@ -32,6 +28,7 @@
"@docusaurus/module-type-aliases": "3.9.2",
"@docusaurus/tsconfig": "3.9.2",
"@docusaurus/types": "3.9.2",
"prettier": "^3.7.4",
"typescript": "~5.6.2"
},
"browserslist": {
Expand Down
9 changes: 9 additions & 0 deletions src/frontend/.prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"semi": false,
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Prettier configuration sets "semi": false, but the existing codebase uses semicolons consistently at the end of statements. When Prettier runs, it will remove all semicolons from files, causing widespread changes.

Consider changing this to "semi": true to match the existing code style, or run Prettier on the entire codebase in this PR to complete the style migration.

Suggested change
"semi": false,
"semi": true,

Copilot uses AI. Check for mistakes.
"singleQuote": true,
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Prettier configuration sets "singleQuote": true, but the existing codebase uses double quotes consistently for strings and imports (e.g., import { StrictMode } from "react";). When Prettier runs, it will reformat all files to use single quotes, causing widespread changes across the codebase.

Consider changing this to "singleQuote": false to match the existing code style, or run Prettier on the entire codebase in this PR to complete the style migration.

Suggested change
"singleQuote": true,
"singleQuote": false,

Copilot uses AI. Check for mistakes.
"tabWidth": 2,
"trailingComma": "es5",
"printWidth": 100,
"bracketSpacing": true,
"endOfLine": "lf"
}
2 changes: 2 additions & 0 deletions src/frontend/eslint.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import reactHooks from 'eslint-plugin-react-hooks'
import reactRefresh from 'eslint-plugin-react-refresh'
import tseslint from 'typescript-eslint'
import { defineConfig, globalIgnores } from 'eslint/config'
import eslintConfigPrettier from 'eslint-config-prettier'

export default defineConfig([
globalIgnores(['dist']),
Expand All @@ -25,4 +26,5 @@ export default defineConfig([
globals: globals.browser,
},
},
eslintConfigPrettier,
])
39 changes: 34 additions & 5 deletions src/frontend/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 4 additions & 6 deletions src/frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
// Copyright (c) 2025 Green Wave Team
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT

{
"name": "frontend",
"private": true,
Expand All @@ -12,7 +7,8 @@
"dev": "vite",
"build": "tsc -b && vite build",
"lint": "eslint .",
"preview": "vite preview"
"preview": "vite preview",
"format": "prettier --write ."
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The format script runs prettier --write . without a .prettierignore file, which will attempt to format all files including package-lock.json, build artifacts, and other generated files that shouldn't be formatted.

Consider adding a .prettierignore file with common exclusions:

node_modules
dist
build
.docusaurus
package-lock.json
*.min.js
*.min.css
coverage

Copilot uses AI. Check for mistakes.
},
"dependencies": {
"@maptiler/sdk": "^3.8.0",
Expand Down Expand Up @@ -43,9 +39,11 @@
"@types/react-dom": "^19.2.2",
"@vitejs/plugin-react-swc": "^4.2.1",
"eslint": "^9.39.1",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-react-hooks": "^5.2.0",
"eslint-plugin-react-refresh": "^0.4.24",
"globals": "^16.5.0",
"prettier": "^3.7.4",
"typescript": "~5.9.3",
"typescript-eslint": "^8.46.3",
"vite": "npm:rolldown-vite@7.2.2"
Expand Down
Loading