@travetto/pack 2.2.0 → 2.2.1

package/bin/cli-pack.ts

@@ -1,11 +1,10 @@
-import { BasePackPlugin } from './pack-base';
+import { BaseOptions, BasePackPlugin } from './pack-base';
 import { Pack, AllConfig } from './operation/pack';
 
-export class PackPlugin extends BasePackPlugin<AllConfig> {
+export class PackPlugin extends BasePackPlugin<BaseOptions, AllConfig> {
   operation = Pack;
 
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  getOptions() {
+  getOptions(): BaseOptions {
     return this.defaultOptions();
   }
 }

package/bin/cli-pack_assemble.ts

@@ -1,10 +1,17 @@
-import { BasePackPlugin } from './pack-base';
+import { OptionConfig } from '@travetto/cli/src/plugin-base';
+
+import { BaseOptions, BasePackPlugin } from './pack-base';
 import { Assemble, AssembleConfig } from './operation/assemble';
 
-export class PackAssemblePlugin extends BasePackPlugin<AssembleConfig> {
+type Options = BaseOptions & {
+  keepSource: OptionConfig<boolean>;
+  readonly: OptionConfig<boolean>;
+};
+
+export class PackAssemblePlugin extends BasePackPlugin<Options, AssembleConfig> {
   operation = Assemble;
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  getOptions() {
+
+  getOptions(): Options {
     return {
       ...this.defaultOptions(),
       keepSource: this.boolOption({ desc: 'Should source be preserved' }),

package/bin/cli-pack_docker-export.ts

@@ -1,14 +1,21 @@
 import * as fs from 'fs/promises';
 
 import { FsUtil, PathUtil } from '@travetto/boot';
-import { BasePlugin } from '@travetto/cli/src/plugin-base';
+import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
 
-export class PackDockerExportPlugin extends BasePlugin {
+type Options = {
+  app: OptionConfig<string>;
+  image: OptionConfig<string>;
+  port: OptionConfig<number>;
+  add: OptionConfig<string[]>;
+  output: OptionConfig<string>;
+};
+
+export class PackDockerExportPlugin extends BasePlugin<Options> {
 
   name = 'pack:docker-export';
 
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  getOptions() {
+  getOptions(): Options {
     return {
       app: this.option({ desc: 'The application target to run', def: 'rest' }),
       image: this.option({ desc: 'Docker image to extend', def: 'node:16-alpine' }),

package/bin/cli-pack_docker.ts

@@ -1,11 +1,21 @@
-import { BasePackPlugin } from './pack-base';
+import { OptionConfig } from '@travetto/cli/src/plugin-base';
+
+import { BaseOptions, BasePackPlugin } from './pack-base';
 import { Docker, DockerConfig } from './operation/docker';
 
-export class PackDockerPlugin extends BasePackPlugin<DockerConfig> {
+type Options = BaseOptions & {
+  image: OptionConfig<string>;
+  name: OptionConfig<string>;
+  tag: OptionConfig<string[]>;
+  port: OptionConfig<string[]>;
+  push: OptionConfig<boolean>;
+  registry: OptionConfig<string>;
+};
+
+export class PackDockerPlugin extends BasePackPlugin<Options, DockerConfig> {
   operation = Docker;
 
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  getOptions() {
+  getOptions(): Options {
     return {
       ...this.defaultOptions(),
       image: this.option({ desc: 'Docker Image to extend' }),

package/bin/cli-pack_zip.ts

@@ -1,11 +1,16 @@
-import { BasePackPlugin } from './pack-base';
+import { OptionConfig } from '@travetto/cli/src/plugin-base';
+
+import { BaseOptions, BasePackPlugin } from './pack-base';
 import { Zip, ZipConfig } from './operation/zip';
 
-export class PackZipPlugin extends BasePackPlugin<ZipConfig> {
+type Options = BaseOptions & {
+  output: OptionConfig<string>;
+};
+
+export class PackZipPlugin extends BasePackPlugin<Options, ZipConfig> {
   operation = Zip;
 
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  getOptions() {
+  getOptions(): Options {
     return {
       ...this.defaultOptions(),
       output: this.option({ desc: 'Output File' })

package/bin/pack-base.ts

@@ -1,6 +1,6 @@
 import * as os from 'os';
 
-import { BasePlugin } from '@travetto/cli/src/plugin-base';
+import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
 import { color } from '@travetto/cli/src/color';
 import { PathUtil, Package, FsUtil } from '@travetto/boot';
 
@@ -12,10 +12,14 @@ const packName = `pack_${Package.name}`
   .replace(/[^a-z]+/g, '_')
   .replace(/_+/g, '_');
 
+export type BaseOptions = {
+  workspace: OptionConfig<string>;
+};
+
 /**
  * Supports packing a project into a directory, ready for archiving
  */
-export abstract class BasePackPlugin<C extends CommonConfig> extends BasePlugin {
+export abstract class BasePackPlugin<V extends BaseOptions, C extends CommonConfig> extends BasePlugin<V> {
 
   /**
    * Package stage name
@@ -26,8 +30,7 @@ export abstract class BasePackPlugin<C extends CommonConfig> extends BasePlugin
     return this.operation.key ? `pack:${this.operation.key}` : 'pack';
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  defaultOptions() {
+  defaultOptions(): BaseOptions {
     return { workspace: this.option({ desc: 'Working directory' }) } as const;
   }
 

package/package.json

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