🥭 update build setup

Author: wolfram77

.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '!*'  # Do not execute on tags
+env:
+  GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
+  CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+  FORCE_COLOR: 1
+
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macOS-latest]
+        node: [16.x, 18.x]
+    name: Test with Node ${{matrix.node}} on ${{matrix.platform}}
+    runs-on: ${{matrix.platform}}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{matrix.node}}
+      - run: npm ci
+      - run: npm test
+
+
+  coverage:
+    name: Publish coverage
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+      - run: npm ci
+      - run: npm test
+      - uses: paambaati/[email protected]
+      - uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+
+
+  docs:
+    name: Publish docs
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+      - run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
+      - run: bash "$HOME/deploy/setup.sh"
+      - run: npm i -g typescript typedoc
+      - run: npm ci
+      - run: npm run publish-docs
+
+
+  packages:
+    name: Publish packages
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 18.x
+      - run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
+      - run: bash "$HOME/deploy/setup.sh"
+      - run: npm i -g typescript rollup typedoc browserify terser
+      - run: npm ci
+      - run: npm run publish-packages

.github/workflows/deploy.yml

@@ -0,0 +1,21 @@
+name: PR
+on: [pull_request]
+env:
+  FORCE_COLOR: 1
+
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macOS-latest]
+        node: [16.x, 18.x]
+    name: Test with Node ${{ matrix.node }} on ${{ matrix.platform }}
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm ci
+      - run: npm test

.github/workflows/pr.yml

@@ -18,5 +18,6 @@ coverage/
 .coveralls.yml
 tsconfig.json
 jestconfig.json
+jest.config.js
 rollup.config.js
 build.js

.npmignore

@@ -1,6 +1,7 @@
 const build = require('extra-build');
 
 const owner  = 'nodef';
+const repo   = build.readMetadata('.').name;
 const srcts  = 'index.ts';
 const LOCATIONS = [
   'src/index.ts',
@@ -17,8 +18,8 @@ function keywords(ds) {
 }
 
 
-// Publish root package to NPM, GitHub.
-function publishRoot(ds, ver, typ) {
+// Publish a root package to NPM, GitHub.
+function publishRootPackage(ds, ver, typ) {
   var _package = build.readDocument('package.json');
   var _readme  = build.readDocument('README.md');
   var m  = build.readMetadata('.');
@@ -27,8 +28,8 @@ function publishRoot(ds, ver, typ) {
   m.keywords = keywords(ds);
   if (typ) {
     m.name = `${m.name}.${typ}`;
-    m.description.replace(/\.$/, `{${typ}}.`);
-    md.replace(/(unpkg\.com\/)(\S+?)(\/\))/, `$1$2.${typ}$3`);
+    m.description = m.description.replace(/\.$/, `{${typ}}.`);
+    md = md.replace(/(unpkg\.com\/)(\S+?)(\/\))/, `$1$2.${typ}$3`);
   }
   build.writeMetadata('.', m);
   build.writeFileText('README.md', md);
@@ -40,27 +41,49 @@ function publishRoot(ds, ver, typ) {
 }
 
 
-// Deploy root package to NPM, GitHub.
-function deployRoot(ds, ver) {
+// Transform JSDoc in .d.ts file.
+function transformJsdoc(x, dm) {
+  if (!dm.has(x.name)) return null;
+  var link = `[📘](https://github.com/${owner}/${repo}/wiki/${x.name})`;
+  x.description = x.description.trim() + '\n' + link;
+  return x;
+}
+
+
+// Bundle script for test or publish.
+function bundleScript(ds) {
+  var dm = new Map(ds.map(d => [d.name, d]));
+  build.exec(`tsc`);
+  build.bundleScript(`.build/${srcts}`);
+  build.jsdocifyScript('index.d.ts', 'index.d.ts', x => transformJsdoc(x, dm));
+}
+
+
+// Publish root packages to NPM, GitHub.
+function publishRootPackages(ds, ver) {
   var m   = build.readMetadata('.');
   var sym = build.symbolname(m.name);
-  build.bundleScript(`.build/${srcts}`);
-  publishRoot(ds, ver, '');
+  bundleScript(ds);
+  publishRootPackage(ds, ver, '');
   build.webifyScript('index.mjs', 'index.mjs', {format: 'esm'});
   build.webifyScript('index.js',  'index.js',  {format: 'cjs', symbol: sym});
-  publishRoot(ds, ver, 'web');
+  publishRootPackage(ds, ver, 'web');
 }
 
 
-// Deploy root, sub packages to NPM, GitHub.
-function deployAll(ds) {
-  var m   = build.readMetadata('.');
-  var ver = build.nextUnpublishedVersion(m.name, m.version);
-  build.exec(`tsc`);
+// Publish docs.
+function publishDocs(ds) {
   build.updateGithubRepoDetails({topics: keywords(ds)});
   build.generateDocs(`src/${srcts}`);
   build.publishDocs();
-  deployRoot(ds, ver);
+}
+
+
+// Pushish root, sub packages to NPM, GitHub.
+function publishPackages(ds) {
+  var m   = build.readMetadata('.');
+  var ver = build.nextUnpublishedVersion(m.name, m.version);
+  publishRootPackages(ds, ver);
 }
 
 
@@ -108,12 +131,14 @@ function updateReadme(ds) {
 }
 
 
+// Finally.
 function main(a) {
   var p  = build.loadDocs([`src/${srcts}`]);
   var ds = p.children.map(build.docsDetails);
-  if (a[2] === 'deploy') deployAll(ds);
-  else if (a[2] === 'wiki') generateWiki(ds);
-  else if (a[2] === 'readme') updateReadme(ds);
-  else build.bundleScript(`.build/${srcts}`);
+  if (a[2]==='wiki') generateWiki(ds);
+  else if (a[2]==='readme') updateReadme(ds);
+  else if (a[2]==='publish-docs') publishDocs(ds);
+  else if (a[2]==='publish-packages') publishPackages(ds);
+  else bundleScript(ds);
 }
 main(process.argv);