ci(super-linter): switch to super-linter

Author: thomasleplus

.github/workflows/super-linter.yml

@@ -0,0 +1,70 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * 0"
+  workflow_dispatch:
+
+permissions: {}
+
+###############
+# Set the Job #
+###############
+jobs:
+  lint:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ############################################
+    # Grant status permission for MULTI_STATUS #
+    ############################################
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          # Full git history is needed to get a proper list of changed
+          # files within `super-linter`
+          fetch-depth: 0
+          persist-credentials: false
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: super-linter/super-linter@ffde3b2b33b745cb612d787f669ef9442b1339a6 # v8.1.0
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          LINTER_RULES_PATH: .
+          DEFAULT_BRANCH: main
+          FILTER_REGEX_EXCLUDE: "(_layouts/default\\.html)$"
+          ENFORCE_COMMITLINT_CONFIGURATION_CHECK: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/yamllint.yml

@@ -1,3 +1,5 @@
+# Bookmarklets
+
 If you don't know what bookmarklets are, I recommend this [introduction](https://www.howtogeek.com/189358/beginner-geek-how-to-use-bookmarklets-on-any-device/).
 
 If you are familiar with bookmarklets but you are not sure how to install one, you can find here [detailed instructions](https://mreidsma.github.io/bookmarklets/installing.html).

README.md

@@ -0,0 +1,19 @@
+const Configuration = {
+  /*
+   * Inherit rules from conventional commits.
+   */
+  extends: ["@commitlint/config-conventional"],
+
+  /*
+   * Any rules defined here will override rules from parent.
+   */
+  rules: {
+    "body-leading-blank": [2, "always"], // warning -> error
+    "body-max-line-length": [1, "always", 100], // error -> warning
+    "footer-leading-blank": [2, "always"], // warning -> error
+    "footer-max-length": [1, "always", 100], // error -> warning
+    "header-max-length": [1, "always", 100], // error -> warning
+  },
+};
+
+export default Configuration;

commitlint.config.js

@@ -9,7 +9,7 @@ function minify(js) {
       js
         .replace(/[\r\n\t]+/gm, " ")
         .replace(/\x20+/gm, " ")
-        .trim()
+        .trim(),
     ) +
     "%7D)()"
   );
@@ -18,28 +18,29 @@ function minify(js) {
 function normalize(s) {
   return s
     .replaceAll(
-      /[^a-zA-Z0-9\x21\$\x26\x27\(\)\*\+\x2c\x2d\.\/\x3a\x3b\x3d\?\x40_]/g,
-      "-"
+      /[^a-zA-Z0-9\x21$\x26\x27()*+\x2c\x2d./\x3a\x3b\x3d?\x40_]/g,
+      "-",
     )
     .replaceAll(/\x2d+/g, "-");
 }
 
+// eslint-disable-next-line no-unused-vars
 async function init(path) {
   document.getElementById("mininame").oninput = function () {
     document.getElementById("minified").textContent =
       document.getElementById("mininame").value;
   };
   document.getElementById("plaintext").oninput = function () {
     document.getElementById("minified").href = minify(
-      document.getElementById("plaintext").value
+      document.getElementById("plaintext").value,
     );
   };
   var content = [];
   console.debug("Fetching index");
   var index = await fetch(
     "https://raw.githubusercontent.com/" +
       path +
-      "/main/javascripts/index.json"
+      "/main/javascripts/index.json",
   )
     .then(function (response) {
       return response.json();
@@ -55,7 +56,7 @@ async function init(path) {
   ttoc.textContent = "Examples (" + index.length + ")";
   var ul = document.createElement("ul");
   toc.appendChild(ul);
-  var i;  
+  var i;
   for (i = 0; i < index.length; i++) {
     var li = document.createElement("li");
     ul.appendChild(li);
@@ -94,7 +95,7 @@ async function init(path) {
         path +
         "/main/javascripts/" +
         encodeURIComponent(index[j].name) +
-        ".js"
+        ".js",
     )
       .then(function (response) {
         return response.text();