feat: modernized the boilerplate

.github/actions/init-npm/action.yaml

@@ -0,0 +1,21 @@
+name: init-npm
+description: 'Initialize the repo with npm and install all the dependencies'
+inputs: 
+  node-version:
+    description: 'Node.js version'
+    required: true
+    default: '20.x'
+runs:
+  using: composite
+  steps:
+  - name: Set up Node.js
+    uses: actions/setup-node@v4
+    with:
+      node-version: ${{ inputs.node-version }}
+      cache: npm
+  - name: Install TS Project dependencies
+    shell: bash
+    run: npm ci
+  - name: build
+    shell: bash
+    run: npm run build

.github/dependabot.yaml

@@ -0,0 +1,53 @@
+# yaml-language-server: $schema=https://json.schemastore.org/dependabot-2.0.json
+version: 2
+updates:
+  # deps
+  - package-ecosystem: npm
+    target-branch: 'master'
+    schedule:
+      interval: weekly
+    allow:
+      - dependency-type: production
+    directory: /
+    commit-message:
+      prefix: 'deps'
+    groups:
+      map-colonies:
+        patterns:
+          - '@map-colonies/*'
+      opentelemetry:
+        patterns:
+          - '@opentelemetry/*'
+      patch:
+        update-types:
+          - patch
+  # dev-deps
+  - package-ecosystem: npm
+    schedule:
+      interval: weekly
+    allow:
+      - dependency-type: development
+    directory: /
+    commit-message:
+      prefix: 'deps'
+    groups:
+      map-colonies:
+        patterns:
+          - '@map-colonies/*'
+      opentelemetry:
+        patterns:
+          - '@opentelemetry/*'
+      types:
+        patterns:
+          - '@types/*'
+      dev-patch:
+        update-types:
+          - patch
+
+  # github deps
+  - package-ecosystem: github-actions
+    schedule:
+      interval: weekly
+    commit-message:
+      prefix: 'ci'
+    directory: '/'

.github/workflows/publish.yaml

@@ -0,0 +1,22 @@
+name: publish
+
+on:
+  workflow_dispatch:
+  release: 
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write # allow GITHUB_TOKEN to publish packages
+    steps:
+      - uses: actions/checkout@v4
+      - name: Init nodejs
+        uses: ./.github/actions/init-npm
+        with:
+          node-version: 20.x
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.github/workflows/pull-request.yaml

@@ -0,0 +1,53 @@
+name: pull_request
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  eslint:
+    name: Run TS Project eslint
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: [20.x, 22.x]
+
+    steps:
+      - name: Check out TS Project Git repository
+        uses: actions/checkout@v4
+
+      - name: Init nodejs
+        uses: ./.github/actions/init-npm
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Run TS Project linters
+        uses: wearerequired/lint-action@v2
+        with:
+          github_token: ${{ secrets.github_token }}
+          # Enable linters
+          eslint: true
+          prettier: true
+          eslint_extensions: ts
+
+  tests:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: [20.x, 22.x]
+
+    steps:
+      - name: Check out TS Project Git repository
+        uses: actions/checkout@v4
+
+      - name: Init nodejs
+        uses: ./.github/actions/init-npm
+
+      - name: Run tests
+        run: npm run test
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Test Reporters ${{ matrix.node }}
+          path: ./reports/**

.github/workflows/release-please.yaml

@@ -0,0 +1,24 @@
+name: release-please
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          # this assumes that you have created a personal access token
+          # (PAT) and configured it as a GitHub action secret named
+          # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
+          token: ${{ secrets.GH_PAT }}
+          # this is a built-in strategy in release-please, see "Action Inputs"
+          # for more options
+          release-type: node

.github/workflows/typedoc.yaml

@@ -0,0 +1,52 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy typedoc to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - name: Install TS Project dependencies
+        run: npm ci
+      - name: build docs
+        run: npx typedoc
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload docs directory
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -25,6 +25,8 @@ coverage
 # nyc test coverage
 .nyc_output
 
+docs
+
 # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1 @@
+npx pretty-quick --staged

.nvmrc

@@ -1 +1 @@
-v16
+v20

.prettierignore

@@ -1,13 +1,8 @@
 dist
 .github
-.gitignore
 CHANGELOG.md
-commitlint.config.js
 package-lock.json
-package.json
 README.md
-tsbuildconfig.json
-tsconfig.json
 coverage
 reports
 docs