Merge branch 'main' into ci/push-spec-earl-reports

.github/workflows/ci.yml

@@ -5,6 +5,9 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  DEFAULT_NODE_VERSION: 22.x
+
 jobs:
   tooling:
     strategy:
@@ -21,6 +24,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: yarn
       - run: yarn install --immutable
       - run: yarn lint
       - run: yarn depcheck
@@ -44,6 +48,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: yarn
       - run: yarn install --immutable
       - run: yarn build
       - run: yarn test
@@ -68,6 +73,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
+          cache: yarn
       - run: yarn install --immutable
       - run: yarn build
       - name: Load RDF test suite cache
@@ -86,3 +92,44 @@ jobs:
         with:
           name: earl report
           path: engines/*/spec/earl-*.ttl
+
+  documentation:
+    name: Prepare documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Ensure line endings are consistent
+        run: git config --global core.autocrlf input
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.DEFAULT_NODE_VERSION }}
+          cache: yarn
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build documentation
+        run: yarn run doc
+      - name: Prepare artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: documentation
+          name: documentation
+
+  documentation-publish:
+    name: Publish documentation
+    needs:
+      - documentation
+    runs-on: ubuntu-latest
+    # The documentation is only published for main branch
+    if: startsWith(github.ref, 'refs/heads/main')
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: documentation

.gitignore

@@ -5,6 +5,7 @@ out
 .yarn
 .rdf-test-suite-cache
 .eslintcache
+documentation
 
 engines/*/lib/**/*.cjs
 engines/*/lib/**/*.js

eslint.config.js

@@ -81,4 +81,9 @@ export default config([
       'ts/no-var-requires': 'off',
     },
   },
+  {
+    ignores: [
+      'documentation',
+    ],
+  },
 ], { disableJest: true });

package.json

@@ -16,6 +16,7 @@
     "build:transpile-spec": "lerna run build:transpile-spec",
     "clean": "git clean -dfx",
     "depcheck": "lerna exec --concurrency 1 -- depcheck --ignores=\"vitest\"",
+    "doc": "typedoc",
     "lint": "eslint . --cache",
     "postinstall": "yarn husky && yarn run build",
     "publish": "yarn run build",
@@ -27,16 +28,17 @@
   "devDependencies": {
     "@rdfjs/types": "^2.0.0",
     "@rubensworks/eslint-config": "^3.1.0",
-    "@vitest/coverage-v8": "2.1.8",
+    "@vitest/coverage-v8": "3.0.5",
     "depcheck": "^1.4.7",
     "esbuild": "^0.24.0",
     "eslint": "^8.57.0",
     "husky": "^9.1.7",
     "lerna": "8.1.4",
     "manual-git-changelog": "^1.0.2",
     "rdf-test-suite": "^2.0.0",
+    "typedoc": "^0.27.6",
     "typescript": "^5.7.3",
     "vite": "^6.0.11",
-    "vitest": "^3.0.4"
+    "vitest": "^3.0.5"
   }
 }

packages/test-utils/package.json

@@ -41,7 +41,7 @@
   "dependencies": {
     "@traqula/core": "^0.0.0",
     "rdf-data-factory": "^2.0.1",
-    "vitest": "^3.0.3"
+    "vitest": "*"
   },
   "devDependencies": {
     "@rdfjs/types": "^2.0.0"

renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>rubensworks/renovate-presets:js"
+  ]
+}

typedoc.json

@@ -0,0 +1,7 @@
+{
+  "name": "TRAQULA",
+  "out": "documentation",
+  "theme": "default",
+  "entryPointStrategy": "packages",
+  "entryPoints": ["engines/*", "packages/*"]
+}