Merge pull request #377 from yeatmanlab/ci/format

Add prettier formatting GitHub action

.github/workflows/deploy-firebase-test-cypress.yml

@@ -9,6 +9,7 @@ concurrency:
 
 jobs:
   build-and-preview:
+    name: Deploy preview
     if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
     runs-on: ubuntu-latest
     steps:
@@ -30,6 +31,7 @@ jobs:
       deployUrl: ${{ fromJson(steps.firebase-deploy.outputs.urls)[0] }}
 
   cypress-run:
+    name: Run Cypress Tests
     needs: [build-and-preview]
     runs-on: ubuntu-latest
     timeout-minutes: 90

.github/workflows/deploy-firestore-rules-indexes-dev.yml

@@ -6,6 +6,7 @@ name: Deploy Firestore Rules and Indexes (Development)
 
 jobs:
   deploy-admin-rules:
+    name: Admin Rules
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -19,6 +20,7 @@ jobs:
           PROJECT_ID: gse-roar-admin-dev
           PROJECT_PATH: ./firebase/admin
   deploy-assessment-rules:
+    name: Assessment Rules
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -32,6 +34,7 @@ jobs:
           PROJECT_ID: gse-roar-assessment-dev
           PROJECT_PATH: ./firebase/assessment
   deploy-admin-indexes:
+    name: Admin Indexes
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -45,6 +48,7 @@ jobs:
           PROJECT_ID: gse-roar-admin-dev
           PROJECT_PATH: ./firebase/admin
   deploy-assessment-indexes:
+    name: Assessment Indexes
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo

.github/workflows/deploy-firestore-rules-indexes-production.yml

@@ -8,6 +8,7 @@ name: Deploy Firestore Rules and Indexes (Production)
 
 jobs:
   deploy-admin-rules:
+    name: Admin Rules
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -21,6 +22,7 @@ jobs:
           PROJECT_ID: gse-roar-admin
           PROJECT_PATH: ./firebase/admin
   deploy-assessment-rules:
+    name: Assessment Rules
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -34,6 +36,7 @@ jobs:
           PROJECT_ID: gse-roar-assessment
           PROJECT_PATH: ./firebase/assessment
   deploy-admin-indexes:
+    name: Admin Indexes
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
@@ -47,6 +50,7 @@ jobs:
           PROJECT_ID: gse-roar-admin
           PROJECT_PATH: ./firebase/admin
   deploy-assessment-indexes:
+    name: Assessment Indexes
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo

.github/workflows/firebase-hosting-production.yml

@@ -10,6 +10,7 @@ name: Deploy to Firebase Hosting (production)
       - 'v[0-9]+.[0-9]+.[0-9]+-beta.[0-9]+'
 jobs:
   build_and_deploy:
+    name: Deploy
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Format
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, reopened, synchronize]
+    branches:
+      - main
+
+jobs:
+  build-and-lint:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - run: npm ci
+      - run: npm run check-format

package.json

@@ -15,6 +15,7 @@
     "emulate:stop": "ps -e | grep 'firebase emulators:start' | grep -v 'grep' | grep -v 'rg' | sed -e 's/^[ \t]*//' | tr -s ' ' | cut -d ' ' -f 1 | xargs kill -s INT",
     "cypress:open": "cypress open",
     "format": "prettier . --write",
+    "check-format": "prettier . --check",
     "lint": "eslint --ext .js,.vue --ignore-path .gitignore --fix src",
     "postversion": "GIT_REMOTE=$(git remote -v | grep \"yeatmanlab/roar-dashboard.git \\(push\\)\" | cut -f 1) && git push $GIT_REMOTE && git push $GIT_REMOTE --tags",
     "prepare": "husky install",