build-strap 4.0.0-dev.46 → 4.0.0-dev.54

package/README.md

@@ -1,7 +1,7 @@
 # build-strap
-A suite of functions to help with writing build scripts using javascript code (which run on node).
+A suite of functions to help with writing build scripts using TypeScript (or javascript) code (which run on node).
 
-This project builds itself, so take a look in the `tools/` folder for an example project. Run `./bs` to build.
+This project builds itself, so take a look in the `targets/` folder for an example. Run `./bs` to build.
 
 [![CI Build](https://github.com/murrayju/build-strap/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/murrayju/build-strap/actions?query=workflow%3A%22CI+Build%22)
 [![version](https://img.shields.io/github/v/tag/murrayju/build-strap.svg?label=version&sort=semver)](https://github.com/murrayju/build-strap/releases/latest)
@@ -41,39 +41,14 @@ By default, the build tools read project-specific configuration from your `packa
     "npm": {
       "publish": true,
     },
-    "artifactory": {
-      "root": "https://artifactory.your-company.com/artifactory/",
-      "path": "com/your-company/your-project-name",
-      "version-folders": false,
-      "integration": "integration-repo",
-      "integration-branch-folders": true,
-      "integration-days-to-keep": 14,
-      "integration-max-to-keep": 10,
-      "release": "releases-repo",
-      "release-branch": "master",
-      "npm": "npm-repo",
-      "npm-clean": "internal-npm-repo"
-    },
     "docker": {
-      "registry": "artifactory.your-company.com",
+      "registry": "ghcr.io",
       "repository": "your-company",
       "name": "your-project-name"
     }
   }
 }
 ```
-### artifactory
-* **root**: base URL for the artifactory server
-* **path**: path to project root in the artifactory tree.
-* **version-folders**: if `true`, artifacts will be organized into subfolders for each version number
-* **integration**: name of the artifactory repo in which to place integration (not official release) artifacts.
-* **integration-branch-folders**: if `true`, artifacts will be organized into subfolders for each branch.
-* **integration-days-to-keep**: for artifact cleanup, specifies the max age in days before an artifact will be deleted.
-* **integration-max-to-keep**: for artifact cleanup, specifies the maximum number of artifacts to keep, regardless of age. Only the newest N artifacts will be kept.
-* **release**: name of the artifactory repo in which to place release artifacts.
-* **release-branch**: name of the mercurial branch from which official releases are built/published. Defaults to `master`.
-* **npm**: name of the artifactory repo in which to publish npm artifacts.
-* **npm-clean**: for artifact cleanup, the name of the artifactory repo used to find and delete old npm artifacts.
 
 ### docker
 * **registry**: base URL for the docker registry, as needed by `docker push`.
@@ -135,9 +110,3 @@ In order to publish to NPM, proper credentials must be provided to the script. B
 ```
 { "email": "builder@your-company.com", "username":"builder", "password":"abc123" }
 ```
-
-## Artifactory Credentials
-In order to publish and/or delete things from Artifactory, proper credentials must be provided to the script. By default, these are read from the `ARTIFACTORY_CREDS` environment variable, but it is also possible to pass them as an argument to most functions. This is expected to be a JSON encoded string in the following format:
-```
-{ "email": "builder@your-company.com", "username":"builder", "password":"abc123" }
-```

package/package.json

@@ -1,31 +1,35 @@
 {
   "name": "build-strap",
-  "version": "4.0.0-dev.46",
-  "main": "index.js",
+  "version": "4.0.0-dev.54",
+  "description": "Node scripts for building things",
+  "license": "MIT",
+  "authors": [
+    "Justin Murray <justin@murrayju.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/murrayju/build-strap"
+  },
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "engines": {
+    "node": ">=16"
+  },
   "dependencies": {
-    "bytes": "3",
+    "bytes": "^3.1.1",
     "chokidar": "^3.5.2",
     "cross-spawn": "^7.0.3",
     "fs-extra": "^10.0.0",
-    "get-port": "^5.1.1",
-    "glob": "^7.1.7",
-    "is-reachable": "^5.0.0",
+    "get-port": "^6.0.0",
+    "glob": "^7.2.0",
+    "is-reachable": "^5.1.1",
     "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "md5-file": "^5.0.0",
+    "lodash-es": "^4.17.21",
     "moment": "^2.29.1",
-    "request": "^2.88.2",
-    "request-promise-native": "^1.0.9",
-    "rimraf": "^3.0.2",
-    "set-value": "^4.0.1",
-    "source-map-support": "^0.5.16",
+    "node-fetch": "^3.1.0",
     "stream-counter": "1",
-    "tar": "^6.1.9",
+    "tar": "^6.1.11",
     "url-join": "^4.0.1"
-  },
-  "peerDependencies": {},
-  "engines": {
-    "node": ">=7",
-    "npm": ">=4"
   }
 }

package/src/ant.d.ts

@@ -0,0 +1,19 @@
+import { SpawnOptions } from './cp.js';
+/**
+ * Named value pair to use when configuring an Ant build property
+ */
+export interface AntPropertyConfiguration {
+    name: string;
+    value: string;
+}
+export interface AntSpawnOptions {
+    args?: string[];
+    properties?: AntPropertyConfiguration[];
+    spawnOptions?: SpawnOptions;
+}
+/**
+ * Executes the given ant command
+ * @param {string} target the ant target to invoke
+ * @param {AntSpawnOptions} options
+ */
+export declare function ant(target: string, opts?: AntSpawnOptions): Promise<void>;

package/src/ant.js

@@ -1,42 +1,18 @@
-// @flow
-import { spawn } from './cp';
-import type { SpawnOptions } from './cp';
-
-/**
- * Named value pair to use when configuring an Ant build property
- */
-export type AntPropertyConfiguration = {|
-  name: string,
-  value: string,
-|};
-
-export type AntSpawnOptions = {|
-  properties?: AntPropertyConfiguration[], // Ant property values to configure
-  args?: string[], // Any additional command line arguments to pass
-  spawnOptions?: SpawnOptions, // Optional spawn configuration. Defaults to run the project root directory
-|};
-
+import { spawn } from './cp.js';
 /**
  * Executes the given ant command
  * @param {string} target the ant target to invoke
  * @param {AntSpawnOptions} options
  */
-export async function ant(target: string, opts?: AntSpawnOptions) {
-  const { properties = [], args = [], spawnOptions } = opts || {};
-
-  const execOptions = {
-    stdio: 'inherit',
-    pipeOutput: true,
-    ...spawnOptions,
-  };
-
-  await spawn(
-    'ant',
-    [
-      target,
-      ...args,
-      ...properties.map(({ name, value }) => `-D${name}=${value}`),
-    ],
-    execOptions,
-  );
+export async function ant(target, opts) {
+    const { properties = [], args = [], spawnOptions } = opts || {};
+    await spawn('ant', [
+        target,
+        ...args,
+        ...properties.map(({ name, value }) => `-D${name}=${value}`),
+    ], {
+        pipeOutput: true,
+        stdio: 'inherit',
+        ...spawnOptions,
+    });
 }

package/src/cert.d.ts

@@ -0,0 +1,12 @@
+export interface CertConfig {
+    commonName?: string;
+    countryName?: string;
+    emailAddress?: string;
+    localityName?: string;
+    organizationName?: string;
+    organizationalUnitName?: string;
+    stateOrProvinceName?: string;
+}
+export declare const getCertConfig: () => CertConfig;
+export declare const getIpAddresses: () => string[];
+export declare function generateCert(targetDir: string, force?: boolean): Promise<void>;

package/src/cert.js

@@ -1,152 +1,91 @@
-// @flow
+import fs from 'fs-extra';
+import fetch from 'node-fetch';
 import os from 'os';
-import rp from 'request-promise-native';
 import path from 'path';
-import fs from 'fs-extra';
-import { buildLog } from './run';
-import { readDir } from './fs';
-import { spawn } from './cp';
-import { getCfg } from './pkg';
-
-export type CertConfig = {
-  countryName?: string,
-  stateOrProvinceName?: string,
-  localityName?: string,
-  organizationName?: string,
-  organizationalUnitName?: string,
-  commonName?: string,
-  emailAddress?: string,
-};
-
-export function getCertConfig(): CertConfig {
-  return getCfg().cert || {};
-}
-
-export function getIpAddresses(): string[] {
-  const iFaces = os.networkInterfaces();
-  return Object.keys(iFaces).reduce(
-    (prev, ifName) => [
-      ...prev,
-      ...iFaces[ifName].map((iFace) => iFace.address),
-    ],
-    [],
-  );
-}
-
+import { spawn } from './cp.js';
+import { readDir } from './fs.js';
+import { getCfg } from './pkg.js';
+import { buildLog } from './run.js';
+export const getCertConfig = () => getCfg().cert ?? {};
+export const getIpAddresses = () => Object.values(os.networkInterfaces()).flatMap((iFaces) => iFaces?.map((iFace) => iFace.address) ?? []);
 // Generate a self-signed certificate (if it doesn't exist)
-export async function generateCert(
-  targetDir: string,
-  force: boolean = process.argv.includes('--force-generateCert'),
-) {
-  if (process.argv.includes('--no-generateCert')) {
-    buildLog('Skipping due to --no-generateCert');
-    return;
-  }
-  buildLog(`scanning ${targetDir} for certificates...`);
-  if (
-    !force &&
-    (await readDir(`${targetDir}/server.@(crt|key)`)).length === 2
-  ) {
-    buildLog('Skipping certificate generation: certificate already exists');
-    return;
-  }
-  buildLog('Generating self-signed certificate...');
-  const {
-    countryName = 'US',
-    stateOrProvinceName = 'Pennsylvania',
-    localityName = 'SomeCity',
-    organizationName = 'Company',
-    organizationalUnitName = 'Product',
-    commonName = 'app.company.com',
-    emailAddress = 'contact@company.com',
-  } = getCertConfig();
-  const hostname = os.hostname();
-  buildLog(`hostname: ${hostname}`);
-  const ipAddresses = getIpAddresses();
-  buildLog(`ip addresses: ${JSON.stringify(ipAddresses)}`);
-  const ifconfig = await rp.get('https://ifconfig.co', { json: true });
-  const externalIp4 = ifconfig.ip;
-  buildLog(`external ipv4: ${externalIp4}`);
-  const dnsName = ifconfig.hostname;
-  buildLog(`dnsName: ${dnsName}`);
-
-  await fs.ensureDir(targetDir);
-  const keyFile = path.resolve(targetDir, 'server.key');
-  const csrFile = path.resolve(targetDir, 'server.csr');
-  const crtFile = path.resolve(targetDir, 'server.crt');
-  const confTemplateFile = path.resolve(__dirname, 'cert.conf');
-  const confFile = path.resolve(targetDir, 'cert.conf.generated');
-  const confTemplate = await fs.readFile(confTemplateFile, 'utf8');
-  await fs.writeFile(
-    confFile,
-    confTemplate
-      .replace('{{countryName}}', countryName)
-      .replace('{{stateOrProvinceName}}', stateOrProvinceName)
-      .replace('{{localityName}}', localityName)
-      .replace('{{organizationName}}', organizationName)
-      .replace('{{organizationalUnitName}}', organizationalUnitName)
-      .replace('{{commonName}}', commonName)
-      .replace('{{emailAddress}}', emailAddress)
-      .replace(
-        '{{SAN_IP}}',
-        ipAddresses.reduce((acc, next) => `${acc},IP:${next}`, ''),
-      )
-      .replace('{{SAN_DNS}}', `,DNS:${hostname},DNS:${dnsName}`),
-    'utf8',
-  );
-
-  buildLog('generating key file...');
-  await spawn(
-    'openssl',
-    [
-      'genpkey',
-      '-algorithm',
-      'RSA',
-      '-pkeyopt',
-      'rsa_keygen_bits:2048',
-      '-out',
-      keyFile,
-    ],
-    { pipeOutput: true },
-  );
-  buildLog('generating csr file...');
-  await spawn(
-    'openssl',
-    [
-      'req',
-      '-new',
-      '-key',
-      keyFile,
-      '-out',
-      csrFile,
-      '-subj',
-      `/C=${countryName}/ST=${stateOrProvinceName}/L=${localityName}/O=${organizationName}/OU=${organizationalUnitName}/CN=${commonName}/CN=${externalIp4}/CN=${hostname}/CN=${dnsName}${ipAddresses.reduce(
-        (acc, next) => `${acc}/CN=${next}`,
-      )}/CN=localhost`,
-      '-config',
-      confFile,
-    ],
-    { pipeOutput: true },
-  );
-  buildLog('generating cert...');
-  await spawn(
-    'openssl',
-    [
-      'x509',
-      '-req',
-      '-days',
-      '365',
-      '-in',
-      csrFile,
-      '-signkey',
-      keyFile,
-      '-out',
-      crtFile,
-      '-extfile',
-      confFile,
-      '-extensions',
-      'v3_req',
-    ],
-    { pipeOutput: true },
-  );
+export async function generateCert(targetDir, force = process.argv.includes('--force-generateCert')) {
+    if (process.argv.includes('--no-generateCert')) {
+        buildLog('Skipping due to --no-generateCert');
+        return;
+    }
+    buildLog(`scanning ${targetDir} for certificates...`);
+    if (!force &&
+        (await readDir(`${targetDir}/server.@(crt|key)`)).length === 2) {
+        buildLog('Skipping certificate generation: certificate already exists');
+        return;
+    }
+    buildLog('Generating self-signed certificate...');
+    const { commonName = 'app.company.com', countryName = 'US', emailAddress = 'contact@company.com', localityName = 'SomeCity', organizationName = 'Company', organizationalUnitName = 'Product', stateOrProvinceName = 'Pennsylvania', } = getCertConfig();
+    const hostname = os.hostname();
+    buildLog(`hostname: ${hostname}`);
+    const ipAddresses = getIpAddresses();
+    buildLog(`ip addresses: ${JSON.stringify(ipAddresses)}`);
+    const ifconfig = await fetch('https://ifconfig.co').then((r) => r.json());
+    const externalIp4 = ifconfig.ip;
+    buildLog(`external ipv4: ${externalIp4}`);
+    const dnsName = ifconfig.hostname;
+    buildLog(`dnsName: ${dnsName}`);
+    await fs.ensureDir(targetDir);
+    const keyFile = path.resolve(targetDir, 'server.key');
+    const csrFile = path.resolve(targetDir, 'server.csr');
+    const crtFile = path.resolve(targetDir, 'server.crt');
+    const confTemplateFile = path.resolve(__dirname, 'cert.conf');
+    const confFile = path.resolve(targetDir, 'cert.conf.generated');
+    const confTemplate = await fs.readFile(confTemplateFile, 'utf8');
+    await fs.writeFile(confFile, confTemplate
+        .replace('{{countryName}}', countryName)
+        .replace('{{stateOrProvinceName}}', stateOrProvinceName)
+        .replace('{{localityName}}', localityName)
+        .replace('{{organizationName}}', organizationName)
+        .replace('{{organizationalUnitName}}', organizationalUnitName)
+        .replace('{{commonName}}', commonName)
+        .replace('{{emailAddress}}', emailAddress)
+        .replace('{{SAN_IP}}', ipAddresses.reduce((acc, next) => `${acc},IP:${next}`, ''))
+        .replace('{{SAN_DNS}}', `,DNS:${hostname},DNS:${dnsName}`), 'utf8');
+    buildLog('generating key file...');
+    await spawn('openssl', [
+        'genpkey',
+        '-algorithm',
+        'RSA',
+        '-pkeyopt',
+        'rsa_keygen_bits:2048',
+        '-out',
+        keyFile,
+    ], { pipeOutput: true });
+    buildLog('generating csr file...');
+    await spawn('openssl', [
+        'req',
+        '-new',
+        '-key',
+        keyFile,
+        '-out',
+        csrFile,
+        '-subj',
+        `/C=${countryName}/ST=${stateOrProvinceName}/L=${localityName}/O=${organizationName}/OU=${organizationalUnitName}/CN=${commonName}/CN=${externalIp4}/CN=${hostname}/CN=${dnsName}${ipAddresses.reduce((acc, next) => `${acc}/CN=${next}`)}/CN=localhost`,
+        '-config',
+        confFile,
+    ], { pipeOutput: true });
+    buildLog('generating cert...');
+    await spawn('openssl', [
+        'x509',
+        '-req',
+        '-days',
+        '365',
+        '-in',
+        csrFile,
+        '-signkey',
+        keyFile,
+        '-out',
+        crtFile,
+        '-extfile',
+        confFile,
+        '-extensions',
+        'v3_req',
+    ], { pipeOutput: true });
 }

package/src/clean.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Cleans up the build output directories.
+ */
+export declare function clean(globs?: string[]): Promise<void>;

package/src/clean.js

@@ -1,19 +1,11 @@
-// @flow
-import { cleanDir } from './fs';
-
+import { cleanDir } from './fs.js';
 /**
  * Cleans up the build output directories.
  */
-export async function clean(
-  globs: string[] = ['dist/*', 'out/*', 'build/*'],
-): Promise<void> {
-  await Promise.all(
-    globs.map((glob) =>
-      cleanDir(glob, {
-        nosort: true,
+export async function clean(globs = ['dist/*', 'out/*', 'build/*']) {
+    await Promise.all(globs.map((glob) => cleanDir(glob, {
         dot: true,
         ignore: ['.git', '.hg'],
-      }),
-    ),
-  );
+        nosort: true,
+    })));
 }

package/src/copy.d.ts

@@ -0,0 +1,7 @@
+export interface CopySrcOptions {
+    cbFn?: () => void;
+    from: string;
+    to: string;
+    watch?: boolean;
+}
+export declare function copySrc({ from, to, watch, cbFn, }: CopySrcOptions): Promise<void>;

package/src/copy.js

@@ -1,79 +1,53 @@
-// @flow
-import path from 'path';
 import chokidar from 'chokidar';
-import { copyFile, makeDir, copyDir, cleanDir } from './fs';
-import { onKillSignal } from './cp';
-import { buildLog } from './run';
-import { dependencies } from './inline-resources';
-
+import fs from 'fs-extra';
+import path from 'path';
+import { onKillSignal } from './cp.js';
+import { cleanDir, copyDir } from './fs.js';
+import { buildLog } from './run.js';
 let timer = null;
 async function throttledCallback(cbFn) {
-  if (!cbFn || typeof cbFn !== 'function') {
-    return;
-  }
-  if (timer) {
-    clearTimeout(timer);
-    timer = null;
-  }
-  timer = setTimeout(() => {
-    timer = null;
-    cbFn();
-  }, 200);
+    if (!cbFn || typeof cbFn !== 'function') {
+        return;
+    }
+    if (timer) {
+        clearTimeout(timer);
+        timer = null;
+    }
+    timer = setTimeout(() => {
+        timer = null;
+        cbFn();
+    }, 200);
 }
-
-export type CopySrcOptions = {
-  from: string,
-  to: string,
-  watch?: boolean,
-  cbFn?: () => Promise<any> | void,
-};
-
-export async function copySrc({
-  from,
-  to,
-  watch = process.argv.includes('--watch'),
-  cbFn,
-}: CopySrcOptions = {}): Promise<void> {
-  await copyDir(from, to);
-  if (cbFn) await cbFn();
-  if (watch) {
-    const watcher = chokidar.watch([path.join(from, '/**/*')], {
-      ignoreInitial: true,
-    });
-
-    watcher.on('all', async (event, filePath) => {
-      const start = new Date();
-      const src = path.relative(from, filePath);
-      const dest = path.join(to, src);
-      switch (event) {
-        case 'add':
-        case 'change':
-          await makeDir(path.dirname(dest));
-          await copyFile(filePath, dest);
-          break;
-        case 'unlink':
-        case 'unlinkDir':
-          cleanDir(dest, { nosort: true, dot: true });
-          break;
-        default:
-          return;
-      }
-      // Check dependencies
-      if (dependencies[dest]) {
-        await Promise.all(
-          dependencies[dest].map(async (dep) => {
-            const toCopy = path.join(from, path.relative(to, dep));
-            await copyFile(toCopy, dep);
-            buildLog(`copied '${dep}' due to changed dependency`);
-          }),
-        );
-      }
-      const end = new Date();
-      const time = end.getTime() - start.getTime();
-      buildLog(`${event} '${dest}' after ${time} ms`, end);
-      throttledCallback(cbFn);
-    });
-
-    onKillSignal(() => watcher.close());
-  }
+export async function copySrc({ from, to, watch = process.argv.includes('--watch'), cbFn, }) {
+    await copyDir(from, to);
+    if (cbFn)
+        await cbFn();
+    if (watch) {
+        const watcher = chokidar.watch([path.join(from, '/**/*')], {
+            ignoreInitial: true,
+        });
+        watcher.on('all', async (event, filePath) => {
+            const start = new Date();
+            const src = path.relative(from, filePath);
+            const dest = path.join(to, src);
+            switch (event) {
+                case 'add':
+                case 'change':
+                    await fs.ensureDir(path.dirname(dest));
+                    await fs.copyFile(filePath, dest);
+                    break;
+                case 'unlink':
+                case 'unlinkDir':
+                    cleanDir(dest, { dot: true, nosort: true });
+                    break;
+                default:
+                    return;
+            }
+            const end = new Date();
+            const time = end.getTime() - start.getTime();
+            buildLog(`${event} '${dest}' after ${time} ms`, end);
+            throttledCallback(cbFn);
+        });
+        onKillSignal(() => watcher.close());
+    }
 }

package/src/cp.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import cp from 'child_process';
+export interface SpawnOptions extends cp.SpawnOptions {
+    captureOutput?: boolean;
+    pipeOutput?: boolean;
+    rejectOnErrorCode?: boolean;
+}
+export interface SpawnResult {
+    code: number;
+    output: string;
+    signal: string;
+    stderr: string;
+    stdout: string;
+}
+export declare function spawn(command: string, args?: string[], opts?: SpawnOptions | null): Promise<SpawnResult>;
+export declare const exec: typeof cp.exec.__promisify__;
+export declare const onKillSignal: (cbFn: () => void) => void;