ci: setup lint job

Author: gildesmarais

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: bundler
-    directory: "/"
+    directory: '/'
     schedule:
       interval: weekly
     open-pull-requests-limit: 10
@@ -11,14 +11,14 @@ updates:
     groups:
       ruby:
         patterns:
-          - "*"
-  - package-ecosystem: "npm"
-    directory: "/"
+          - '*'
+  - package-ecosystem: 'npm'
+    directory: '/'
     schedule:
       interval: weekly
     allow:
       - dependency-type: direct
     groups:
       npm:
         patterns:
-          - "*"
+          - '*'

.github/workflows/gh-pages.yml

@@ -51,5 +51,5 @@ jobs:
           publish_dir: ./_site
           publish_branch: master
           force_orphan: true
-          user_name: "github-actions[bot]"
-          user_email: "github-actions[bot]@users.noreply.github.com"
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run linters
+        run: yarn lint

.prettierignore

@@ -0,0 +1,3 @@
+_site
+node_modules
+yarn.lock

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

.stylelintrc.json

@@ -5,28 +5,8 @@
     "stylelint-config-recess-order"
   ],
   "rules": {
-    "function-comma-space-after": "always",
     "no-descending-specificity": null,
     "declaration-block-single-line-max-declarations": 1,
-    "unit-whitelist": [
-      "%",
-      "ch",
-      "deg",
-      "em",
-      "fr",
-      "ms",
-      "px",
-      "rem",
-      "s",
-      "turn",
-      "vh",
-      "vw"
-    ],
-    "max-empty-lines": 1,
-    "max-line-length": 110,
-    "no-empty-first-line": true,
-    "indentation": 2,
-    "number-leading-zero": "always",
     "media-feature-name-no-unknown": [
       true,
       {

Makefile

@@ -1,13 +1,22 @@
-default: setup clean fix serve
+default: setup clean lintfix serve
 
 setup:
 	yarn check || yarn
 	bundle check || bundle
 	make update
 
-fix:
-	prettier --write --no-semi "**/*.yml" "**/*.md" "**/*.scss" "assets/**/*.js"
-	yarn run stylelint --fix "assets/**/*.scss" || echo 'stylelint: found no scss files to lint'
+lint:
+	yarn lint
+	make lint-ruby
+
+lintfix:
+	yarn lintfix
+	make lintfix-ruby
+
+lint-ruby:
+	bundle exec rubocop
+
+lintfix-ruby:
 	bundle exec rubocop -a
 
 clean:

package.json

@@ -2,11 +2,18 @@
   "license": "UNLICENSED",
   "private": true,
   "scripts": {
-    "lintfix": "stylelint --fix assets/**/*.scss"
+    "lint": "yarn lint:stylelint && yarn lint:prettier",
+    "lint:stylelint": "stylelint assets/**/*.scss",
+    "lint:prettier": "prettier --check .",
+    "lintfix": "yarn lintfix:stylelint && yarn lintfix:prettier",
+    "lintfix:stylelint": "stylelint --fix assets/**/*.scss",
+    "lintfix:prettier": "prettier --write ."
   },
   "devDependencies": {
+    "prettier": "3.3.3",
     "stylelint": "16.22.0",
     "stylelint-config-recess-order": "7.1.0",
+    "stylelint-order": "6.0.4",
     "stylelint-config-recommended-scss": "15.0.1",
     "stylelint-scss": "6.12.1"
   },

yarn.lock

@@ -613,12 +613,17 @@ postcss-selector-parser@^7.1.0:
     cssesc "^3.0.0"
     util-deprecate "^1.0.2"
 
+postcss-sorting@^8.0.2:
+  version "8.0.2"
+  resolved "https://registry.yarnpkg.com/postcss-sorting/-/postcss-sorting-8.0.2.tgz#6393385ece272baf74bee9820fb1b58098e4eeca"
+  integrity sha512-M9dkSrmU00t/jK7rF6BZSZauA5MAaBW4i5EnJXspMwt4iqTh/L9j6fgMnbElEOfyRyfLfVbIHj/R52zHzAPe1Q==
+
 postcss-value-parser@^4.2.0:
   version "4.2.0"
   resolved "https://registry.yarnpkg.com/postcss-value-parser/-/postcss-value-parser-4.2.0.tgz#723c09920836ba6d3e5af019f92bc0971c02e514"
   integrity sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==
 
-postcss@^8.5.6:
+postcss@^8.4.32, postcss@^8.5.6:
   version "8.5.6"
   resolved "https://registry.yarnpkg.com/postcss/-/postcss-8.5.6.tgz#2825006615a619b4f62a9e7426cc120b349a8f3c"
   integrity sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==
@@ -627,6 +632,11 @@ postcss@^8.5.6:
     picocolors "^1.1.1"
     source-map-js "^1.2.1"
 
+prettier@3.3.3:
+  version "3.3.3"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105"
+  integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==
+
 punycode@^2.1.0:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec"
@@ -721,6 +731,14 @@ stylelint-config-recommended@^16.0.0:
   resolved "https://registry.yarnpkg.com/stylelint-config-recommended/-/stylelint-config-recommended-16.0.0.tgz#0221f19902816fe7d53d9a01eb0be4cc7b4fe80a"
   integrity sha512-4RSmPjQegF34wNcK1e1O3Uz91HN8P1aFdFzio90wNK9mjgAI19u5vsU868cVZboKzCaa5XbpvtTzAAGQAxpcXA==
 
+stylelint-order@6.0.4:
+  version "6.0.4"
+  resolved "https://registry.yarnpkg.com/stylelint-order/-/stylelint-order-6.0.4.tgz#3e80d876c61a98d2640de181433686f24284748b"
+  integrity sha512-0UuKo4+s1hgQ/uAxlYU4h0o0HS4NiQDud0NAUNI0aa8FJdmYHA5ZZTFHiV5FpmE3071e9pZx5j0QpVJW5zOCUA==
+  dependencies:
+    postcss "^8.4.32"
+    postcss-sorting "^8.0.2"
+
 stylelint-scss@6.12.1, stylelint-scss@^6.12.0:
   version "6.12.1"
   resolved "https://registry.yarnpkg.com/stylelint-scss/-/stylelint-scss-6.12.1.tgz#7de9980a7c9acb7a3f203498e7296526cb52ffa0"