Merge pull request #99 from cse110-fa22-group29/add-prettier

Add prettier

.github/workflows/prettier.yml

@@ -0,0 +1,29 @@
+name: Prettier
+
+on:
+  pull_request:
+    branches:
+    - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # Single deploy job since we're just deploying
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install apt updates
+        run: sudo apt -y update; sudo apt -y upgrade;
+      - name: Install prerequisites
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install dependencies
+        run: sudo npm install
+      - name: Start local http server
+        run: sudo npm run http-server & 
+      - name: Run tests
+        run: sudo npm lint-prettier

package.json

@@ -10,7 +10,9 @@
     "lint-css": "stylelint **/*.css",
     "fix-css": "stylelint --fix **/*.css",
     "http-server": "http-server source",
-    "js-doc": "jsdoc -d source/docs/ -r source/"
+    "js-doc": "jsdoc -d source/docs/ -r source/",
+    "lint-prettier": "prettier --check .",
+		"fix-prettier": "prettier --write ."
   },
   "devDependencies": {
     "eslint": "^8.27.0",
@@ -21,6 +23,7 @@
     "mock-local-storage": "^1.1.23",
     "puppeteer": "^18.2.1",
     "stylelint": "14.14.1",
-    "stylelint-config-standard": "^29.0.0"
+    "stylelint-config-standard": "^29.0.0",
+    "prettier": "2.8.0"
   }
 }

specs/adrs/112922-prettier.md

@@ -0,0 +1,17 @@
+# Use Prettier for generic style enforcement
+
+- Status: accept
+- Deciders: Arthur Lu, Marc Reta
+- Date: 11 / 29 / 22
+
+## Decision Drivers
+
+- Other linters (HTML, CSS, JS) are sometimes too permissive
+- Need to enforce style on other files like markdown, json
+
+## Considered Options
+- Prettier
+
+## Decision Outcome
+
+Chosen Option: Prettier