Publish pre-built bundles to npm

.github/workflows/release.yml

@@ -16,6 +16,7 @@ jobs:
         registry-url: "https://registry.npmjs.org/"
     - run: npm install
     - run: npm test
-    - run: npm publish --access public
+    - run: npm run release-build
+    - run: npm publish build/ --access public
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 .idea
 /node_modules/
 *.log
+build/

.npmignore

@@ -3,6 +3,7 @@
 .prettierignore
 .prettierrc
 .vscode
+build
 docs
 test
 schemas

.prettierignore

@@ -8,3 +8,4 @@ LICENSE
 .editorconfig
 /package-lock.json
 /CODE_OF_CONDUCT.md
+build/

package.json

@@ -47,6 +47,7 @@
     "fix": "node scripts/fix",
     "mirror": "node scripts/mirror",
     "stats": "node scripts/statistics",
+    "release-build": "node scripts/release-build",
     "release-pulls": "node scripts/release-pulls",
     "release-stats": "node scripts/release-stats",
     "show-errors": "npm test 1> /dev/null",

scripts/release-build.js

@@ -0,0 +1,93 @@
+'use strict';
+
+const fs = require('fs').promises;
+const path = require('path');
+
+const directory = './build/';
+
+const verbatimFiles = ['LICENSE', 'README.md', 'index.d.ts', 'types.d.ts'];
+
+// Returns a string representing data ready for writing to JSON file
+function createDataBundle() {
+  const bcd = require('../index.js');
+  const string = JSON.stringify(bcd);
+  return string;
+}
+
+// Returns a promise for writing the data to JSON file
+async function writeData() {
+  const dest = path.resolve(directory, 'data.json');
+  const data = createDataBundle();
+  await fs.writeFile(dest, data);
+}
+
+// Returns an array of promises for copying of all files that don't need transformation
+async function copyFiles() {
+  for (const file of verbatimFiles) {
+    const src = path.join('./', file);
+    const dest = path.join(directory, file);
+    await fs.copyFile(src, dest);
+  }
+}
+
+function createManifest() {
+  const full = require('../package.json');
+  const minimal = { main: 'data.json' };
+
+  const minimalKeys = [
+    'name',
+    'version',
+    'description',
+    'repository',
+    'keywords',
+    'author',
+    'license',
+    'bugs',
+    'homepage',
+    'types',
+  ];
+
+  for (const key of minimalKeys) {
+    if (key in full) {
+      minimal[key] = full[key];
+    } else {
+      throw `Could not create a complete manifest! ${key} is missing!`;
+    }
+  }
+  return JSON.stringify(minimal);
+}
+
+async function writeManifest() {
+  const dest = path.resolve(directory, 'package.json');
+  const manifest = createManifest();
+  await fs.writeFile(dest, manifest);
+}
+
+async function main() {
+  // Remove existing files, if there are any
+  await fs
+    .rmdir(directory, {
+      force: true,
+      recursive: true,
+    })
+    .catch(e => {
+      // Missing folder is not an issue since we wanted to delete it anyway
+      if (e.code !== 'ENOENT') throw e;
+    });
+
+  // Crate a new directory
+  await fs.mkdir(directory);
+
+  await writeManifest();
+  await writeData();
+  await copyFiles();
+
+  console.log('Data bundle is ready');
+}
+
+// This is needed because NodeJS does not support top-level await.
+// Also, make sure to log all errors and exit with failure code.
+main().catch(e => {
+  console.error(e);
+  process.exit(1);
+});

scripts/release-build.test.js

@@ -0,0 +1,15 @@
+'use strict';
+const assert = require('assert');
+const { execSync } = require('child_process');
+
+const prebuiltPath = '../build';
+
+describe('release-build', () => {
+  it('pre-built bundles are identical to the source', done => {
+    execSync('npm run release-build');
+    const regular = require('../');
+    const bundled = require(prebuiltPath);
+    assert.deepEqual(regular, bundled);
+    done();
+  }).timeout(5000); // Timeout must be long enough for all the file I/O
+});