Merge pull request #25 from drgrice1/code-formatting

Add a workflow to check code formatting.

Author: drdrew42

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4
+
+[*.{yml,md}]
+indent_style = space
+indent_size = 2
+
+[*.pg]
+trim_trailing_whitespace = false

.github/workflows/check-formats.yml

@@ -0,0 +1,44 @@
+---
+name: Check Formatting of Code Base
+
+defaults:
+  run:
+    shell: bash
+
+on:
+  push:
+    branches-ignore: [main, develop]
+  pull_request:
+
+jobs:
+  perltidy:
+    name: Check Perl file formatting with perltidy
+    runs-on: ubuntu-24.04
+    container:
+      image: perl:5.38
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install dependencies
+        run: cpanm -n Perl::Tidy@20240903
+      - name: Run perltidy
+        shell: bash
+        run: |
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
+          shopt -s extglob globstar nullglob
+          perltidy --pro=./.perltidyrc -b -bext='/' ./**/*.p[lm] ./**/*.t && git diff --exit-code
+
+  prettier:
+    name: Check JavaScript, style, and HTML file formatting with prettier
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+      - name: Install Dependencies
+        run: cd public && npm ci --ignore-scripts
+      - name: Check formatting with prettier
+        run: cd public && npm run prettier-check

.github/workflows/createContainer.yml

@@ -3,26 +3,26 @@ name: Github Packages Release
 on:
   push:
     branches:
-    - main
-    - development
+      - main
+      - development
     tags:
-    - v*
+      - v*
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it        
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
         with:
           submodules: recursive
-      
+
       - name: Extract branch/tag name
         shell: bash
         run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF##*/})"
         id: extract_branch
-      
+
       # make sure you have "Improved Container Support" enabled for both your personal and/or Organization accounts!
       - uses: pmorelli92/[email protected]
         name: Build and Publish latest service image

.gitignore

@@ -1,12 +1,8 @@
 *.DS_Store
 render_app.conf
 lib/.pls-tmp-*
-lib/WeBWorK/htdocs/tmp/renderer/gif/*
-lib/WeBWorK/htdocs/tmp/renderer/images/*
-lib/WeBWorK/htdocs/DATA/*.json
-lib/WeBWorK/bin/*
-webwork-open-problem-library/
-private/
+webwork-open-problem-library
+private
 tmp/*
 !tmp/.gitkeep
 logs/*

.perltidyrc

@@ -0,0 +1,22 @@
+# PBP .perltidyrc file
+-l=120  # Max line width is 120 cols
+-et=4   # Use tabs instead of spaces.
+-i=4    # Indent level is 4 cols
+-ci=4   # Continuation indent is 4 cols
+-b      # Write the file inline and create a .bak file
+-vt=0   # Minimal vertical tightness
+-cti=0  # No extra indentation for closing brackets
+-pt=2   # Maximum parenthesis tightness
+-bt=1   # Medium brace tightness
+-sbt=1  # Medium square bracket tightness
+-bbt=1  # Medium block brace tightness
+-nsfs   # No space before semicolons
+-nolq   # Don't outdent long quoted strings
+-mbl=1  # Do not allow multiple empty lines
+-ce     # Cuddled else
+-cb     # Cuddled blocks
+-nbbc   # Do not add blank lines before full length comments
+-nbot   # No line break on ternary
+-nlop   # No logical padding (this causes mixed tabs and spaces)
+-wn     # Weld nested containers
+-xci    # Extended continuation indentation

.prettierrc

@@ -0,0 +1,8 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"printWidth": 120,
+	"semi": true,
+	"singleQuote": true,
+	"trailingComma": "none"
+}