Merge pull request #63 from Logius-standaarden/develop

To main
Logius-standaarden · Oct 18, 2023 · f5e47eb · f5e47eb
2 parents e5f132d + 5289c8e
commit f5e47eb
Show file tree

Hide file tree

Showing 108 changed files with 8,069 additions and 12,190 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -4,13 +4,14 @@ on:
     paths-ignore:
       - "**"
       - "!**.js"
+      - "!**.cjs"
       - "!**.json"
       - "!**.css"
       - "!**.html"
       - "!.github/workflows/**"
 
 env:
-  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
+  PUPPETEER_SKIP_DOWNLOAD: 1
   PUPPETEER_EXECUTABLE_PATH: /usr/bin/google-chrome
   # See https://github.com/w3c/respec/pull/3306
   LC_ALL: en_US.UTF-8
@@ -30,23 +31,25 @@ jobs:
           curl -sL https://api.github.com/repos/w3c/respec/pulls/${{ github.event.pull_request.number }}/files -o /tmp/pr_files.json
           cat /tmp/pr_files.json | jq -r '.[].filename' | grep -qE "^builds/" || exit 0
           echo "::error::Uh oh! builds/ was changed."; exit 1
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - run: npm ci
-      - run: npm run lint
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm lint
 
   test-headless:
     name: Headless Tests
     runs-on: ubuntu-latest
     needs: lint
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - run: npm ci
-      - run: npm run test:build
-      - run: npm run build:w3c
-      - run: npm run test:headless
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm test:build
+      - run: pnpm build:w3c
+      - run: pnpm test:headless
 
   test-karma:
     name: Karma Unit Tests (${{ matrix.browser }})
@@ -57,16 +60,15 @@ jobs:
     needs: lint
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - name: install & build
-        run: |
-          npm ci
-          npm run build:w3c & npm run build:geonovum
-      - run: npm run test:unit
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm build:w3c & pnpm build:geonovum
+      - run: pnpm test:unit
         env:
           BROWSERS: ${{ matrix.browser }}
-      - run: npm run test:integration
+      - run: pnpm test:integration
         env:
           BROWSERS: ${{ matrix.browser }}
 
@@ -76,12 +78,11 @@ jobs:
     needs: lint
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - name: install & build
-        run: |
-          npm ci
-          npm run build:w3c
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm build:w3c
       - name: run validator
         run: |
           vnu=$(node -p "require('vnu-jar')")

diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -6,13 +6,14 @@ on:
     paths-ignore:
       - "**"
       - "!**.js"
+      - "!**.cjs"
       - "!**.json"
       - "!**.css"
       - "!**.html"
       - "!.github/workflows/**"
 
 env:
-  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
+  PUPPETEER_SKIP_DOWNLOAD: 1
   PUPPETEER_EXECUTABLE_PATH: /usr/bin/google-chrome
   FORCE_COLOR: 1
   # See https://github.com/w3c/respec/pull/3306
@@ -27,13 +28,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - name: install & build
-        run: |
-          npm ci
-          npm run build:w3c
-      - run: npm run test:headless
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm build:w3c
+      - run: pnpm test:headless
       - name: Calculate size and update on server
         run: |
           timestamp=$(git show --no-patch --pretty='%cd' --date='format:%s')
@@ -53,12 +53,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - name: install & build
-        run: |
-          npm ci
-          npm run build:w3c & npm run build:geonovum
-      - run: npm test
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm build:w3c & pnpm build:geonovum
+      - run: pnpm test
         env:
           BROWSERS: ChromeHeadless
diff --git a/.github/workflows/regressions.yml b/.github/workflows/regressions.yml
@@ -2,7 +2,7 @@ name: Regressions
 on: workflow_dispatch
 
 env:
-  PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: 1
+  PUPPETEER_SKIP_DOWNLOAD: 1
   PUPPETEER_EXECUTABLE_PATH: /usr/bin/google-chrome
   FORCE_COLOR: 1
 
