Workflow to check JS and PY code format (#242)

* fix css files
* create workflow
* format code using prettier
* black ignore 3rd party folder
* format py code using black
* black exclude option in workflow
* Don't format workflow files
* Add contributing instructions to readme
---------
Co-authored-by: WithoutPants <[email protected]>

Author: Tetrax-10

Diff for: .editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

Diff for: .github/workflows/check_code_format.yml

@@ -0,0 +1,50 @@
+name: Check Code Format
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  check_js_code_format:
+    name: Check JS code format
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+
+      - name: Check format
+        uses: creyD/[email protected]
+        with:
+          prettier_options: --check
+          dry: true
+          only_changed: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+  check_py_code_format:
+    name: Check PY code format
+    runs-on: ubuntu-latest
+    needs: check_js_code_format
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+
+      - name: Check format
+        uses: psf/black@stable
+        with:
+          options: '--exclude="3rd party"'
+          src: "."

Diff for: .github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy repository to Github Pages
 
 on:
   push:
-    branches: [ main, stable ]
+    branches: [main, stable]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -17,27 +17,27 @@ jobs:
   build:
     runs-on: ubuntu-22.04
     steps:
-    - name: Checkout main
-      uses: actions/checkout@v2
-      with:
-        path: main
-        ref: main
-        fetch-depth: '0'
-    - run: |
-        cd main
-        ./build_site.sh ../_site/stable
-    - name: Checkout dev
-      uses: actions/checkout@v2
-      with:
-        path: dev
-        # change this ref to whatever dev branch/tag we need when necessary
-        ref: main
-        fetch-depth: '0'
-    - run: |
-        cd dev
-        ../main/build_site.sh ../_site/develop
-    - uses: actions/upload-pages-artifact@v2
-    
+      - name: Checkout main
+        uses: actions/checkout@v2
+        with:
+          path: main
+          ref: main
+          fetch-depth: "0"
+      - run: |
+          cd main
+          ./build_site.sh ../_site/stable
+      - name: Checkout dev
+        uses: actions/checkout@v2
+        with:
+          path: dev
+          # change this ref to whatever dev branch/tag we need when necessary
+          ref: main
+          fetch-depth: "0"
+      - run: |
+          cd dev
+          ../main/build_site.sh ../_site/develop
+      - uses: actions/upload-pages-artifact@v2
+
   deploy:
     environment:
       name: github-pages
@@ -48,4 +48,3 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
-    

Diff for: .gitignore

@@ -1 +1,2 @@
-/_site
+/_site
+node_modules

Diff for: .prettierignore

@@ -0,0 +1,11 @@
+*.md
+
+# dependencies
+node_modules
+package-lock.json
+
+# production
+dist
+
+# workflows
+.github