@plugjs/build 0.1.0 → 0.2.1

package/dist/index.mjs

@@ -0,0 +1,252 @@
+// index.ts
+import "@plugjs/cov8";
+import "@plugjs/eslint";
+import "@plugjs/jasmine";
+import {
+  $gry,
+  $wht,
+  build,
+  find,
+  fixExtensions,
+  isDirectory,
+  log,
+  merge,
+  noop,
+  rmrf
+} from "@plugjs/plug";
+import "@plugjs/typescript";
+export * from "@plugjs/plug";
+var esbuildDefaults = {
+  platform: "node",
+  sourcemap: "linked",
+  sourcesContent: false,
+  plugins: [fixExtensions()]
+};
+function tasks(options = {}) {
+  const {
+    sourceDir: _sourceDir = "src",
+    destDir: _destDir = "dist",
+    testDir: _testDir = "test",
+    coverageDir: _coverageDir = "coverage",
+    coverageDataDir: _coverageDataDir = ".coverage-data",
+    extraTypesDir: _extraTypesDir = "types",
+    packageJson: _packageJson = "package.json",
+    outputPackageJson: _outputPackageJson = _packageJson,
+    cjsExtension: _cjsExtension = ".cjs",
+    esmExtension: _esmExtension = ".mjs",
+    cjsTranspile: _cjsTranspile = true,
+    esmTranspile: _esmTranspile = true,
+    parallelize: _parallelize = false,
+    banners: _banners = !_parallelize,
+    testGlob: _testGlob = "**/*.test.([cm])?ts",
+    exportsGlob: _exportsGlob = "index.*",
+    coverage: _coverage = true,
+    minimumCoverage: _minimumCoverage = 100,
+    minimumFileCoverage: _minimumFileCoverage = 100,
+    optimalCoverage: _optimalCoverage = void 0,
+    optimalFileCoverage: _optimalFileCoverage = void 0,
+    esbuildOptions: _esbuildOptions = {}
+  } = options;
+  const banner = _banners ? emitBanner : (...args) => void 0;
+  const esbuildMergedOptions = Object.assign({}, esbuildDefaults, _esbuildOptions);
+  return build({
+    /** The directory for the original sources (default: `src`) */
+    sourceDir: _sourceDir,
+    /** The destination directory of the transpiled sources (default: `dist`) */
+    destDir: _destDir,
+    /** The directory for the test files (default: `test`) */
+    testDir: _testDir,
+    /** The directory for the coverage report (default: `coverage`) */
+    coverageDir: _coverageDir,
+    /** The directory for the coverage data (default: `.coverage-data`) */
+    coverageDataDir: _coverageDataDir,
+    /** A directory containing extra types to use while transpiling (default: `types`) */
+    extraTypesDir: _extraTypesDir,
+    /** The source `package.json` file (default: `package.json`) */
+    packageJson: _packageJson,
+    /** The source `package.json` file (default: same as `packageJson` option) */
+    outputPackageJson: _outputPackageJson,
+    /** The extension used for CommonJS modules (default: `.cjs`) */
+    cjsExtension: _cjsExtension,
+    /** The extension used for EcmaScript modules (default: `.mjs`) */
+    esmExtension: _esmExtension,
+    /** A glob pattern matching all test files (default: `**∕*.test.([cm])?ts`) */
+    testGlob: _testGlob,
+    /** A glob pattern matching files to be exported (default: `index.*`) */
+    exportsGlob: _exportsGlob,
+    /* ====================================================================== *
+     * SOURCES STRUCTURE                                                      *
+     * ====================================================================== */
+    /** Find all CommonJS source files (`*.cts`) */
+    _find_sources_cts() {
+      return find("**/*.(c)?ts", { directory: this.sourceDir, ignore: "**/*.d.ts" });
+    },
+    /** Find all EcmaScript Module source files (`*.mts`) */
+    _find_sources_mts() {
+      return find("**/*.(m)?ts", { directory: this.sourceDir, ignore: "**/*.d.ts" });
+    },
+    /** Find all typescript source files (`*.ts`, `*.mts` and `*.cts`) */
+    _find_sources() {
+      return merge([
+        _cjsTranspile ? this._find_sources_cts() : noop(),
+        _esmTranspile ? this._find_sources_mts() : noop()
+      ]);
+    },
+    /** Find all types definition files within sources */
+    _find_types() {
+      return find("**/*.d.ts", { directory: this.sourceDir });
+    },
+    /** Find all types definition files within sources */
+    _find_extras() {
+      if (!isDirectory(this.extraTypesDir))
+        return noop();
+      return find("**/*.d.ts", { directory: this.extraTypesDir });
+    },
+    /** Find all resource files (non-typescript files) within sources */
+    _find_resources() {
+      return find("**/*", { directory: this.sourceDir, ignore: "**/*.([cm])?ts" });
+    },
+    /** Find all test source files */
+    _find_tests() {
+      return find(this.testGlob, { directory: this.testDir, ignore: "**/*.d.ts" });
+    },
+    /* ====================================================================== *
+     * TRANSPILE                                                              *
+     * ====================================================================== */
+    /** Transpile to CJS */
+    transpile_cjs() {
+      return this._find_sources_cts().esbuild({
+        ...esbuildMergedOptions,
+        format: "cjs",
+        outdir: this.destDir,
+        outExtension: { ".js": this.cjsExtension }
+      });
+    },
+    /** Transpile to ESM */
+    transpile_esm() {
+      return this._find_sources_mts().esbuild({
+        ...esbuildMergedOptions,
+        format: "esm",
+        outdir: this.destDir,
+        outExtension: { ".js": this.esmExtension }
+      });
+    },
+    /** Generate all .d.ts files */
+    transpile_types() {
+      return merge([
+        this._find_sources(),
+        this._find_types(),
+        this._find_extras()
+      ]).tsc("tsconfig.json", {
+        noEmit: false,
+        rootDir: this.sourceDir,
+        declaration: true,
+        emitDeclarationOnly: true,
+        outDir: this.destDir
+      });
+    },
+    /** Copy all resources coming alongside our sources */
+    transpile_resources() {
+      return merge([
+        this._find_resources(),
+        this._find_types()
+      ]).copy(this.destDir);
+    },
+    /** Transpile all source code */
+    async transpile() {
+      banner("Transpiling source files");
+      if (isDirectory(this.destDir))
+        await rmrf(this.destDir);
+      return merge([
+        _cjsTranspile ? this.transpile_cjs() : noop(),
+        _esmTranspile ? this.transpile_esm() : noop(),
+        this.transpile_types(),
+        this.transpile_resources()
+      ]);
+    },
+    /* ====================================================================== *
+     * TEST, COVERAGE & LINTING                                               *
+     * ====================================================================== */
+    /** Run test and emit coverage data */
+    async test() {
+      banner("Running tests");
+      if (_coverage && isDirectory(this.coverageDataDir))
+        await rmrf(this.coverageDataDir);
+      await this._find_tests().jasmine({ coverageDir: _coverage ? this.coverageDataDir : void 0 });
+    },
+    /** Run tests (always) and generate a coverage report */
+    async coverage() {
+      let files;
+      try {
+        await this.test();
+      } finally {
+        banner("Preparing coverage report");
+        files = await this._find_sources().coverage(this.coverageDataDir, {
+          reportDir: this.coverageDir,
+          minimumCoverage: _minimumCoverage,
+          minimumFileCoverage: _minimumFileCoverage,
+          optimalCoverage: _optimalCoverage,
+          optimalFileCoverage: _optimalFileCoverage
+        });
+      }
+      return files;
+    },
+    /** Run test and emit coverage data */
+    async lint() {
+      banner("Linting sources");
+      await merge([
+        this._find_sources(),
+        this._find_tests(),
+        this._find_types(),
+        this._find_extras()
+      ]).eslint();
+    },
+    /* ====================================================================== *
+     * PACKAGE.JSON EXPORTS                                                   *
+     * ====================================================================== */
+    /** Inject `exports` into the `package.json` file */
+    async exports() {
+      const files = await this.transpile();
+      banner('Updating exports in "package.json"');
+      return merge([files]).filter(this.exportsGlob, { directory: this.destDir, ignore: "**/*.map" }).exports({
+        cjsExtension: this.cjsExtension,
+        esmExtension: this.esmExtension,
+        packageJson: this.packageJson,
+        outputPackageJson: this.outputPackageJson
+      });
+    },
+    /* ====================================================================== *
+     * DEFAULT: DO EVERYTHING                                                 *
+     * ====================================================================== */
+    /* coverage ignore next */
+    /** Build everything */
+    async default() {
+      if (_parallelize) {
+        await Promise.all([
+          this.transpile(),
+          this.coverage(),
+          // implies "test"
+          this.lint()
+        ]);
+      } else {
+        await this.transpile();
+        await this.coverage();
+        await this.lint();
+      }
+      await this.exports();
+    }
+  });
+}
+function emitBanner(message) {
+  log.notice([
+    "",
+    $gry(`\u2554${"".padStart(60, "\u2550")}\u2557`),
+    `${$gry("\u2551")} ${$wht(message.padEnd(58, " "))} ${$gry("\u2551")}`,
+    $gry(`\u255A${"".padStart(60, "\u2550")}\u255D`),
+    ""
+  ].join("\n"));
+}
+export {
+  tasks
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "mappings": ";AAAA,OAAO;AACP,OAAO;AACP,OAAO;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAAa;AAAA,EAAK;AAAA,EAClB;AAAA,EACA;AAAA,OACK;AACP,OAAO;AAIP,cAAc;AAGd,IAAM,kBAAkC;AAAA,EACtC,UAAU;AAAA,EACV,WAAW;AAAA,EACX,gBAAgB;AAAA,EAChB,SAAS,CAAE,cAAc,CAAE;AAC7B;AAqFO,SAAS,MAAM,UAAwB,CAAC,GAAG;AAChD,QAAM;AAAA,IACJ,WAAW,aAAa;AAAA,IACxB,SAAS,WAAW;AAAA,IACpB,SAAS,WAAW;AAAA,IACpB,aAAa,eAAe;AAAA,IAC5B,iBAAiB,mBAAmB;AAAA,IACpC,eAAe,iBAAiB;AAAA,IAEhC,aAAa,eAAe;AAAA,IAC5B,mBAAmB,qBAAqB;AAAA,IAExC,cAAc,gBAAgB;AAAA,IAC9B,cAAc,gBAAgB;AAAA,IAC9B,cAAc,gBAAgB;AAAA,IAC9B,cAAc,gBAAgB;AAAA,IAE9B,aAAa,eAAe;AAAA,IAC5B,SAAS,WAAW,CAAC;AAAA,IACrB,UAAU,YAAY;AAAA,IACtB,aAAa,eAAe;AAAA,IAC5B,UAAU,YAAY;AAAA,IACtB,iBAAiB,mBAAmB;AAAA,IACpC,qBAAqB,uBAAuB;AAAA,IAC5C,iBAAiB,mBAAmB;AAAA,IACpC,qBAAqB,uBAAuB;AAAA,IAE5C,gBAAgB,kBAAkB,CAAC;AAAA,EACrC,IAAI;AAGJ,QAAM,SAAS,WAAW,aAAa,IAAI,SAAc;AAGzD,QAAM,uBAAuB,OAAO,OAAO,CAAC,GAAG,iBAAiB,eAAe;AAE/E,SAAO,MAAM;AAAA;AAAA,IAEX,WAAW;AAAA;AAAA,IAEX,SAAS;AAAA;AAAA,IAET,SAAS;AAAA;AAAA,IAET,aAAa;AAAA;AAAA,IAEb,iBAAiB;AAAA;AAAA,IAEjB,eAAe;AAAA;AAAA,IAEf,aAAa;AAAA;AAAA,IAEb,mBAAmB;AAAA;AAAA,IAEnB,cAAc;AAAA;AAAA,IAEd,cAAc;AAAA;AAAA,IAEd,UAAU;AAAA;AAAA,IAEV,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,IAOb,oBAA0B;AACxB,aAAO,KAAK,eAAe,EAAE,WAAW,KAAK,WAAW,QAAQ,YAAY,CAAC;AAAA,IAC/E;AAAA;AAAA,IAGA,oBAA0B;AACxB,aAAO,KAAK,eAAe,EAAE,WAAW,KAAK,WAAW,QAAQ,YAAY,CAAC;AAAA,IAC/E;AAAA;AAAA,IAGA,gBAAsB;AACpB,aAAO,MAAM;AAAA,QACX,gBAAgB,KAAK,kBAAkB,IAAI,KAAK;AAAA,QAChD,gBAAgB,KAAK,kBAAkB,IAAI,KAAK;AAAA,MAClD,CAAC;AAAA,IACH;AAAA;AAAA,IAGA,cAAoB;AAClB,aAAO,KAAK,aAAa,EAAE,WAAW,KAAK,UAAU,CAAC;AAAA,IACxD;AAAA;AAAA,IAGA,eAAqB;AACnB,UAAI,CAAE,YAAY,KAAK,aAAa;AAAG,eAAO,KAAK;AACnD,aAAO,KAAK,aAAa,EAAE,WAAW,KAAK,cAAc,CAAC;AAAA,IAC5D;AAAA;AAAA,IAIA,kBAAwB;AACtB,aAAO,KAAK,QAAQ,EAAE,WAAW,KAAK,WAAW,QAAQ,iBAAiB,CAAC;AAAA,IAC7E;AAAA;AAAA,IAGA,cAAoB;AAClB,aAAO,KAAK,KAAK,UAAU,EAAE,WAAW,KAAK,SAAS,QAAQ,YAAY,CAAC;AAAA,IAC7E;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,gBAAsB;AACpB,aAAO,KAAK,kBAAkB,EACzB,QAAQ;AAAA,QACP,GAAG;AAAA,QACH,QAAQ;AAAA,QACR,QAAQ,KAAK;AAAA,QACb,cAAc,EAAE,OAAO,KAAK,aAAa;AAAA,MAC3C,CAAC;AAAA,IACP;AAAA;AAAA,IAGA,gBAAsB;AACpB,aAAO,KAAK,kBAAkB,EACzB,QAAQ;AAAA,QACP,GAAG;AAAA,QACH,QAAQ;AAAA,QACR,QAAQ,KAAK;AAAA,QACb,cAAc,EAAE,OAAO,KAAK,aAAa;AAAA,MAC3C,CAAC;AAAA,IACP;AAAA;AAAA,IAGA,kBAAwB;AACtB,aAAO,MAAM;AAAA,QACX,KAAK,cAAc;AAAA,QACnB,KAAK,YAAY;AAAA,QACjB,KAAK,aAAa;AAAA,MACpB,CAAC,EAAE,IAAI,iBAAiB;AAAA,QACtB,QAAQ;AAAA,QACR,SAAS,KAAK;AAAA,QACd,aAAa;AAAA,QACb,qBAAqB;AAAA,QACrB,QAAQ,KAAK;AAAA,MACf,CAAC;AAAA,IACH;AAAA;AAAA,IAGA,sBAA4B;AAC1B,aAAO,MAAM;AAAA,QACX,KAAK,gBAAgB;AAAA,QACrB,KAAK,YAAY;AAAA,MACnB,CAAC,EAAE,KAAK,KAAK,OAAO;AAAA,IACtB;AAAA;AAAA,IAGA,MAAM,YAA2B;AAC/B,aAAO,0BAA0B;AAEjC,UAAI,YAAY,KAAK,OAAO;AAAG,cAAM,KAAK,KAAK,OAAO;AAEtD,aAAO,MAAM;AAAA,QACX,gBAAgB,KAAK,cAAc,IAAI,KAAK;AAAA,QAC5C,gBAAgB,KAAK,cAAc,IAAI,KAAK;AAAA,QAC5C,KAAK,gBAAgB;AAAA,QACrB,KAAK,oBAAoB;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,MAAM,OAAsB;AAC1B,aAAO,eAAe;AAEtB,UAAI,aAAa,YAAY,KAAK,eAAe;AAAG,cAAM,KAAK,KAAK,eAAe;AAEnF,YAAM,KACD,YAAY,EACZ,QAAQ,EAAE,aAAa,YAAY,KAAK,kBAAkB,OAAU,CAAC;AAAA,IAC5E;AAAA;AAAA,IAGA,MAAM,WAA0B;AAE9B,UAAI;AACJ,UAAI;AACF,cAAM,KAAK,KAAK;AAAA,MAClB,UAAE;AACA,eAAO,2BAA2B;AAClC,gBAAQ,MAAM,KACT,cAAc,EACd,SAAS,KAAK,iBAAiB;AAAA,UAC9B,WAAW,KAAK;AAAA,UAChB,iBAAiB;AAAA,UACjB,qBAAqB;AAAA,UACrB,iBAAiB;AAAA,UACjB,qBAAqB;AAAA,QACvB,CAAC;AAAA,MACP;AAGA,aAAO;AAAA,IACT;AAAA;AAAA,IAGA,MAAM,OAAsB;AAC1B,aAAO,iBAAiB;AAExB,YAAM,MAAM;AAAA,QACV,KAAK,cAAc;AAAA,QACnB,KAAK,YAAY;AAAA,QACjB,KAAK,YAAY;AAAA,QACjB,KAAK,aAAa;AAAA,MACpB,CAAC,EAAE,OAAO;AAAA,IACZ;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,MAAM,UAAyB;AAC7B,YAAM,QAAQ,MAAM,KAAK,UAAU;AAEnC,aAAO,oCAAoC;AAE3C,aAAO,MAAM,CAAE,KAAM,CAAC,EACjB,OAAO,KAAK,aAAa,EAAE,WAAW,KAAK,SAAS,QAAQ,WAAW,CAAC,EACxE,QAAQ;AAAA,QACP,cAAc,KAAK;AAAA,QACnB,cAAc,KAAK;AAAA,QACnB,aAAa,KAAK;AAAA,QAClB,mBAAmB,KAAK;AAAA,MAC1B,CAAC;AAAA,IACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,MAAM,UAAyB;AAC7B,UAAI,cAAc;AAChB,cAAM,QAAQ,IAAI;AAAA,UAChB,KAAK,UAAU;AAAA,UACf,KAAK,SAAS;AAAA;AAAA,UACd,KAAK,KAAK;AAAA,QACZ,CAAC;AAAA,MACH,OAAO;AACL,cAAM,KAAK,UAAU;AACrB,cAAM,KAAK,SAAS;AACpB,cAAM,KAAK,KAAK;AAAA,MAClB;AACA,YAAM,KAAK,QAAQ;AAAA,IACrB;AAAA,EACF,CAAC;AACH;AAIA,SAAS,WAAW,SAAuB;AACzC,MAAI,OAAO;AAAA,IACT;AAAA,IAAI,KAAK,SAAS,GAAG,SAAS,IAAI,QAAQ,SAAS;AAAA,IACnD,GAAG,KAAK,QAAQ,KAAK,KAAK,QAAQ,OAAO,IAAI,GAAG,CAAC,KAAK,KAAK,QAAQ;AAAA,IACnE,KAAK,SAAS,GAAG,SAAS,IAAI,QAAQ,SAAS;AAAA,IAAG;AAAA,EACpD,EAAE,KAAK,IAAI,CAAC;AACd;",
+  "names": []
+}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@plugjs/build",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Simple shared build using PlugJS",
-  "main": "./dist/build.cjs",
-  "module": "./dist/build.mjs",
-  "types": "./dist/build.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/build.d.ts",
-        "default": "./dist/build.mjs"
-      },
       "require": {
-        "types": "./dist/build.d.ts",
-        "default": "./dist/build.cjs"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
       }
     }
   },
