🥭 update build setup

.gitignore

@@ -1,6 +1,7 @@
 # Generated files
 .build/
 .docs/
+coverage/
 *.d.ts
 *.map
 example.js

.npmignore

@@ -6,10 +6,14 @@ src/
 data/
 wiki/
 tests/
+unused/
+test.js
+CITATION.cff
 TODO
 
 # Build
 .build/
+coverage/
 .travis.yml
 .coveralls.yml
 tsconfig.json

build.js

@@ -1,236 +1,119 @@
-const os = require('os');
-const {child_process: cp, fs, path} = require('extra-build');
-const {git, github, package}        = require('extra-build');
-const {javascript, jsdoc, markdown} = require('extra-build');
-
+const build = require('extra-build');
 
 const owner  = 'nodef';
 const srcts  = 'index.ts';
-const outjs  = 'index.js';
-const outmjs = 'index.mjs';
-const outdts = 'index.d.ts';
-
-
+const LOCATIONS = [
+  'src/index.ts',
+];
 
 
-function isSubmodule(pth) {
-  if (/^_|index.ts$/.test(pth)) return false;
-  if (!/\.ts$/.test(pth)) return false;
-  return true;
-}
-
-
-// Get filename keywords for main/sub package.
-function filenameKeywords(fil) {
-  if (fil !== srcts) return [path.symbolname(fil)];
-  return fs.readdirSync('src').filter(isSubmodule).map(path.symbolname);
-}
-
-
-// Get export keywords for main/sub package.
-function exportKeywords(fil) {
-  var txt  = fs.readFileTextSync(`src/${fil}`);
-  var exps = javascript.jsdocSymbols(txt).filter(s => s.export);
-  return exps.map(e => path.symbolname(e.name));
-}
 
 
 // Get keywords for main/sub package.
