feat: add npm package provenance

Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/build.yml

@@ -10,16 +10,18 @@ jobs:
   build:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.1.0'
+        uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
+
+      - run: 'npm run build:typescript'

.github/workflows/lint.yml

@@ -10,19 +10,19 @@ jobs:
   lint:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.1.0'
+        uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
       - run: 'npm run lint:editorconfig'
       - run: 'npm run lint:markdown'
-      - run: 'npm run lint:typescript'
+      - run: 'npm run lint:eslint'
       - run: 'npm run lint:prettier'

.github/workflows/release.yml

@@ -7,24 +7,34 @@ on:
 jobs:
   release:
     runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+      issues: 'write'
+      pull-requests: 'write'
+      id-token: 'write'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.2'
         with:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.1.0'
+        uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'
 
+      - run: 'npm run build:typescript'
+
+      - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
+        run: 'npm audit signatures'
+
       - name: 'Release'
         run: 'npm run release'
         env:

.github/workflows/test.yml

@@ -10,16 +10,16 @@ jobs:
   test:
     runs-on: 'ubuntu-latest'
     steps:
-      - uses: 'actions/checkout@v3.0.0'
+      - uses: 'actions/checkout@v3.5.2'
 
-      - name: 'Use Node.js'
+      - name: 'Setup Node.js'
-        uses: 'actions/setup-node@v3.1.0'
+        uses: 'actions/setup-node@v3.6.0'
         with:
           node-version: 'lts/*'
           cache: 'npm'
 
-      - name: 'Install'
+      - name: 'Install dependencies'
-        run: 'npm install'
+        run: 'npm clean-install'
 
       - name: 'Build'
         run: 'npm run build'

.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:staged
-npm run build

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "relative-links": true,
+    "default": true,
+    "MD033": false
+  },
+  "globs": ["**/*.{md,mdx}"],
+  "ignores": ["**/node_modules"],
+  "customRules": ["markdownlint-rule-relative-links"]
+}

.markdownlint.json

@@ -1,6 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD033": false,
-  "MD041": false
-}

.npmrc

@@ -1 +1,2 @@
 save-exact=true
+provenance=true

.vscode/extensions.json

@@ -3,7 +3,6 @@
     "editorconfig.editorconfig",
     "esbenp.prettier-vscode",
     "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint",
+    "davidanson.vscode-markdownlint"
-    "ms-azuretools.vscode-docker"
   ]
 }

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@divlo.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -2,6 +2,14 @@
 
 Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
 
+## Code of Conduct
+
+**html-w3c-validator** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on **html-w3c-validator** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
+
 ## Types of contributions
 
 - Reporting a bug.
@@ -21,26 +29,4 @@ If you're adding new features to **html-w3c-validator**, please include tests.
 
 ## Commits
 
-The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.

example/package.json

@@ -6,8 +6,8 @@
     "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
   },
   "devDependencies": {
-    "serve": "14.0.1",
+    "serve": "14.2.0",
-    "start-server-and-test": "1.14.0",
+    "start-server-and-test": "2.0.0",
     "html-w3c-validator": "file:.."
   }
 }

package.json

@@ -22,65 +22,67 @@
   ],
   "main": "build/index.js",
   "bin": "build/index.js",
-  "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=8.0.0"
-  },
   "files": [
     "build"
   ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=9.0.0"
+  },
   "scripts": {
-    "build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
+    "build": "rimraf ./build && swc ./src --out-dir ./build",
+    "build:typescript": "tsc",
     "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
+    "lint:markdown": "markdownlint-cli2",
-    "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
+    "lint:eslint": "eslint \".\" --ignore-path \".gitignore\"",
     "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
     "lint:staged": "lint-staged",
     "test": "tap",
-    "release": "semantic-release",
+    "release": "semantic-release"
-    "postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
   },
   "dependencies": {
-    "chalk": "5.1.2",
+    "chalk": "5.2.0",
-    "clipanion": "3.1.0",
+    "clipanion": "3.2.0",
     "html-validator": "6.0.1",
     "log-symbols": "5.1.0",
-    "ora": "6.1.2",
+    "ora": "6.3.0",
-    "read-pkg": "7.1.0",
+    "read-pkg": "8.0.0",
-    "table": "6.8.0"
+    "table": "6.8.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.1.2",
+    "@commitlint/cli": "17.6.3",
-    "@commitlint/config-conventional": "17.1.0",
+    "@commitlint/config-conventional": "17.6.3",
-    "@swc/cli": "0.1.57",
+    "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.9",
+    "@swc/core": "1.3.57",
+    "@tsconfig/strictest": "2.0.1",
     "@types/html-validator": "5.0.3",
     "@types/mock-fs": "4.13.1",
-    "@types/node": "18.11.3",
+    "@types/node": "20.1.3",
-    "@types/tap": "15.0.7",
+    "@types/tap": "15.0.8",
-    "@typescript-eslint/eslint-plugin": "5.40.1",
+    "@typescript-eslint/eslint-plugin": "5.59.5",
-    "editorconfig-checker": "4.0.2",
+    "editorconfig-checker": "5.0.1",
-    "eslint": "8.25.0",
+    "eslint": "8.40.0",
-    "eslint-config-conventions": "5.0.0",
+    "eslint-config-conventions": "9.0.0",
-    "eslint-config-prettier": "8.5.0",
+    "eslint-config-prettier": "8.8.0",
-    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "44.0.2",
+    "eslint-plugin-unicorn": "47.0.0",
-    "execa": "6.1.0",
+    "execa": "7.1.1",
-    "husky": "8.0.1",
+    "lint-staged": "13.2.2",
-    "lint-staged": "13.0.3",
+    "markdownlint-cli2": "0.7.1",
-    "markdownlint-cli": "0.32.2",
+    "markdownlint-rule-relative-links": "1.2.0",
-    "mock-fs": "5.1.4",
+    "mock-fs": "5.2.0",
-    "pinst": "3.0.0",
+    "prettier": "2.8.8",
-    "prettier": "2.7.1",
+    "rimraf": "5.0.0",
-    "rimraf": "3.0.2",
+    "semantic-release": "21.0.2",
-    "semantic-release": "19.0.5",
+    "serve": "14.2.0",
-    "serve": "14.0.1",
+    "tap": "16.3.4",
-    "tap": "16.3.0",
+    "typescript": "5.0.4"
-    "typescript": "4.8.4"
   }
 }

src/HTMLValidatorCommand.ts

@@ -43,12 +43,12 @@ const printResults = (results: Result[]): void => {
 }
 
 export class HTMLValidatorCommand extends Command {
-  static usage = {
+  static override usage = {
     description:
       'CLI for validating multiple html pages using <https://validator.w3.org/>.'
   }
 
-  async execute(): Promise<number> {
+  public async execute(): Promise<number> {
     const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
     try {
       if (!(await isExistingPath(configPath))) {

tsconfig.json

@@ -1,4 +1,5 @@
 {
+  "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "target": "ESNext",
     "module": "ESNext",
@@ -7,8 +8,6 @@
     "outDir": "./build",
     "rootDir": "./src",
     "noEmit": true,
-    "strict": true,
+    "exactOptionalPropertyTypes": false
-    "skipLibCheck": true,
-    "esModuleInterop": true
   }
 }