@@ -21,15 +21,20 @@
     "bootstrap-plugjs-build": "./dist/bootstrap.mjs"
   },
   "scripts": {
-    "build": "plug"
+    "build": "plug",
+    "coverage": "plug coverage",
+    "dev": "plug coverage -w src -w test",
+    "lint": "plug lint",
+    "test": "plug test",
+    "transpile": "plug transpile"
   },
   "dependencies": {
-    "@plugjs/cov8": "^0.1.2",
-    "@plugjs/eslint": "^0.1.2",
-    "@plugjs/eslint-plugin": "^0.1.1",
-    "@plugjs/jasmine": "^0.1.2",
-    "@plugjs/plug": "^0.1.3",
-    "@plugjs/typescript": "^0.1.2"
+    "@plugjs/cov8": "^0.2.0",
+    "@plugjs/eslint": "^0.2.0",
+    "@plugjs/eslint-plugin": "^0.1.2",
+    "@plugjs/jasmine": "^0.2.0",
+    "@plugjs/plug": "^0.2.0",
+    "@plugjs/typescript": "^0.2.0"
   },
   "files": [
     "*.md",

package/resources/__dot_vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/src/bootstrap.mts

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
-import { build, find, invoke, log, resolve, fs, isFile } from '@plugjs/plug'
+
+/* coverage ignore file // we don't test bootstrapping for now */
+import { build, find, fs, isFile, log, resolve } from '@plugjs/plug'
 import { $p } from '@plugjs/plug/logging'
 
 const tasks = build({
@@ -7,7 +9,11 @@ const tasks = build({
   async bootstrap_resources(): Promise<void> {
     const pipe = find('**/*', '**/.*', { directory: '@../resources' })
     const sources = await pipe
-    const targets = await pipe.copy('.', { overwrite })
+    const targets = await pipe.copy('.', {
+      // it seems NPM has _some_ problems with some dotfiles (e.g. .gitignore)
+      rename: (relative) => relative.replaceAll(/(^|\/)__dot_/g, '$1.'),
+      overwrite,
+    })
 
     log('Bootstrapped', targets.length, 'of', sources.length, 'files:')
     for (const file of targets.absolutePaths()) log(`    ${$p(file)}`)
@@ -33,19 +39,30 @@ const tasks = build({
     // Merge package contents
     log(`Updating ${$p(targetPackage)}`)
 
-    if (! targetJson.scripts?.build) {
-      targetJson.scripts = Object.assign({}, targetJson.scripts, {
-        build: 'plug',
-      })
+    // Default scripts
+    targetJson.scripts = {
+      build: 'plug',
+      coverage: 'plug coverage',
+      dev: 'plug coverage -w src -w test',
+      lint: 'plug lint',
+      test: 'plug test',
+      transpile: 'plug transpile',
+      ...targetJson.scripts,
     }
 
-    targetJson.devDependencies = Object.assign({}, targetJson.devDependencies, {
+    // Exported/packaged files
+    const targetFiles = new Set([ ...(targetJson.files || []), '*.md', 'dist/', 'src/' ])
+    targetJson.files = [ ...targetFiles ].sort()
+
+    // *DEV* dependency on this build
+    targetJson.devDependencies = {
+      ...targetJson.devDependencies,
       [buildJson.name]: `^${buildJson.version}`,
-    })
+    }
 
     // Overwrite taget package.json file
     log(`Writing ${$p(targetPackage)}`)
-    await fs.writeFile(targetPackage, JSON.stringify(targetJson, null, 2), 'utf-8')
+    await fs.writeFile(targetPackage, JSON.stringify(targetJson, null, 2) + '\n', 'utf-8')
   },
 
   /** Bootstrap the project */
@@ -57,4 +74,4 @@ const tasks = build({
 })
 
 const overwrite = process.argv[2] === '--overwrite' ? 'overwrite' : 'skip'
-invoke(tasks, 'bootstrap', { overwrite }).catch(log.error)
+tasks.bootstrap({ overwrite }).catch(log.error)