Add linter (#344)

* Add linter * linter fixes * final fix
adoptium · Sep 18, 2023 · ec2e03d · ec2e03d
1 parent d7ea326
commit ec2e03d
Show file tree

Hide file tree

Showing 24 changed files with 776 additions and 945 deletions.
diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
@@ -0,0 +1,24 @@
+###########################
+###########################
+## Markdown Linter rules ##
+###########################
+###########################
+
+# Linter rules doc:
+# - https://github.com/DavidAnson/markdownlint
+#
+# Note:
+# To comment out a single error:
+#   <!-- markdownlint-disable -->
+#   any violations you want
+#   <!-- markdownlint-restore -->
+#
+
+###############
+# Rules by id #
+###############
+MD013: false # Line length is usually not important and the 80 char limit is way too small anyway
+MD026: false # Trailing punctuation in header
+MD033: false # Inline HTML is important for multilines and checkboxes within markdown tables
+MD034: false # no-bare-urls Bare URL used
+MD029: false # Markdown automatically calculates the ordered list order
diff --git a/.github/linters/.stylelintrc.json b/.github/linters/.stylelintrc.json
@@ -0,0 +1,12 @@
+{
+    "extends": ["stylelint-config-standard-scss"],
+    "rules": {
+        "keyframes-name-pattern": null,
+        "at-rule-no-unknown": null,
+        "declaration-empty-line-before": null,
+        "number-leading-zero": null,
+        "color-function-notation": null,
+        "no-descending-specificity": null,
+        "selector-class-pattern": null
+    }
+}
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -0,0 +1,33 @@
+name: Linter
+
+on:
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  linter:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+    permissions:
+      statuses: write  # for github/super-linter/slim to mark status of each linter run
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Lint Code Base
+        uses: github/super-linter/slim@45fc0d88288beee4701c62761281edfee85655d7 # v5.0.0
+
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # Markdown lint complains about the issue templates
+          FILTER_REGEX_EXCLUDE: .github/ISSUE_TEMPLATE/*
+          VALIDATE_YAML: false
diff --git a/404.html b/404.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ Thanks for your interest in this project.
 
 ## Project description
 
-blog.adoptium.net is a project to regroup assets for the Eclipse Foundation look and feel. 
+blog.adoptium.net is a project to regroup assets for the Eclipse Foundation look and feel.
 
 * https://github.com/adoptium/dash.adoptium.net
 
@@ -32,4 +32,4 @@ https://www.eclipse.org/projects/handbook/#resources-commit
 
 ## Contact
 
-Contact the Eclipse Foundation Webdev team via [email protected].
+Contact the Eclipse Foundation Webdev team via [email protected].
diff --git a/README.md b/README.md
@@ -7,7 +7,8 @@ The next gen download dashboard
 ## Local run/development steps
 
 - start DownloadStats
-```
+
+```bash
 npm install
 npm start
 ```
@@ -17,9 +18,9 @@ npm start
 ## Deployment
 
 - Compile and generate static files
-```
+
+```bash
 npm run-script build
 ```
 
 - serve ./dist
-
diff --git a/index.html b/index.html
@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="UTF-8">