@travetto/pack 2.2.1 → 2.2.4

package/bin/cli-pack.ts

@@ -1,10 +1,10 @@
-import { BaseOptions, BasePackPlugin } from './pack-base';
+import { BaseOptions, BasePackCommand } from './pack-base';
 import { Pack, AllConfig } from './operation/pack';
 
-export class PackPlugin extends BasePackPlugin<BaseOptions, AllConfig> {
+export class PackCommand extends BasePackCommand<BaseOptions, AllConfig> {
   operation = Pack;
 
   getOptions(): BaseOptions {
-    return this.defaultOptions();
+    return this.commonOptions();
   }
 }

package/bin/cli-pack_assemble.ts

@@ -1,6 +1,6 @@
-import { OptionConfig } from '@travetto/cli/src/plugin-base';
+import { OptionConfig } from '@travetto/cli/src/command';
 
-import { BaseOptions, BasePackPlugin } from './pack-base';
+import { BaseOptions, BasePackCommand } from './pack-base';
 import { Assemble, AssembleConfig } from './operation/assemble';
 
 type Options = BaseOptions & {
@@ -8,12 +8,12 @@ type Options = BaseOptions & {
   readonly: OptionConfig<boolean>;
 };
 
-export class PackAssemblePlugin extends BasePackPlugin<Options, AssembleConfig> {
+export class PackAssembleCommand extends BasePackCommand<Options, AssembleConfig> {
   operation = Assemble;
 
   getOptions(): Options {
     return {
-      ...this.defaultOptions(),
+      ...this.commonOptions(),
       keepSource: this.boolOption({ desc: 'Should source be preserved' }),
       readonly: this.boolOption({ desc: 'Build a readonly deployable' })
     };

package/bin/cli-pack_docker-export.ts

@@ -1,17 +1,17 @@
 import * as fs from 'fs/promises';
 
 import { FsUtil, PathUtil } from '@travetto/boot';
-import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
+import { CliCommand, OptionConfig, ListOptionConfig } from '@travetto/cli/src/command';
 
 type Options = {
   app: OptionConfig<string>;
   image: OptionConfig<string>;
   port: OptionConfig<number>;
-  add: OptionConfig<string[]>;
+  add: ListOptionConfig<string>;
   output: OptionConfig<string>;
 };
 
-export class PackDockerExportPlugin extends BasePlugin<Options> {
+export class PackDockerExportCommand extends CliCommand<Options> {
 
   name = 'pack:docker-export';
 

package/bin/cli-pack_docker.ts

@@ -1,23 +1,23 @@
-import { OptionConfig } from '@travetto/cli/src/plugin-base';
+import { OptionConfig, ListOptionConfig } from '@travetto/cli/src/command';
 
-import { BaseOptions, BasePackPlugin } from './pack-base';
+import { BaseOptions, BasePackCommand } from './pack-base';
 import { Docker, DockerConfig } from './operation/docker';
 
 type Options = BaseOptions & {
   image: OptionConfig<string>;
   name: OptionConfig<string>;
-  tag: OptionConfig<string[]>;
-  port: OptionConfig<string[]>;
+  tag: ListOptionConfig<string>;
+  port: ListOptionConfig<string>;
   push: OptionConfig<boolean>;
   registry: OptionConfig<string>;
 };
 
-export class PackDockerPlugin extends BasePackPlugin<Options, DockerConfig> {
+export class PackDockerCommand extends BasePackCommand<Options, DockerConfig> {
   operation = Docker;
 
   getOptions(): Options {
     return {
-      ...this.defaultOptions(),
+      ...this.commonOptions(),
       image: this.option({ desc: 'Docker Image to extend' }),
       name: this.option({ desc: 'Image Name' }),
       tag: this.listOption({ desc: 'Image Tag' }),

package/bin/cli-pack_zip.ts

@@ -1,18 +1,18 @@
-import { OptionConfig } from '@travetto/cli/src/plugin-base';
+import { OptionConfig } from '@travetto/cli/src/command';
 
-import { BaseOptions, BasePackPlugin } from './pack-base';
+import { BaseOptions, BasePackCommand } from './pack-base';
 import { Zip, ZipConfig } from './operation/zip';
 
 type Options = BaseOptions & {
   output: OptionConfig<string>;
 };
 
-export class PackZipPlugin extends BasePackPlugin<Options, ZipConfig> {
+export class PackZipCommand extends BasePackCommand<Options, ZipConfig> {
   operation = Zip;
 
   getOptions(): Options {
     return {
-      ...this.defaultOptions(),
+      ...this.commonOptions(),
       output: this.option({ desc: 'Output File' })
     };
   }

package/bin/lib/assemble.ts

@@ -18,13 +18,30 @@ export class AssembleUtil {
    */
   static async cleanCache(cache: string): Promise<void> {
     for (const el of await fs.readdir(cache)) {
-      if (el.endsWith('.ts')) {
+      if (el.endsWith('.ts') || el.endsWith('.js')) {
         const content = (await fs.readFile(`${cache}/${el}`, 'utf8')).replace(/\/\/# sourceMap.*/g, '');
         await fs.writeFile(`${cache}/${el}`, content);
       }
     }
   }
 
+  /**
+   * Minimize cached source files, by removing source mapping info
+   */
+  static async cleanBoot(ws: string): Promise<void> {
+    for (const el of await ScanFs.scanDir({
+      testFile: f => f.endsWith('.js') || f.endsWith('.d.ts'),
+      testDir: x => true
+    }, `${ws}/node_modules/@travetto/boot`)) {
+      if (el.file.endsWith('.d.ts')) {
+        await fs.writeFile(el.file, '');
+      } else if (el.file.endsWith('.js')) {
+        const content = (await fs.readFile(el.file, 'utf8')).replace(/\/\/# sourceMap.*/g, '');
+        await fs.writeFile(el.file, content);
+      }
+    }
+  }
+
   /**
    * Truncate all app source files, and framework source files
    */

package/bin/lib/types.ts

@@ -10,8 +10,10 @@ export type CommonConfig = {
 export type PackOperation<T extends CommonConfig> = {
   key: string;
   title: string;
+  defaults?: Partial<T>;
   overrides?: Partial<T>;
-  extend(a: T, b: Partial<T>): T;
+  extend?(src: Partial<T>, dest: Partial<T>): Partial<T>;
   context(cfg: T): Promise<string> | string;
   exec(cfg: T): AsyncGenerator<string>;
+  buildConfig(configs: Partial<T>[]): T;
 };

package/bin/lib/util.ts

@@ -17,15 +17,34 @@ export class PackUtil {
 
   static #modes: Partial<CommonConfig>[];
 
-  static commonExtend<T extends CommonConfig>(a: T, b: Partial<T>): T {
+  /**
+   * Build configuration object for an operation with a set of configs
+   */
+  static buildConfig<T extends CommonConfig>(
+    op: { defaults?: Partial<T>, overrides?: Partial<T>, extend?(src: Partial<T>, dest: Partial<T>): Partial<T> },
+    configs: Partial<T>[]
+  ): T {
+    const inputs = [
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      op.defaults ?? {} as Partial<T>,
+      ...configs,
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      op.overrides ?? {} as Partial<T>
+    ].filter(x => Object.keys(x).length > 0);
+
+    const res = inputs.reduce((out: Partial<T>, config: Partial<T>): Partial<T> => {
+      const final = {
+        active: config.active ?? out.active,
+        workspace: config.workspace ?? out.workspace,
+        preProcess: [...(config.preProcess ?? []), ...(out.preProcess ?? [])],
+        postProcess: [...(config.postProcess ?? []), ...(out.postProcess ?? [])],
+        ...op.extend?.(config, out)
+      };
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      return final as Partial<T>;
+    }, {});
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const out = {
-      active: b.active ?? a.active,
-      workspace: b.workspace ?? a.workspace,
-      preProcess: [...(b.preProcess ?? []), ...(a.preProcess ?? [])],
-      postProcess: [...(b.postProcess ?? []), ...(a.postProcess ?? [])],
-    } as unknown as T;
-    return out;
+    return res as T;
   }
 
   /**
@@ -123,7 +142,8 @@ export class PackUtil {
     async function runPhase(phase: 'preProcess' | 'postProcess'): Promise<void> {
       for (const el of cfg[phase] ?? []) {
         const [name, fn] = Object.entries(el)[0];
-        await stdout(name);
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        await stdout(name as string);
         await fn(cfg);
       }
     }

package/bin/operation/assemble.ts

@@ -23,28 +23,30 @@ export const Assemble: PackOperation<AssembleConfig> = {
   key: 'assemble',
   title: 'Assembling',
   context(cfg: AssembleConfig) {
-    return `[readonly=${cfg.readonly},cache=${cfg.cacheDir}]`;
+    return `[readonly=${cfg.readonly},cache=${cfg.cacheDir},source=${cfg.keepSource}]`;
   },
   overrides: {
     keepSource: CliUtil.toBool(process.env.PACK_ASSEMBLE_KEEP_SOURCE),
     readonly: CliUtil.toBool(process.env.PACK_ASSEMBLE_READONLY)
   },
-  extend(a: AssembleConfig, b: Partial<AssembleConfig>) {
+  extend(src: Partial<AssembleConfig>, dest: Partial<AssembleConfig>): Partial<AssembleConfig> {
     return {
-      ...PackUtil.commonExtend(a, b),
-      keepSource: b.keepSource ?? a.keepSource,
-      readonly: b.readonly ?? a.readonly,
-      cacheDir: b.cacheDir ?? a.cacheDir,
-      add: [...(b.add ?? []), ...(a.add ?? [])],
-      exclude: [...(b.exclude ?? []), ...(a.exclude ?? [])],
-      excludeCompile: [...(b.excludeCompile ?? []), ...(a.excludeCompile ?? [])],
-      env: { ...(b.env ?? {}), ...(a.env ?? {}) },
+      keepSource: src.keepSource ?? dest.keepSource,
+      readonly: src.readonly ?? dest.readonly,
+      cacheDir: src.cacheDir ?? dest.cacheDir,
+      add: [...(src.add ?? []), ...(dest.add ?? [])],
+      exclude: [...(src.exclude ?? []), ...(dest.exclude ?? [])],
+      excludeCompile: [...(src.excludeCompile ?? []), ...(dest.excludeCompile ?? [])],
+      env: { ...(src.env ?? {}), ...(dest.env ?? {}) },
     };
   },
+  buildConfig(configs: Partial<AssembleConfig>[]): AssembleConfig {
+    return PackUtil.buildConfig(this, configs);
+  },
   /**
    * Assemble the project into a workspace directory, optimized for space and runtime
    */
-  async* exec({ workspace, cacheDir, add, exclude, excludeCompile, env, keepSource, readonly }: AssembleConfig) {
+  async * exec({ workspace, cacheDir, add, exclude, excludeCompile, env, keepSource, readonly }: AssembleConfig) {
     const fullCacheDir = PathUtil.resolveUnix(workspace!, cacheDir);
     const ws = PathUtil.resolveUnix(workspace!);
 
@@ -63,6 +65,7 @@ export const Assemble: PackOperation<AssembleConfig> = {
     });
 
     if (!keepSource) {
+      yield 'Clean Boot'; await AssembleUtil.cleanBoot(ws);
       yield 'Remove Source Maps'; await AssembleUtil.cleanCache(fullCacheDir);
       yield 'Emptying .ts Files'; await AssembleUtil.purgeSource([`${ws}/node_modules/@travetto`, `${ws}/src`]);
     }

package/bin/operation/docker.ts

@@ -34,6 +34,12 @@ export const Docker: PackOperation<DockerConfig> = {
   context(cfg: DockerConfig) {
     return `[image=${cfg.image}, port=${cfg.port}]`;
   },
+  defaults: {
+    name: Package.name.replace('@', ''),
+    builder: dockerFileBuilder,
+    port: [],
+    tag: ['latest']
+  },
   overrides: {
     image: process.env.PACK_DOCKER_IMAGE || undefined,
     name: process.env.PACK_DOCKER_NAME || undefined,
@@ -43,20 +49,22 @@ export const Docker: PackOperation<DockerConfig> = {
     push: CliUtil.toBool(process.env.PACK_DOCKER_PUSH),
     tag: process.env.PACK_DOCKER_TAG ? [process.env.PACK_DOCKER_TAG] : undefined
   },
-  extend(a: DockerConfig, b: Partial<DockerConfig>) {
+  extend(src: Partial<DockerConfig>, dest: Partial<DockerConfig>): Partial<DockerConfig> {
     return {
-      ...PackUtil.commonExtend(a, b),
-      image: b.image ?? a.image,
-      app: b.app ?? a.app,
-      name: b.name ?? a.name ?? Package.name.replace('@', ''),
-      builder: b.builder ?? a.builder ?? dockerFileBuilder,
-      tag: b.tag ?? a.tag ?? ['latest'],
-      port: b.port ?? a.port ?? [],
-      registry: b.registry ?? a.registry,
-      env: { ...(b.env ?? {}), ...a.env },
-      push: b.push ?? a.push
+      image: src.image ?? dest.image,
+      app: src.app ?? dest.app,
+      name: src.name ?? dest.name,
+      builder: src.builder ?? dest.builder,
+      tag: src.tag ?? dest.tag,
+      port: src.port ?? dest.port,
+      registry: src.registry ?? dest.registry,
+      env: { ...(src.env ?? {}), ...(dest.env ?? {}) },
+      push: src.push ?? dest.push
     };
   },
+  buildConfig(configs: Partial<DockerConfig>[]): DockerConfig {
+    return PackUtil.buildConfig(this, configs);
+  },
   /**
   * Dockerize workspace with flags
   */

package/bin/operation/pack.ts

@@ -31,13 +31,13 @@ type DefaultOpType = ['assemble', typeof Assemble];
 export const Pack: PackOperation<AllConfig> = {
   key: '',
   title: 'Packing',
-  extend(a: AllConfig, b: Partial<AllConfig>) {
+  buildConfig(configs: Partial<AllConfig>[]): AllConfig {
     const ret: Partial<AllConfig> = {
-      workspace: b.workspace ?? a.workspace,
+      workspace: configs[0].workspace,
     };
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     for (const [k, op] of (Object.entries(ops) as DefaultOpType[])) {
-      ret[k] = op.extend(op.extend(a[k] ?? {}, b[k] ?? {}), op.overrides ?? {});
+      ret[k] = op.buildConfig(configs.map(config => config[k] ?? {}));
     }
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return ret as AllConfig;

package/bin/operation/zip.ts

@@ -1,7 +1,7 @@
 import * as path from 'path';
 import * as fs from 'fs/promises';
 
-import { ExecUtil, PathUtil } from '@travetto/boot';
+import { ExecUtil, FsUtil, PathUtil } from '@travetto/boot';
 import { color } from '@travetto/cli/src/color';
 
 import { CommonConfig, PackOperation } from '../lib/types';
@@ -20,22 +20,24 @@ export const Zip: PackOperation<ZipConfig> = {
   overrides: {
     output: process.env.PACK_ZIP_OUTPUT || undefined
   },
-  extend(a: ZipConfig, b: Partial<ZipConfig>) {
-    return {
-      ...PackUtil.commonExtend(a, b),
-      output: b.output ?? a.output
-    };
+  extend(src: Partial<ZipConfig>, dest: Partial<ZipConfig>): Partial<ZipConfig> {
+    return { output: src.output ?? dest.output };
+  },
+  buildConfig(configs: Partial<ZipConfig>[]): ZipConfig {
+    return PackUtil.buildConfig(this, configs);
   },
   /**
   * Zip workspace with flags
   */
-  async* exec({ workspace, output }: ZipConfig) {
+  async * exec({ workspace, output }: ZipConfig) {
     const ws = PathUtil.resolveUnix(workspace);
     const zipFile = PathUtil.resolveUnix(output);
 
     yield 'Preparing Target';
     await fs.mkdir(path.dirname(zipFile), { recursive: true });
-    await fs.unlink(zipFile); // Unlink
+    if (await FsUtil.exists(zipFile)) {
+      await fs.unlink(zipFile); // Unlink
+    }
 
     yield 'Compressing';
     if (/win/i.test(process.platform)) {

package/bin/pack-base.ts

@@ -1,6 +1,6 @@
 import * as os from 'os';
 
-import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
+import { CliCommand, OptionConfig } from '@travetto/cli/src/command';
 import { color } from '@travetto/cli/src/color';
 import { PathUtil, Package, FsUtil } from '@travetto/boot';
 
@@ -19,7 +19,7 @@ export type BaseOptions = {
 /**
  * Supports packing a project into a directory, ready for archiving
  */
-export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConfig> extends BasePlugin<V> {
+export abstract class BasePackCommand<V extends BaseOptions, C extends CommonConfig> extends CliCommand<V> {
 
   /**
    * Package stage name
@@ -30,7 +30,7 @@ export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConf
     return this.operation.key ? `pack:${this.operation.key}` : 'pack';
   }
 
-  defaultOptions(): BaseOptions {
+  commonOptions(): BaseOptions {
     return { workspace: this.option({ desc: 'Working directory' }) } as const;
   }
 
@@ -45,14 +45,17 @@ export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConf
       this.showHelp(`Unknown config mode: ${this.args[0]}`);
     }
     const def = list.find(c => c.name === 'default');
-    const out = [def, cfg, extra]
+    const configs = [def, cfg, extra]
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      .map(x => this.operation.key && this.operation.key in (x ?? {}) ? ((x as Record<string, C>)[this.operation.key] as C) : x as C)
+      .map(x => this.operation.key && this.operation.key in (x ?? {}) ? ((x as Record<string, C>)[this.operation.key] as C) : x as C);
+
+    return this.operation.buildConfig([
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      { workspace: PathUtil.resolveUnix(os.tmpdir(), packName) } as C,
+      ...configs,
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      .reduce<C>((acc, l) => this.operation.extend(acc, l ?? {}), (this.operation.overrides ?? {}) as C);
-    out.workspace ??= PathUtil.resolveUnix(os.tmpdir(), packName);
-    out.active = true;
-    return out;
+      { active: true } as C
+    ]);
   }
 
   getArgs(): string {
@@ -62,7 +65,7 @@ export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConf
   async help(): Promise<string> {
     const lines = await PackUtil.modeList();
 
-    const out = [];
+    const out: string[] = [];
     if (lines.length) {
       out.push('', color`${{ title: 'Available Pack Modes:' }}`);
       for (const { name, file } of lines) {
@@ -78,7 +81,7 @@ export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConf
   }
 
   async action(): Promise<void> {
-    const resolved: C = await this.resolveConfigs();
+    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.2.1",
+  "version": "2.2.4",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -25,12 +25,12 @@
     "directory": "module/pack"
   },
   "dependencies": {
-    "@travetto/base": "^2.2.1",
+    "@travetto/base": "^2.2.4",
     "@types/picomatch": "^2.3.0",
     "picomatch": "^2.3.1"
   },
   "optionalPeerDependencies": {
-    "@travetto/cli": "^2.2.1"
+    "@travetto/cli": "^2.2.4"
   },
   "docDependencies": {
     "@travetto/rest": true

package/support/pack.config.ts

@@ -39,6 +39,7 @@ export const config: AllConfigPartial = {
       '.npmignore',
       '.*.yml',
       'cache/compiler.*.log',
+      mod('faker'),
       mod('lodash/lodash.min.js'),
       mod('source-map-support/node_modules/source-map'),
       mod('source-map-support/browser-source-map-support.js'),