feat: Add npm tests and update github ci

Author: manid2

.eslintrc.yml

@@ -0,0 +1,52 @@
+env:
+  browser: true
+  es2021: true
+
+extends:
+  - standard
+  - prettier
+
+parserOptions:
+  ecmaVersion: latest
+
+rules:
+  # best practices
+  arrow-parens:
+    - 2
+    - as-needed
+  semi:
+    - 2
+    - always
+  class-methods-use-this: 0
+  comma-dangle:
+    - 2
+    - always-multiline
+  no-console:
+    - 2
+  no-unused-expressions: 0
+  no-param-reassign:
+    - 2
+    - props: false
+  no-useless-escape: 0
+  func-names: 0
+  quotes:
+    - 2
+    - double
+    - allowTemplateLiterals: true
+  no-underscore-dangle: 0
+  object-curly-newline: 0
+  function-paren-newline: 0
+  operator-linebreak:
+    - 2
+    - after
+  no-unused-vars:
+    - 2
+    - argsIgnorePattern: "^_"
+
+globals:
+  document: true
+  requestAnimationFrame: true
+  window: true
+  self: true
+  fetch: true
+  Headers: true

.github/workflows/hugo.yaml

@@ -26,7 +26,21 @@ defaults:
     shell: bash
 
 jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Install test dependencies
+        run: |
+          sudo apt-get update && \
+          sudo apt-get -y install npm tzdata && \
+          npm ci
+
+      - name: Run tests
+        run: |
+          npm run test
+
   build:
+    needs: test
     runs-on: ubuntu-22.04
     env:
       HUGO_VERSION: 0.115.2
@@ -53,6 +67,7 @@ jobs:
           HUGO_ENVIRONMENT: production
           HUGO_ENV: production
         run: |
+          source ./exampleSite/scripts/hugo-env && \
           hugo --source exampleSite
 
       - name: Upload artifact

.linkinator.config.json

@@ -0,0 +1,6 @@
+{
+  "silent": true,
+  "timeout": 10000,
+  "retryErrors": false,
+  "skip": ["^(?!http://localhost)"]
+}

.markdownlint.json

@@ -0,0 +1,57 @@
+{
+  "default": true,
+  "heading-style": {
+    "style": "setext_with_atx"
+  },
+  "hr-style": {
+    "style": "---"
+  },
+  "code-block-style": {
+    "style": "fenced"
+  },
+  "code-fence-style": {
+    "style": "backtick"
+  },
+  "no-hard-tabs": {
+    "code_blocks": false
+  },
+  "fenced-code-language": {
+    "allowed_languages": [
+      "bash",
+      "c",
+      "cpp",
+      "css",
+      "html",
+      "js",
+      "json",
+      "lua",
+      "md",
+      "py",
+      "scss",
+      "sh",
+      "text",
+      "toml",
+      "vim",
+      "xml",
+      "yml",
+      "zsh"
+    ],
+    "language_only": true
+  },
+  "emphasis-style": {
+    "style": "underscore"
+  },
+  "strong-style": {
+    "style": "underscore"
+  },
+  "ul-style": {
+    "style": "sublist"
+  },
+  "line-length": {
+    "line_length": 78,
+    "heading_line_length": 72,
+    "code_block_line_length": 78,
+    "tables": false,
+    "strict": true
+  }
+}

.prettier.json

@@ -0,0 +1,14 @@
+{
+  "printWidth": 78,
+  "trailingComma": "all",
+  "arrowParens": "avoid",
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "printWidth": 180,
+        "parser": "go-template"
+      }
+    }
+  ]
+}

.prettierignore

@@ -0,0 +1,2 @@
+# ignore this file as there is an issue with prettier go-template formatter
+render-heading.html

.stylelintrc.json

@@ -0,0 +1,19 @@
+{
+  "extends": "stylelint-config-standard-scss",
+  "quiet": true,
+  "rules": {
+    "declaration-empty-line-before": [
+      "always",
+      {
+        "ignore": [
+          "after-comment",
+          "after-declaration",
+          "first-nested",
+          "inside-single-line-block"
+        ]
+      }
+    ],
+    "scss/no-global-function-names": null,
+    "scss/dollar-variable-pattern": "^([a-z][a-z0-9]*)(-[a-z0-9]+)*(--[a-z0-9]+)?"
+  }
+}

exampleSite/content/slides/hugo-xterm-slides.md

@@ -18,5 +18,5 @@ Features
 * Slides using [reveal.js][1].
 * Designed for blog and personal websites for professionals.
 * Support for online CV and documentation.
- 
+
 [1]: https://revealjs.com/

exampleSite/scripts/hugo-env

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+HUGOxPARAMSxGITxLAST_COMMITxHASH=$(git log -1 --format=%H)
+HUGOxPARAMSxGITxLAST_COMMITxSHORT_HASH=$(git log -1 --format=%h)
+HUGOxPARAMSxGITxLAST_COMMITxSUBJECT=$(git log -1 --format=%s)
+
+export HUGOxPARAMSxGITxLAST_COMMITxHASH
+export HUGOxPARAMSxGITxLAST_COMMITxSHORT_HASH
+export HUGOxPARAMSxGITxLAST_COMMITxSUBJECT
+
+export TZ='Asia/Kolkata'