@@ -12,10 +12,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - run: npm ci
-      - run: npm run build:w3c
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
+      - run: pnpm build:w3c
       - uses: actions/upload-artifact@v3
         with:
           name: builds
@@ -41,9 +42,10 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
-        with: { node-version: 16, cache: npm }
-      - run: npm ci --production --ignore-scripts
+        with: { node-version: 18, cache: pnpm }
+      - run: pnpm i --frozen-lockfile
       - uses: actions/download-artifact@v3
         with:
           name: builds

diff --git a/.gitignore b/.gitignore
@@ -12,5 +12,7 @@ js/deps/builds
 !js/profile-w3c.js
 .vscode/*
 !.vscode/tasks.json
-pnpm-lock.yaml
+package-lock.json
+yarn.lock
 *.log
+test/testIndex.html
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+18
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+Changelog for versions after v32.1.10 is available in [Releases](https://github.com/w3c/respec/releases).
+
+Changelog for `v26.8.12...v32.1.9` is not available. You can view Git Commit History instead.
+
+---
+
 ## [v26.8.11](https://github.com/w3c/respec/tree/v26.8.11) (2021-06-07)
 
 [Full Changelog](https://github.com/w3c/respec/compare/v26.8.10...v26.8.11)

diff --git a/README.md b/README.md
@@ -1,15 +1,20 @@
-# ReSpec
+# ReSpec - NL Profiel
 
 ReSpec is een JavaScript library voor het publiceren van technische documenten in een [toegankelijk](https://digitaaltoegankelijk.pleio.nl/cms/view/649ed793-7f0d-4676-bb10-f66fbd8a13c6/digitale-toegankelijkheid-bij-geonovum) HTML formaat. Deze repository is een fork van [w3c/respec](https://github.com/w3c/respec).
 
-Momenteel bevat het een Geonovum profiel en daaruit afgeleid een Logius profiel. Er wordt gewerkt aan een meer configureerbaar profiel dat door meerdere Nederlandse organisaties toegepast kan worden. Iedereen is welkom om pull requests of issues in te dienen.
+Momenteel bevat het een Geonovum profiel en daaruit afgeleid een Logius profiel. Logius en Geonovum werken samen aan een meer configureerbaar profiel dat door meerdere Nederlandse organisaties toegepast kan worden. Het "NL-profiel" wordt open ontwikkeld. Iedereen is welkom om pull requests of issues in te dienen.
 
-Het "NL-profiel" wordt periodiek in sync gehouden met de W3C-bron. Het profiel onderscheidt zich onder andere door de nadruk op zowel configureerbaarheid als het gebruik van Markdown.
+Het "NL-profiel" wordt periodiek in sync gehouden met de W3C-bron. Het profiel onderscheidt zich onder andere door de nadruk op zowel configureerbaarheid als het gebruik van Markdown. 
 
 ## Toepassen
 
-Om schrijvers op weg te helpen is er een [template](https://github.com/Logius-standaarden/respec-template) beschikbaar in een aparte repository. Indien u vragen heeft over het toepassen van ReSpec kunt daar de [issues](https://github.com/Logius-standaarden/ReSpec-template/issues?q=) bezoeken. Een uitgebreide Engelstalig overzicht van de algemene functies in ReSpec leest u op [respec.org](https://respec.org/docs/).
+Om schrijvers op weg te helpen is er een [template](https://github.com/Logius-standaarden/respec-template) beschikbaar in een aparte repository. Indien u vragen heeft over het toepassen van ReSpec kunt daar de [issues](https://github.com/Logius-standaarden/ReSpec-template/issues?q=) bezoeken. Een uitgebreid Engelstalig overzicht van de algemene functies in ReSpec leest u op [respec.org](https://respec.org/docs/).
 
 ## Aanpassen
 
 Wie wil sleutelen aan ReSpec wordt aangeraden de [Developers Guide](https://github.com/Logius-standaarden/respec/wiki/Developers-Guide) te raadplegen. Vragen of opmerkingen zijn welkom in de [issues](https://github.com/Logius-standaarden/respec/issues).
+
+## Test runnen
+
+Om mogelijke changes in de html te controleren na een update run `node test/test-html-build`. Dit maakt een snapshot van een html pagina en vergelijkt hem met het origineel. Als er veranderingen zijn, geeft hij aan wat en waar.
+Voeg de `--createLog` vlag toe aan het commando om de veranderingen in een log file te printen ipv in de CMD prompt.
diff --git a/builds/respec-aom.js b/builds/respec-aom.js
diff --git a/builds/respec-aom.js.map b/builds/respec-aom.js.map
diff --git a/builds/respec-dini.js b/builds/respec-dini.js
diff --git a/builds/respec-dini.js.map b/builds/respec-dini.js.map
diff --git a/builds/respec-geonovum.js b/builds/respec-geonovum.js
diff --git a/builds/respec-geonovum.js.map b/builds/respec-geonovum.js.map
diff --git a/builds/respec-highlight.js b/builds/respec-highlight.js
diff --git a/builds/respec-w3c.js b/builds/respec-w3c.js
diff --git a/builds/respec-w3c.js.map b/builds/respec-w3c.js.map
diff --git a/examples/logius-profile/document-config.js b/examples/logius-profile/document-config.js
@@ -0,0 +1,69 @@
+/* eslint-disable no-unused-vars */
+const documentConfig = {
+  useLogo: true,
+  useLabel: true,
+  license: "cc0",
+  specType: "HR",
+  specStatus: "WV",
+  govTextCode: "AA",
+
+  // subtitle: "Hier komt een subtitle",
+  shortName: "API-Design-Rules",
+  publishVersion: "1.1.0",
+  publishDate: "2020-09-20",
+  previousPublishDate: "2018-10-07",
+  // Zie https://github.com/w3c/respec/wiki/previousMaturity. Dit moet een
+  // A YYYY-MM-DD date. When a previousPublishDate is specified, this is typically required as well in order to generate the "Previous Version"
+  previousMaturity: "DEF",
+  pubDomain: "dk",
+  pubSubDomain: "watisdk",
+  nl_markdownTableClass: "simple",
+  nl_markdownEmbedImageInFigure: true,
+
+  editors: [
+    {
+      name: "P H",
+      mailto: "api@digikoppeling",
+      company: "Logius",
+      companyURL: "https://logius.nl/standaarden",
+    },
+    {
+      name: "P H",
+      url: "https://logius.nl/standaarden",
+    },
+  ],
+  authors: [
+    {
+      name: "P H",
+      url: "https://logius.nl/standaarden",
+    },
+  ],
+  github: "https://github.com/Logius-standaarden/API-Design-Rules",
+  //   testSuiteURI: "https://github.com/Logius-standaarden/API-Design-Rules",
+  highlightVars: true,
+  // noHighlightCSS: true, // hidden config ?!
+  nl_emailcomments: "[email protected]",
+  addSectionLinks: true,
+  a11y: false,
+  maxTocLevel: 3,
+  alternateFormats: [
+    {
+      label: "html",
+      uri: "https://publicatie.centrumvoorstandaarden.nl/api/oauth/static.html",
+    },
+    {
+      label: "pdf",
+      uri: "https://publicatie.centrumvoorstandaarden.nl/api/oauth/static.pdf",
+    },
+  ],
+
+  // nl_addReleaseTagTitle: true,
+  nl_markdownSplitH1sections: false,
+  nl_github: {
+    issueBase: "https://github.com/Geonovum/KP-APIs/issues/",
+    revision: "https://github.com/Logius-standaarden/API-Design-Rules/commits/",
+    pullrequests:
+      "https://github.com/Logius-standaarden/API-Design-Rules/pulls/",
+  },
+};
+/* eslint-enable no-unused-vars */