-function keywords(fil) {
-  var m = package.read('.');
-  var s = new Set([...m.keywords, ...filenameKeywords(fil), ...exportKeywords(fil)]);
+function keywords(ds) {
+  var m = build.readMetadata('.');
+  var s = new Set([...m.keywords, ...ds.map(d => d.name)]);
   return Array.from(s);
 }
 
 
-// Update GitHub details.
-function updateGithub() {
-  var m = package.read('.');
-  var {name, description} = m;
-  var homepage  = `https://www.npmjs.com/package/${name}`;
-  var topics    = keywords(srcts);
-  topics.length = Math.min(topics.length, 20);
-  github.updateDetails(owner, name, {description, homepage, topics});
-}
-
-
-// Generate and publish docs.
-function publishDocs(fil) {
-  var url = git.remoteUrl();
-  var cwd = fs.mkdtempSync(path.join(os.tmpdir(), '.docs'));
-  cp.execLogSync(`git clone ${url} "${cwd}"`);
-  try { cp.execLogSync(`git checkout gh-pages`, {cwd}); }
-  catch(e) { git.setupBranch('gh-pages', {cwd}); }
-  cp.execLogSync(`typedoc "src/${fil}" --out ".docs"`);
-  cp.execLogSync(`rm -rf "${cwd}"/*`);
-  cp.execLogSync(`mv ".docs"/* "${cwd}"/`);
-  git.commitPush('', {cwd});
-  cp.execLogSync(`rm -rf ${cwd}`);
-}
-
-
-// Webify output files.
-function webifyMain(sym) {
-  cp.execLogSync(`browserify "${outjs}" -o "${outjs}.1" -s ${sym}`);
-  cp.execLogSync(`cp "${outmjs}" "${outmjs}.1"`);
-  cp.execLogSync(`terser "${outjs}.1" -o "${outjs}"  -c -m`);
-  cp.execLogSync(`terser "${outmjs}.1" -o "${outmjs}" -c -m`);
-  cp.execLogSync(`rm -f "${outjs}.1"`);
-  cp.execLogSync(`rm -f "${outmjs}.1"`);
-}
-
-
-// Generate main output files.
-function generateMain(fil, sym) {
-  var bld = fil.replace(/\.ts/, '.js');
-  var env = sym? ` --environment TYPE:web` : '';
-  cp.execLogSync(`rollup -c rollup.config.js -i .build/${bld}` + env);
-  if (sym) webifyMain(sym);
-}
-
-
 // Publish root package to NPM, GitHub.
-function publishRoot(sym, ver) {
-  fs.restoreFileSync('package.json', () => {
-    var m = package.read();
-    m.version  = ver;
-    m.keywords = keywords(srcts);
-    if (sym) { m.name += '.web'; }
-    fs.restoreFileSync('README.md', () => {
-      var txt = fs.readFileTextSync('README.md');
-      if (sym) txt = txt.replace(/\[Files\]\((.*?)\/\)/g, '[Files]($1.web/)');
-      fs.writeFileTextSync('README.md', txt);
-      package.write('.', m);
-      package.publish('.');
-      package.publishGithub('.', owner);
-    });
-  });
+function publishRoot(ds, ver, typ) {
+  var _package = build.readDocument('package.json');
+  var _readme  = build.readDocument('README.md');
+  var m  = build.readMetadata('.');
+  var md = build.readFileText('README.md');
+  m.version  = ver;
+  m.keywords = keywords(ds);
+  if (typ) {
+    m.name = `${m.name}.${typ}`;
+    m.description.replace(/\.$/, `{${typ}}.`);
+    md.replace(/(unpkg\.com\/)(\S+?)(\/\))/, `$1$2.${typ}$3`);
+  }
+  build.writeMetadata('.', m);
+  build.writeFileText('README.md', md);
+  build.publish('.');
+  try { build.publishGithub('.', owner); }
+  catch {}
+  build.writeDocument(_package);
+  build.writeDocument(_readme);
 }
 
 
 // Deploy root package to NPM, GitHub.
-function deployRoot(ver) {
-  var m   = package.read();
-  var sym = path.symbolname(m.name);
-  generateMain(srcts, '');
-  publishRoot('', ver);
-  generateMain(srcts, sym);
-  publishRoot(sym, ver);
+function deployRoot(ds, ver) {
+  var m   = build.readMetadata('.');
+  var sym = build.symbolname(m.name);
+  build.bundleScript(`.build/${srcts}`);
+  publishRoot(ds, ver, '');
+  build.webifyScript('index.mjs', 'index.mjs', {format: 'esm'});
+  build.webifyScript('index.js',  'index.js',  {format: 'cjs', symbol: sym});
+  publishRoot(ds, ver, 'web');
 }
 
 
 // Deploy root, sub packages to NPM, GitHub.
-function deployAll() {
-  var m   = package.read();
-  var ver = package.nextUnpublishedVersion(m.name, m.version);
-  cp.execLogSync(`tsc`);
-  updateGithub();
-  publishDocs(srcts);
-  deployRoot(ver);
-  // deploySub(ver);
+function deployAll(ds) {
+  var m   = build.readMetadata('.');
+  var ver = build.nextUnpublishedVersion(m.name, m.version);
+  build.exec(`tsc`);
+  build.updateGithubRepoDetails({topics: keywords(ds)});
+  build.generateDocs(`src/${srcts}`);
+  build.publishDocs();
+  deployRoot(ds, ver);
 }
 
 
-// Source export symbols.
-function sourceExportSymbols() {
-  var a = new Map();
-  var f = 'index.ts';
-  var txt = fs.readFileTextSync(`src/${f}`);
-  var exps = javascript.exportSymbols(txt);
-  for (var exp of exps)
-    a.set(exp.name, exp);
-  return a;
+// Generate wiki for all exported symbols.
+function generateWiki() {
+  // createWikiFiles();
+  // generateWikiFiles();
 }
 
-// Source JSDoc symbols.
-function sourceJsdocSymbols() {
-  var a = new Map();
-  for (var f of fs.readdirSync('src')) {
-    var txt = fs.readFileTextSync(`src/${f}`);
-    var docs = javascript.jsdocSymbols(txt);
-    for (var doc of docs)
-      a.set(doc.name, doc);
-  }
-  return a;
-}
-
-
-// Update index table for README.
-function updateMarkdownIndex(rkind) {
-  var out  = 'README.md';
-  var exps = sourceExportSymbols();
-  var docs = sourceJsdocSymbols();
-  var txt  = fs.readFileTextSync(out);
-  txt = markdown.replaceTables(txt, (full, rows) => {
-    if (rows.length < 1 || rows[0].length < 2) return full;
-    rows = rows.map(r => [r[0].trim(), r[1].trim()]);
-    if (!/property/i.test(rows[0][0]))    return full;
-    if (!/description/i.test(rows[0][1])) return full;
-    var rmap = new Map(rows.map((r, i) => [r[0], i]));
-    for (var e of exps.values()) {
-      if (!docs.has(e.name)) continue;
-      // if (!rkind.test(e.kind)) continue;
-      var key  = `[${e.name}]`;
-      var val = jsdoc.parse(docs.get(e.name).jsdoc).description.trim();
-      if (!rmap.has(key)) rows.push([key, val]);
-      else rows[rmap.get(key)][1] = val;
-    }
-    var top = '| ' + rows[0].join(' | ') + ' |\n';
-    var mid = '| ' + rows[0].map(r => ` ---- `).join(' | ') + ' |\n';
-    var bot = rows.slice(1).map(r => '| ' + r.join(' | ') + ' |\n').join('');
-    return top + mid + bot;
-  });
-  fs.writeFileTextSync(out, txt);
-}
 
-
-// Get docs link reference for jsdoc symbol.
-function docsLinkReference(sym, pre, repo) {
-  var d    = jsdoc.parse(sym.jsdoc);
-  var root = `https://${owner}.github.io/${repo}`;
-  var name = sym.name;
-  var pred = pre? `${pre}.` : '';
-  var prem = pre? `modules/${pre}.html` : 'modules.html';
-  switch (d.kind) {
-    case 'interface': return `[${name}]: ${root}/interfaces/${pred}${name}.html`;
-    case 'class':     return `[${name}]: ${root}/classes/${pred}${name}.html`;
-    default:          return `[${name}]: ${root}/${prem}#${name}`;
-  }
+// Get README index descriptions.
+function readmeDescription(d) {
+  var rkind = /namespace|function/i;
+  var sname = /a?sync$/i;
+  if (!rkind.test(d.kind)) return '';
+  if (sname.test(d.name) && d.name!=='spawnAsync') return '';
+  var a = d.description.replace(/The.+method/, 'This method');
+  a = a.replace(', with command-line arguments in ', ' and ');
+  a = a.replace(/(\S)`(.*?)`/, '$1 `$2`');
+  return a;
 }
 
 
-// Update link references for README.
-function updateMarkdownLinkReferences() {
-  var m    = package.read('.');
-  var out  = 'README.md', pre = '';
-  var docs = sourceJsdocSymbols();
-  if (!fs.existsSync(out)) return;
-  var txt = fs.readFileTextSync(out);
-  txt = markdown.replaceLinkReferences(txt, (full, name) => {
-    if (!docs.has(name)) return full;
-    return docsLinkReference(docs.get(name), pre, m.name);
-  });
-  var lset = new Set(markdown.links(txt).filter(x => !x.url).map(x => x.ref || x.name));
-  var rset = new Set(markdown.linkReferences(txt).map(x => x.name));
-  for (var l of lset) {
-    if (rset.has(l)) continue;
-    if (!docs.has(l)) continue;
-    txt += docsLinkReference(docs.get(l), pre, m.name) + '\n';
-  }
-  fs.writeFileTextSync(out, txt);
+// Sort docs details by original order.
+function compareLocation(a, b) {
+  if (a.kind!==b.kind) return 0;
+  var alocn = a.location.replace(/.*?@types\/node.*?\:/, 'src/_file.ts:');
+  var blocn = b.location.replace(/.*?@types\/node.*?\:/, 'src/_file.ts:');
+  var [afile] = alocn.split(':');
+  var [bfile] = blocn.split(':');
+  return LOCATIONS.indexOf(afile) - LOCATIONS.indexOf(bfile) || alocn.localeCompare(blocn);
 }
 
 
-// Update markdowns README, wiki.
-function updateMarkdown() {
-  updateMarkdownIndex(/const|class|(async\s+)?function\*?/);
-  updateMarkdownLinkReferences();
+// Update README.
+function updateReadme(ds) {
+  var m  = build.readMetadata('.');
+  var repo = m.name;
+  var ds = ds.slice().sort(compareLocation);
+  var dm = new Map(ds.map(d => [d.name, d]));
+  var txt = build.readFileText('README.md');
+  txt = build.wikiUpdateIndex(txt, dm, readmeDescription);
+  txt = build.wikiUpdateLinkReferences(txt, dm, {owner, repo});
+  build.writeFileText('README.md', txt);
 }
 
 
 function main(a) {
-  if (a[2] === 'deploy') deployAll();
-  else if (a[2] === 'markdown') updateMarkdown();
-  else generateMain(srcts, '');
+  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}`);
 }
 main(process.argv);