Skip to content

Commit 7b9f464

Browse files
committed
chore: add Prettier config and formatting scripts
- Add .prettierrc with project formatting rules - Add .prettierignore to exclude build artifacts, vendor dirs, and non-JS folders - Add root package.json with format/check-format scripts - Add GitHub Actions prettier.yml CI workflow (runs on PRs touching JS/web packages) - Add format/format:check scripts and prettier@3.8.1 devDep to extension, eduaid_web, and eduaid_desktop packages
1 parent f33e27c commit 7b9f464

File tree

7 files changed

+89
-3
lines changed

7 files changed

+89
-3
lines changed

.github/workflows/prettier.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Prettier Check
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "extension/**"
7+
- "eduaid_web/**"
8+
- "eduaid_desktop/**"
9+
- ".prettierrc"
10+
- ".prettierignore"
11+
12+
jobs:
13+
prettier:
14+
name: Check Formatting
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 20
24+
25+
- name: Check extension formatting
26+
run: |
27+
cd extension
28+
npm ci || npm install --legacy-peer-deps
29+
npm run format:check
30+
31+
- name: Check eduaid_web formatting
32+
run: |
33+
cd eduaid_web
34+
npm ci || npm install --legacy-peer-deps
35+
npm run format:check
36+
37+
- name: Check eduaid_desktop formatting
38+
run: |
39+
cd eduaid_desktop
40+
npm ci || npm install --legacy-peer-deps
41+
npm run format:check

.prettierignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
node_modules/
2+
dist/
3+
build/
4+
*.min.js
5+
*.min.css
6+
LICENSE.md
7+
package-lock.json
8+
backend/
9+
Model_experimentation/
10+
Model_training/
11+
Testing/
12+
readme-assets/

.prettierrc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"semi": true,
3+
"singleQuote": false,
4+
"jsxSingleQuote": false,
5+
"tabWidth": 2,
6+
"trailingComma": "es5",
7+
"printWidth": 80,
8+
"bracketSpacing": true,
9+
"bracketSameLine": false,
10+
"arrowParens": "always",
11+
"endOfLine": "lf"
12+
}

eduaid_desktop/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@
1313
"build:electron": "npm run build && electron-builder",
1414
"build:all": "npm run build && electron-builder --mac --win --linux",
1515
"pack": "electron-builder --dir",
16-
"dist": "npm run build:web && npm run copy:web && electron-builder"
16+
"dist": "npm run build:web && npm run copy:web && electron-builder",
17+
"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
18+
"format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\""
1719
},
1820
"keywords": [
1921
"eduaid",
@@ -28,6 +30,7 @@
2830
"concurrently": "^8.2.2",
2931
"electron": "^27.0.0",
3032
"electron-builder": "^24.6.4",
33+
"prettier": "3.8.1",
3134
"wait-on": "^7.2.0"
3235
},
3336
"build": {

eduaid_web/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121
"start": "react-scripts start",
2222
"build": "react-scripts build",
2323
"test": "react-scripts test",
24-
"eject": "react-scripts eject"
24+
"eject": "react-scripts eject",
25+
"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
26+
"format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\""
2527
},
2628
"eslintConfig": {
2729
"extends": [
@@ -42,6 +44,7 @@
4244
]
4345
},
4446
"devDependencies": {
47+
"prettier": "3.8.1",
4548
"tailwindcss": "^3.4.9"
4649
}
4750
}

extension/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
"scripts": {
77
"dev": "vite",
88
"build": "vite build",
9-
"preview": "vite preview"
9+
"preview": "vite preview",
10+
"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md,html}\"",
11+
"format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md,html}\""
1012
},
1113
"dependencies": {
1214
"pdf-lib": "^1.17.1",
@@ -23,6 +25,7 @@
2325
"@vitejs/plugin-react": "^3.1.0",
2426
"autoprefixer": "^10.4.14",
2527
"postcss": "^8.4.21",
28+
"prettier": "3.8.1",
2629
"tailwindcss": "^3.3.1",
2730
"vite": "^4.2.0"
2831
}

package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"name": "eduaid-root",
3+
"version": "1.0.0",
4+
"private": true,
5+
"scripts": {
6+
"format": "prettier --write .",
7+
"check-format": "prettier --check ."
8+
},
9+
"devDependencies": {
10+
"prettier": "3.8.1"
11+
}
12+
}

0 commit comments

Comments
 (0)