@travetto/pack 2.2.4 → 3.0.0-rc.0

package/README.md

@@ -22,8 +22,8 @@ Options:
 
 Available Pack Modes:
   * default [support/pack.config.ts]
-  * rest/aws-lambda [@travetto/rest/support/pack.aws-lambda.ts]
   * rest/docker [@travetto/rest/support/pack.docker.ts]
+  * rest-aws-lambda/main [@travetto/rest-aws-lambda/support/pack.aws-lambda.ts]
 ```
 
 This command line operation will compile your project, and produce a ready to use workspace as a deliverable. The pack operation is actually a wrapper around multiple sub-operations that are run in series to produce the desired final structure for deployment.  The currently support operations are:
@@ -96,8 +96,8 @@ Options:
 
 Available Pack Modes:
   * default [support/pack.config.ts]
-  * rest/aws-lambda [@travetto/rest/support/pack.aws-lambda.ts]
   * rest/docker [@travetto/rest/support/pack.docker.ts]
+  * rest-aws-lambda/main [@travetto/rest-aws-lambda/support/pack.aws-lambda.ts]
 ```
 
 ### CLI - pack:zip
@@ -125,8 +125,8 @@ Options:
 
 Available Pack Modes:
   * default [support/pack.config.ts]
-  * rest/aws-lambda [@travetto/rest/support/pack.aws-lambda.ts]
   * rest/docker [@travetto/rest/support/pack.docker.ts]
+  * rest-aws-lambda/main [@travetto/rest-aws-lambda/support/pack.aws-lambda.ts]
 ```
 
 ### CLI - pack:docker
@@ -159,8 +159,8 @@ Options:
 
 Available Pack Modes:
   * default [support/pack.config.ts]
-  * rest/aws-lambda [@travetto/rest/support/pack.aws-lambda.ts]
   * rest/docker [@travetto/rest/support/pack.docker.ts]
+  * rest-aws-lambda/main [@travetto/rest-aws-lambda/support/pack.aws-lambda.ts]
 ```
 
 ### Modes
