Initial refactor (#2)

* Set author/codeowner

* Switch references to julia-version

* Add a description

* Package is public

* Rename .yml to .yaml

* Rename yamllint config file to use a default name

* Drop trailing slash from job names

* Update YAML linting rules

* Use double-quotes

* Add note on GHA syntax

* Disable commitlint

* Rename workflow to CI

* Rename markdownlint config file

* Custom config file names and LINTER_RULES_PATH incompatible

super-linter/super-linter#3477

* Skip markdown

* Set log level to DEBUG

* Make an .env

* Update dependencies

* Run most PR workflows independent of base branch

* Silence dotenv-linter

* Require markdown lists to be ordered

* Use trailing comma ES5

Author: omus

.env.example renamed to .env

@@ -1,11 +1,11 @@
-# dotenv-linter:off IncorrectDelimiter
+# dotenv-linter:off QuoteCharacter
 
 # Do not commit your actual .env file to Git! This may contain secrets or other
 # private information.
 
 # Enable/disable step debug logging (default: `false`). For local debugging, it
 # may be useful to set it to `true`.
-ACTIONS_STEP_DEBUG=true
+ACTIONS_STEP_DEBUG="true"
 
 # GitHub Actions inputs should follow `INPUT_<name>` format (case-sensitive).
 # Hyphens should not be converted to underscores!

.github/dependabot.yml renamed to .github/dependabot.yaml

@@ -1,3 +1,4 @@
+---
 version: 2
 updates:
   - package-ecosystem: github-actions
@@ -15,9 +16,9 @@ updates:
     schedule:
       interval: weekly
     ignore:
-      - dependency-name: '@types/node'
+      - dependency-name: "@types/node"
         update-types:
-          - 'version-update:semver-major'
+          - version-update:semver-major
     groups:
       npm-development:
         dependency-type: development

.github/workflows/check-dist.yml renamed to .github/workflows/check-dist.yaml

@@ -7,6 +7,7 @@
 # If this workflow is run from a feature branch, it will act as an additional CI
 # check and fail if the checked-in `dist/` directory does not match what is
 # expected from the build.
+---
 name: Check Transpiled JavaScript
 
 on:
@@ -22,7 +23,7 @@ permissions:
 
 jobs:
   check-dist:
-    name: Check dist/
+    name: Check dist
     runs-on: ubuntu-latest
 
     steps:
@@ -41,7 +42,7 @@ jobs:
         id: install
         run: npm ci
 
-      - name: Build dist/ Directory
+      - name: Build dist Directory
         id: build
         run: npm run bundle
 

.github/workflows/ci.yml renamed to .github/workflows/ci.yaml

@@ -1,9 +1,8 @@
-name: Continuous Integration
+---
+name: CI
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request: {}
   push:
     branches:
       - main

.github/workflows/codeql-analysis.yml renamed to .github/workflows/codeql-analysis.yaml

@@ -1,14 +1,13 @@
+---
 name: CodeQL
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request: {}
   push:
     branches:
       - main
   schedule:
-    - cron: '31 7 * * 3'
+    - cron: 31 7 * * 3
 
 permissions:
   actions: read

.github/workflows/licensed.yml renamed to .github/workflows/licensed.yaml

@@ -1,7 +1,7 @@
 # This workflow checks the statuses of cached dependencies used in this action
 # with the help of the Licensed tool. If any licenses are invalid or missing,
 # this workflow will fail. See: https://github.com/licensee/licensed
-
+---
 name: Licensed
 
 on:

.github/workflows/linter.yml renamed to .github/workflows/linter.yaml

@@ -1,9 +1,8 @@
+---
 name: Lint Codebase
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request: {}
   push:
     branches:
       - main
@@ -43,11 +42,15 @@ jobs:
           DEFAULT_BRANCH: main
           FILTER_REGEX_EXCLUDE: dist/**/*
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          LINTER_RULES_PATH: ${{ github.workspace }}
+          LINTER_RULES_PATH: .
+          # LOG_LEVEL: DEBUG  # Useful when configuration files cannot be found
+          MARKDOWN_CONFIG_FILE: .markdownlint.yaml
           VALIDATE_ALL_CODEBASE: true
+          VALIDATE_GIT_COMMITLINT: false
           VALIDATE_JAVASCRIPT_ES: false
           VALIDATE_JAVASCRIPT_STANDARD: false
           VALIDATE_JSCPD: false
           VALIDATE_TYPESCRIPT_ES: false
           VALIDATE_JSON: false
           VALIDATE_TYPESCRIPT_STANDARD: false
+          YAML_CONFIG_FILE: .yamllint.yaml

.licensed.yml renamed to .licensed.yaml

@@ -1,5 +1,5 @@
 # See: https://github.com/licensee/licensed/blob/main/docs/configuration.md
-
+---
 sources:
   npm: true
 
@@ -15,4 +15,4 @@ allowed:
 ignored:
   npm:
     # Used by Rollup.js when building in GitHub Actions
-    - '@rollup/rollup-linux-x64-gnu'
+    - "@rollup/rollup-linux-x64-gnu"

.markdown-lint.yml renamed to .markdownlint.yaml

@@ -1,5 +1,6 @@
 # See: https://github.com/DavidAnson/markdownlint
-
+# For details on rules see: https://github.com/updownpress/markdown-lint/tree/master/rules
+---
 # Unordered list style
 MD004:
   style: dash
@@ -10,7 +11,7 @@ MD013:
 
 # Ordered list item prefix
 MD029:
-  style: one
+  style: ordered
 
 # Spaces after list markers
 MD030:

.prettierrc.yml renamed to .prettierrc.yaml

@@ -1,13 +1,13 @@
 # See: https://prettier.io/docs/en/configuration
-
+---
 printWidth: 80
 tabWidth: 2
 useTabs: false
 semi: false
-singleQuote: true
+singleQuote: false
 quoteProps: as-needed
 jsxSingleQuote: false
-trailingComma: none
+trailingComma: es5
 bracketSpacing: true
 bracketSameLine: true
 arrowParens: always