@travetto/pack 2.0.8 → 2.1.0

package/README.md

@@ -17,7 +17,7 @@ $ trv pack --help
 Usage:  pack [options] [mode]
 
 Options:
-  -w, --workspace <workspace>  Working directory (default: "/tmp/pack_travetto_pack")
+  -w, --workspace <workspace>  Working directory
   -h, --help                   display help for command
 
 Available Pack Modes:
@@ -61,13 +61,13 @@ assemble: {
       TRV_DYNAMIC: '0'
     },
     add: [
-      { 'node_modules/@travetto/cli/bin/trv.js': 'node_modules/.bin/trv' },
-      { 'node_modules/lodash/lodash.min.js': 'node_modules/lodash/lodash.js' },
+      { [mod('@travetto/cli/bin/trv.js')]: mod('.bin/trv') },
+      { [mod('lodash/lodash.min.js')]: mod('lodash/lodash.js') },
     ],
     excludeCompile: [
-      'node_modules/@travetto/*/doc/',
-      'node_modules/@travetto/*/e2e/',
-      'node_modules/@travetto/*/test/',
+      mod('@travetto/*/doc/'),
+      mod('@travetto/*/e2e/'),
+      mod('@travetto/*/test/'),
     ],
     exclude: [
       'bower.json',
@@ -78,7 +78,7 @@ assemble: {
       '*.lock',
       '*.html',
       '*.mjs',
-      'node_modules/**/*.ts',
+      mod('**/*.ts'),
       '*.d.ts',
 ```
 
@@ -89,10 +89,10 @@ $ trv pack:assemble --help
 Usage:  pack:assemble [options] [mode]
 
 Options:
-  -w, --workspace <workspace>      Working directory (default: "/tmp/pack_travetto_pack")
-  -k, --keep-source <keep-source>  Should source be preserved (default: true)
-  -r, --readonly <readonly>        Build a readonly deployable (default: true)
-  -h, --help                       display help for command
+  -w, --workspace <workspace>  Working directory
+  -k, --keep-source            Should source be preserved
+  -r, --readonly               Build a readonly deployable
+  -h, --help                   display help for command
 
 Available Pack Modes:
   * default [support/pack.config.ts]
@@ -119,8 +119,8 @@ $ trv pack:zip --help
 Usage:  pack:zip [options] [mode]
 
 Options:
-  -w, --workspace <workspace>  Working directory (default: "/tmp/pack_travetto_pack")
-  -o, --output <output>        Output File (default: "output.zip")
+  -w, --workspace <workspace>  Working directory
+  -o, --output <output>        Output File
   -h, --help                   display help for command
 
 Available Pack Modes:
@@ -148,12 +148,12 @@ $ trv pack:docker --help
 Usage:  pack:docker [options] [mode]
 
 Options:
-  -w, --workspace <workspace>  Working directory (default: "/tmp/pack_travetto_pack")
-  -i, --image <image>          Docker Image to extend (default: "node:16-alpine")
-  -n, --name <name>            Image Name (default: "travetto/pack")
-  -t, --tag <tag>              Image Tag (default: ["latest"])
+  -w, --workspace <workspace>  Working directory
+  -i, --image <image>          Docker Image to extend
+  -n, --name <name>            Image Name
+  -t, --tag <tag>              Image Tag (default: [])
   -p, --port <port>            Image Port (default: [])
-  -x, --push <push>            Push Tags (default: true)
+  -x, --push                   Push Tags
   -r, --registry <registry>    Registry
   -h, --help                   display help for command
 
@@ -171,7 +171,7 @@ Various modules may provide customizations to the default `pack.config.ts` to al
 import * as fs from 'fs';
 
 import { PathUtil } from '@travetto/boot';
-import type { AllConfigPartial, AssembleConfig } from '@travetto/pack';
+import type { AllConfigPartial } from '@travetto/pack';
 
 export const config: AllConfigPartial = {
   name: 'rest/aws-lambda',
@@ -185,7 +185,7 @@ export const config: AllConfigPartial = {
       NO_COLOR: '1'
     },
     postProcess: [{
-      'Lambda Entrypoint': (cfg: AssembleConfig) =>
+      ['Lambda Entrypoint']: cfg =>
         fs.promises.copyFile(
           PathUtil.resolveUnix(__dirname, 'aws-lambda.handler.js'),
           PathUtil.resolveUnix(cfg.workspace, 'index.js')

package/bin/cli-pack_docker-export.ts

@@ -1,7 +1,8 @@
-import { FsUtil, PathUtil } from '@travetto/boot/src';
-import { BasePlugin } from '@travetto/cli/src/plugin-base';
 import * as fs from 'fs';
 
+import { FsUtil, PathUtil } from '@travetto/boot';
+import { BasePlugin } from '@travetto/cli/src/plugin-base';
+
 export class PackDockerExportPlugin extends BasePlugin {
 
   name = 'pack:docker-export';
@@ -16,7 +17,7 @@ export class PackDockerExportPlugin extends BasePlugin {
     };
   }
 
-  async action(...args: any[]) {
+  async action(...args: unknown[]) {
     const files = ['src', 'bin', 'support', 'resources', 'package.json', 'package-lock.json', ...this.cmd.add]
       .filter(x => FsUtil.existsSync(PathUtil.resolveUnix(x)));
 

package/bin/lib/util.ts

@@ -15,7 +15,6 @@ import { CommonConfig, PackOperation } from './types';
  */
 export class PackUtil {
 
-  static #defaultConfigs: Partial<CommonConfig>[];
   static #modes: Partial<CommonConfig>[];
 
   static commonExtend<T extends CommonConfig>(a: T, b: Partial<T>): T {
@@ -44,17 +43,6 @@ export class PackUtil {
     return this.#modes;
   }
 
-  /**
-   * Get Config
-   */
-  static async getConfigs(): Promise<Partial<CommonConfig>[]> {
-    if (!this.#defaultConfigs) {
-      const allModes = await this.modeList();
-      const mode = allModes.find(x => process.argv.find(a => a === x.name))!;
-      this.#defaultConfigs = [allModes.find(x => x.name === 'default')!, mode!];
-    }
-    return this.#defaultConfigs;
-  }
 
   /**
    * Build file include/exclude lists/checker

package/bin/operation/pack.ts

@@ -9,6 +9,7 @@ import { Zip, ZipConfig } from './zip';
 type DeepPartial<T> = {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [P in keyof T]?: (T[P] extends (number | string | boolean | undefined | RegExp | ((...args: any[]) => any)) ?
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (T[P] | undefined) : (T[P] extends any[] ? DeepPartial<T[P][number]>[] : DeepPartial<T[P]>));
 };
 
@@ -33,11 +34,8 @@ export const Pack: PackOperation<AllConfig> = {
       workspace: b.workspace ?? a.workspace,
     };
     for (const [k, op] of Object.entries(ops) as ['assemble', typeof Assemble][]) {
-      // @ts-ignore
-      ret[k] = op.extend(a[k] ?? {}, op.extend(b[k] ?? {}, op.overrides ?? {}));
-      ret[k]!.workspace = ret.workspace!;
+      ret[k] = op.extend(op.extend(a[k] ?? {}, b[k] ?? {}), op.overrides ?? {});
     }
-
     return ret as AllConfig;
   },
   async context(cfg: AllConfig) {
@@ -50,6 +48,7 @@ export const Pack: PackOperation<AllConfig> = {
     }
     for (const [step, op] of steps) {
       process.stdout.write('\n');
+      cfg[step as 'assemble'].workspace = cfg.workspace;
       await PackUtil.runOperation(op as typeof Assemble, cfg[step as 'assemble'], 2);
     }
     process.stdout.write('\n');

package/bin/pack-base.ts

@@ -30,10 +30,20 @@ export abstract class BasePackPlugin<C extends CommonConfig> extends BasePlugin
     return { workspace: this.option({ desc: 'Working directory' }) } as const;
   }
 
-  async resolveConfigs(extra: Partial<C> | Record<string, C> = {}): Promise<C> {
-    const out: C = [...(await PackUtil.getConfigs()), extra]
+  async resolveConfigs(): Promise<C> {
+    const extra = this.operation.key ? { [this.operation.key]: this.cmd } : this.cmd;
+    const list = (await PackUtil.modeList());
+    if (!this.args[0]) {
+      this.showHelp('Missing config mode');
+    }
+    const cfg = list.find(c => c.name === this.args[0]);
+    if (!cfg) {
+      this.showHelp(`Unknown config mode: ${this.args[0]}`);
+    }
+    const def = list.find(c => c.name === 'default');
+    const out: C = [def, cfg, extra]
       .map(x => this.operation.key && this.operation.key in (x ?? {}) ? ((x as Record<string, C>)[this.operation.key] as C) : x as C)
-      .reduce((acc, l) => this.operation.extend(acc, l ?? {}), this.operation.extend({} as C, this.operation.overrides ?? {}));
+      .reduce((acc, l) => this.operation.extend(acc, l ?? {}), (this.operation.overrides ?? {}) as C);
     out.workspace ??= PathUtil.resolveUnix(os.tmpdir(), packName);
     out.active = true;
     return out;
@@ -43,17 +53,6 @@ export abstract class BasePackPlugin<C extends CommonConfig> extends BasePlugin
     return '[mode]';
   }
 
-  override async finalizeOptions() {
-    const flags = await this.resolveConfigs();
-    const opts = await super.finalizeOptions();
-    for (const el of opts) {
-      if (el.key! in flags) {
-        el.def = flags[el.key! as keyof C];
-      }
-    }
-    return opts;
-  }
-
   async help() {
     const lines = await PackUtil.modeList();
 
@@ -73,7 +72,7 @@ export abstract class BasePackPlugin<C extends CommonConfig> extends BasePlugin
   }
 
   async action() {
-    const resolved = await this.resolveConfigs(this.operation.key ? { [this.operation.key]: this.cmd } : this.cmd);
+    const resolved = await this.resolveConfigs();
     if (await FsUtil.exists(PathUtil.resolveUnix(resolved.workspace, '.git'))) {
       throw new Error('Refusing to use workspace with a .git directory');
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/pack",
   "displayName": "Pack",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -25,12 +25,12 @@
     "directory": "module/pack"
   },
   "dependencies": {
-    "@travetto/base": "^2.0.2",
-    "@types/picomatch": "^2.2.4",
-    "picomatch": "^2.3.0"
+    "@travetto/base": "^2.1.0",
+    "@types/picomatch": "^2.3.0",
+    "picomatch": "^2.3.1"
   },
   "optionalPeerDependencies": {
-    "@travetto/cli": "^2.0.3"
+    "@travetto/cli": "^2.1.0"
   },
   "docDependencies": {
     "@travetto/rest": true

package/support/pack.config.ts

@@ -1,5 +1,7 @@
 import { AllConfigPartial } from '../bin/operation/pack';
 
+const mod = (f: string) => `node_modules/${f}`;
+
 export const config: AllConfigPartial = {
   name: 'default',
   assemble: {
@@ -11,13 +13,13 @@ export const config: AllConfigPartial = {
       TRV_DYNAMIC: '0'
     },
     add: [
-      { 'node_modules/@travetto/cli/bin/trv.js': 'node_modules/.bin/trv' },
-      { 'node_modules/lodash/lodash.min.js': 'node_modules/lodash/lodash.js' },
+      { [mod('@travetto/cli/bin/trv.js')]: mod('.bin/trv') },
+      { [mod('lodash/lodash.min.js')]: mod('lodash/lodash.js') },
     ],
     excludeCompile: [
-      'node_modules/@travetto/*/doc/',
-      'node_modules/@travetto/*/e2e/',
-      'node_modules/@travetto/*/test/',
+      mod('@travetto/*/doc/'),
+      mod('@travetto/*/e2e/'),
+      mod('@travetto/*/test/'),
     ],
     exclude: [
       'bower.json',
@@ -28,7 +30,7 @@ export const config: AllConfigPartial = {
       '*.lock',
       '*.html',
       '*.mjs',
-      'node_modules/**/*.ts',
+      mod('**/*.ts'),
       '*.d.ts',
       '*.tsbuildinfo',
       '*.java',
@@ -37,17 +39,17 @@ export const config: AllConfigPartial = {
       '.npmignore',
       '.*.yml',
       'cache/compiler.*.log',
-      'node_modules/lodash/lodash.min.js',
-      'node_modules/source-map-support/node_modules/source-map',
-      'node_modules/source-map-support/browser-source-map-support.js',
-      'node_modules/bson/browser_build/',
-      'node_modules/**/tsconfig.json',
-      'node_modules/**/tsconfig.*.json',
-      'node_modules/@travetto/*/doc.ts',
-      'node_modules/typescript/',
-      'node_modules/@types/',
-      '^./node_modules/@travetto/**/*.ts',
-      '^./node_modules/@travetto/boot/tsconfig.trv.json',
+      mod('lodash/lodash.min.js'),
+      mod('source-map-support/node_modules/source-map'),
+      mod('source-map-support/browser-source-map-support.js'),
+      mod('bson/browser_build/'),
+      mod('**/tsconfig.json'),
+      mod('**/tsconfig.*.json'),
+      mod('@travetto/*/doc.ts'),
+      mod('typescript/'),
+      mod('@types/'),
+      `^./${mod('@travetto/**/*.ts')}`,
+      `^./${mod('@travetto/boot/tsconfig.trv.json')}`,
       '^./resources/',
       '^./src/',
     ]