@@ -174,7 +174,7 @@ import { PathUtil } from '@travetto/boot';
 import type { AllConfigPartial } from '@travetto/pack';
 
 export const config: AllConfigPartial = {
-  name: 'rest/aws-lambda',
+  name: 'rest-aws-lambda/main',
   assemble: {
     active: true,
     keepSource: false,

package/bin/lib/assemble.ts

@@ -90,7 +90,7 @@ export class AssembleUtil {
   /**
    * Copy over all prod dependencies
    */
-  static async copyDependencies(workspace: string, types: DepType[] = ['prod', 'opt', 'optPeer']): Promise<void> {
+  static async copyDependencies(workspace: string, types: DepType[] = ['prod', 'opt', 'peer']): Promise<void> {
 
     for (const el of await DependenciesUtil.resolveDependencies({ types })) {
       const sub = PathUtil.normalizeFrameworkPath(el.file, 'node_modules/')

package/bin/lib/dependencies.ts

@@ -3,7 +3,7 @@ import * as path from 'path';
 import { FsUtil, PathUtil } from '@travetto/boot';
 
 export type ResolvedDep = { file: string, type: DepType, dep: string, version: string };
-export type DepType = 'prod' | 'dev' | 'opt' | 'peer' | 'optPeer';
+export type DepType = 'prod' | 'dev' | 'opt' | 'peer';
 
 type DepResolveConfig = { root?: string, types?: DepType[] | (readonly DepType[]), maxDepth?: number };
 
@@ -12,8 +12,7 @@ const DEP_MAPPING = {
   dev: 'devDependencies',
   opt: 'optionalDependencies',
   peer: 'peerDependencies',
-  optPeer: 'optionalPeerDependencies'
-};
+} as const;
 
 type PackageShape = {
   name: string;
@@ -77,7 +76,10 @@ export class DependenciesUtil {
           type !== 'dev' ||
           maxDepth === 0
         ) {
-          deps.push(...Object.entries(p[DEP_MAPPING[type]] ?? {}).map(([name, version]) => [name, type, version] as const));
+          deps.push(...Object
+            .entries<Record<string, string>>(p[DEP_MAPPING[type]] ?? {})
+            .map(([name, version]) => [name, type, version] as const)
+          );
         }
       }
       for (const [dep, type, version] of deps) {
@@ -90,7 +92,7 @@ export class DependenciesUtil {
             pending.push([resolved, depth + 1]);
           }
         } catch {
-          if (!dep.startsWith('@types') && type !== 'opt' && type !== 'optPeer') {
+          if (!dep.startsWith('@types') && type !== 'opt' && type !== 'peer') {
             console.error('Unable to resolve', { type, dependency: dep });
           }
         }

package/bin/lib/types.ts

@@ -7,8 +7,8 @@ export type CommonConfig = {
   preProcess?: { [key: string]: (<T extends CommonConfig>(cfg: T) => Promise<void>) }[];
 };
 
-export type PackOperation<T extends CommonConfig> = {
-  key: string;
+export type PackOperation<T extends CommonConfig, K extends string> = {
+  key: K;
   title: string;
   defaults?: Partial<T>;
   overrides?: Partial<T>;

package/bin/lib/util.ts

@@ -25,19 +25,17 @@ export class PackUtil {
     configs: Partial<T>[]
   ): T {
     const inputs = [
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      op.defaults ?? {} as Partial<T>,
+      op.defaults! ?? {},
       ...configs,
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      op.overrides ?? {} as Partial<T>
+      op.overrides! ?? {}
     ].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 ?? [])],
+        preProcess: [...(config.preProcess! ?? []), ...(out.preProcess ?? [])],
+        postProcess: [...(config.postProcess! ?? []), ...(out.postProcess ?? [])],
         ...op.extend?.(config, out)
       };
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -123,7 +121,7 @@ export class PackUtil {
   /**
    * Run operation with logging
    */
-  static async runOperation<T extends CommonConfig>(op: PackOperation<T>, cfg: T, indent = 0): Promise<void> {
+  static async runOperation<T extends CommonConfig>(op: PackOperation<T, string>, cfg: T, indent = 0): Promise<void> {
     const spacer = ' '.repeat(indent);
     const ctx = await op.context(cfg);
     const title = color`${{ title: op.title }} ${ctx}`;

package/bin/operation/assemble.ts

@@ -19,7 +19,7 @@ export interface AssembleConfig extends CommonConfig {
 /**
  * Utils for packing source code and minimizing space usage
  */
-export const Assemble: PackOperation<AssembleConfig> = {
+export const Assemble: PackOperation<AssembleConfig, 'assemble'> = {
   key: 'assemble',
   title: 'Assembling',
   context(cfg: AssembleConfig) {

package/bin/operation/docker.ts

@@ -28,7 +28,7 @@ ${(port ?? []).map(x => `EXPOSE ${x}`).join('\n')}
 CMD ["node", "./node_modules/@travetto/cli/bin/trv", "run", "${app}"]
 `;
 
-export const Docker: PackOperation<DockerConfig> = {
+export const Docker: PackOperation<DockerConfig, 'docker'> = {
   key: 'docker',
   title: 'Docker-izing',
   context(cfg: DockerConfig) {

package/bin/operation/pack.ts

@@ -28,7 +28,7 @@ export type AllConfigPartial = DeepPartial<AllConfig>;
 
 type DefaultOpType = ['assemble', typeof Assemble];
 
-export const Pack: PackOperation<AllConfig> = {
+export const Pack: PackOperation<AllConfig, ''> = {
   key: '',
   title: 'Packing',
   buildConfig(configs: Partial<AllConfig>[]): AllConfig {

package/bin/operation/zip.ts

@@ -11,7 +11,7 @@ export interface ZipConfig extends CommonConfig {
   output: string;
 }
 
-export const Zip: PackOperation<ZipConfig> = {
+export const Zip: PackOperation<ZipConfig, 'zip'> = {
   key: 'zip',
   title: 'Zipping',
   context(cfg: ZipConfig) {

package/bin/pack-base.ts

@@ -16,15 +16,25 @@ export type BaseOptions = {
   workspace: OptionConfig<string>;
 };
 
+function getConfigFromOperationOrGlobal<C extends CommonConfig, K extends string>(key: K, config: Partial<C> | Record<K, Partial<C>> | undefined): Partial<C> | undefined {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+  return !config ? config : (key && key in config ? (config as Record<K, C>)[key] : config) as C;
+}
+
 /**
  * Supports packing a project into a directory, ready for archiving
  */
-export abstract class BasePackCommand<V extends BaseOptions, C extends CommonConfig> extends CliCommand<V> {
+export abstract class BasePackCommand<V extends BaseOptions, C extends CommonConfig, K extends string> extends CliCommand<V> {
 
   /**
    * Package stage name
    */
-  abstract get operation(): PackOperation<C>;
+  abstract get operation(): PackOperation<C, K>;
+
+  get cmdOptions(): Partial<C> {
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return this.cmd as Partial<C>;
+  }
 
   get name(): string {
     return this.operation.key ? `pack:${this.operation.key}` : 'pack';
@@ -35,7 +45,6 @@ export abstract class BasePackCommand<V extends BaseOptions, C extends CommonCon
   }
 
   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');
@@ -45,17 +54,18 @@ export abstract class BasePackCommand<V extends BaseOptions, C extends CommonCon
       this.showHelp(`Unknown config mode: ${this.args[0]}`);
     }
     const def = list.find(c => c.name === 'default');
-    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);
-
-    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
-      { active: true } as C
-    ]);
+
+    const configs = [
+      { workspace: PathUtil.resolveUnix(os.tmpdir(), packName) },
+      def,
+      cfg,
+      this.cmdOptions,
+      { active: true }
+    ]
+      .map(x => getConfigFromOperationOrGlobal(this.operation.key, x))
+      .filter((x): x is C => x !== undefined);
+
+    return this.operation.buildConfig(configs);
   }
 
   getArgs(): string {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/pack",
   "displayName": "Pack",
-  "version": "2.2.4",
+  "version": "3.0.0-rc.0",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -25,15 +25,21 @@
     "directory": "module/pack"
   },
   "dependencies": {
-    "@travetto/base": "^2.2.4",
+    "@travetto/base": "^3.0.0-rc.0",
     "@types/picomatch": "^2.3.0",
     "picomatch": "^2.3.1"
   },
-  "optionalPeerDependencies": {
-    "@travetto/cli": "^2.2.4"
+  "peerDependencies": {
+    "@travetto/cli": "^3.0.0-rc.0"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/cli": {
+      "optional": true
+    }
   },
   "docDependencies": {
-    "@travetto/rest": true
+    "@travetto/rest": true,
+    "@travetto/rest-aws-lambda": true
   },
   "publishConfig": {
     "access": "public"