Merge pull request #2728 from pg56714/chore/add-prettier-workflow

chore: add prettier workflow

Author: MattCSmith

.github/workflows/post-merge.yml

@@ -1,15 +1,16 @@
-name: Update cards and screenshots
+name: Update cards, screenshots, and fix code style
 
 on:
   push:
     branches:
       - master
+
 env:
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   SKIP_REST: false
 
 jobs:
-  update-cards-and-screenshots:
+  update-cards-and-screenshots-and-fix-code-style:
     runs-on: ubuntu-latest
     # Don't push changes to main branches in forks as this causes merge conflicts
     if: ${{ !github.event.repository.fork }}
@@ -37,6 +38,7 @@ jobs:
         run: |
           git config --global user.name "GitHub Actions"
           git config --global user.email "actions@github.com"
+          
       - name: Generate cards.json
         run: node generators/generateCards.js
 
@@ -49,23 +51,27 @@ jobs:
             git add public/cards.json
             git commit -m "(CI) cards.json Generation"
           fi
-      - name: Format cards
-        if: env.SKIP_REST != 'true'
-        run: |
-          if [ ! -f .prettierrc ]; then
-            echo ".prettierrc not found"
-            echo "terminating workflow..."
-            exit 1;
-          fi
-          npx prettier public/cards.json --write
-          git add public/cards.json
-          git commit -m "(CI) Format cards" || echo "No changes to commit"
+
       - name: Generate screenshots
         if: env.SKIP_REST != 'true'
         run: |
           node generators/generateScreenshot.js
           git add Art/**/icon.png
           git commit -m "(CI) Screenshot Generation" || echo "No changes to commit"
+
       - name: Push changes
         if: env.SKIP_REST != 'true'
         run: git push origin master
+
+      - name: Run Prettier to fix code style
+        id: prettier-run
+        run: |
+          npm run prettier:fix
+          echo "filecount=$(git status -s -uno | wc -L)" >> $GITHUB_OUTPUT
+
+      - name: Commit Prettier changes
+        if: ${{ steps.prettier-run.outputs.filecount > 0 }}
+        run: |
+          git add .
+          git commit -m "(CI) Run Prettier"
+          git push origin master

.prettierignore

@@ -1 +1,5 @@
-.prettierrc
+.prettierrc
+.github/
+node_modules/
+public/
+package*.json

README.md

@@ -72,17 +72,19 @@ Now for the fun part! Inside the `Art/` folder:
 - Create a new directory named: <github_username>-<art_name> eg. `mattcsmith-helloworld`.
 - Inside **your** folder, create an `index.html` file
 - Inside **your** folder, create an `styles.css` file
-- Inside **your** folder, create an `meta.json` file   
-to specify your art name, github author and github link  
-Note: copy the following snippet and replace only the values with your own details,  
-Do not change the JSON keys.
+- Inside **your** folder, create an `meta.json` file  
+  to specify your art name, github author and github link  
+  Note: copy the following snippet and replace only the values with your own details,  
+  Do not change the JSON keys.
+
 ```json
 // Example
 {
-    "artName": "hello world",
-    "githubHandle": "mattcsmith"
+  "artName": "hello world",
+  "githubHandle": "mattcsmith"
 }
 ```
+
 - Use these to create your **animated artwork** — let your creativity flow!
 
 ⚠️ It is important to name the directory and your files exactly as mentioned above ⚠️
@@ -96,6 +98,7 @@ Remembering to first pull down the recent changes from to the upstream, commit y
 - [Aldo's Contributing to Github video](https://www.youtube.com/watch?v=uQLNFRviB6Q)
 
 ### 6. [ OPTIONAL ] Tweet about your progress
+
 Optinonally you can [Tweet about making your first Hacktoberfest pull request](https://ctt.ac/36L1C) on X
 
 ---

package-lock.json

@@ -1,8 +1,12 @@
 {
-  "name": "AnimationNation2024",
+  "name": "animationnation2024",
   "version": "1.0.0",
   "main": "index.js",
   "license": "MIT",
+  "scripts": {
+    "prettier": "npx prettier . --check --config ./.prettierrc",
+    "prettier:fix": "npx prettier . --check --write --config ./.prettierrc"
+  },
   "devDependencies": {
     "prettier": "^2.8.8",
     "puppeteer": "^23.5.0",