@travetto/pack 5.0.0-rc.8 → 5.0.0

package/README.md

@@ -43,6 +43,7 @@ Options:
   --env-file <string>                  Env Flag File Name (default: ".env")
   --manifest-file <string>             Manifest File Name (default: "manifest.json")
   -wr, --include-workspace-resources   Include workspace resources (default: false)
+  -np, --npm-package <string>          External NPM Packages (default: [])
   -m, --module <module>                Module to run for
   -h, --help                           display help for command
 ```
@@ -108,6 +109,7 @@ Options:
   --env-file <string>                  Env Flag File Name (default: ".env")
   --manifest-file <string>             Manifest File Name (default: "manifest.json")
   -wr, --include-workspace-resources   Include workspace resources (default: false)
+  -np, --npm-package <string>          External NPM Packages (default: [])
   -m, --module <module>                Module to run for
   -h, --help                           display help for command
 ```
@@ -136,6 +138,7 @@ Options:
   --env-file <string>                    Env Flag File Name (default: ".env")
   --manifest-file <string>               Manifest File Name (default: "manifest.json")
   -wr, --include-workspace-resources     Include workspace resources (default: false)
+  -np, --npm-package <string>            External NPM Packages (default: [])
   -df, --docker-factory <string>         Docker Factory source (default: "@travetto/pack/support/pack.dockerfile")
   -di, --docker-image <string>           Docker Image to extend (default: "node:22-alpine")
   -dn, --docker-name <string>            Docker Image Name (default: "travetto_pack")
@@ -259,6 +262,7 @@ echo "RUN addgroup -g 2000 app && adduser -D -G app -u 2000 app" >> $DIST/Docker
 echo "RUN mkdir /app && chown app:app /app" >> $DIST/Dockerfile
 echo "COPY --chown=\"app:app\" . /app" >> $DIST/Dockerfile
 echo "ENV NODE_OPTIONS=\"\"" >> $DIST/Dockerfile
+echo "" >> $DIST/Dockerfile
 echo "USER app" >> $DIST/Dockerfile
 echo "WORKDIR /app" >> $DIST/Dockerfile
 echo "ENTRYPOINT [\"/app/todo-app.sh\"]" >> $DIST/Dockerfile

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "5.0.0-rc.8",
+  "version": "5.0.0",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -29,12 +29,12 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@travetto/runtime": "^5.0.0-rc.8",
-    "@travetto/terminal": "^5.0.0-rc.8",
-    "rollup": "^4.18.0"
+    "@travetto/runtime": "^5.0.0",
+    "@travetto/terminal": "^5.0.0",
+    "rollup": "^4.20.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^5.0.0-rc.8"
+    "@travetto/cli": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/config-util.ts

@@ -29,6 +29,23 @@ export class PackConfigUtil {
     }
   }
 
+  /**
+   * Install docker pages in either apk or apt environments
+   */
+  static dockerNodePackageInstall(cfg: DockerPackConfig): string {
+    const out: string[] = [];
+    for (const item of cfg.externalDependencies ?? []) {
+      out.push(item.endsWith(':from-source') ?
+        `RUN npm_config_build_from_source=true npm install ${item.split(':')[0]} --build-from-source` :
+        `RUN npm install ${item}`
+      );
+    }
+    if (out.length) {
+      out.unshift(`WORKDIR ${cfg.dockerRuntime.folder}`);
+    }
+    return out.join('\n');
+  }
+
   /**
    * Setup docker ports
    */
@@ -74,7 +91,7 @@ export class PackConfigUtil {
   }
 
   /**
-   * Docker app files copied and permissioned
+   * Docker app files copied with proper permissions
    */
   static dockerAppFiles(cfg: DockerPackConfig): string {
     const { user, group, folder } = cfg.dockerRuntime;
@@ -113,6 +130,7 @@ export class PackConfigUtil {
     return [
       this.dockerInit(cfg),
       this.dockerWorkspace(cfg),
+      this.dockerNodePackageInstall(cfg),
       this.dockerEntrypoint(cfg)
     ].join('\n');
   }

package/src/types.ts

@@ -19,6 +19,7 @@ export type CommonPackConfig = {
   rollupConfiguration: string;
   entryPoint: string;
   entryArguments: string[];
+  externalDependencies: string[];
   minify: boolean;
   sourcemap: boolean;
   includeSources: boolean;
@@ -72,5 +73,6 @@ export type CoreRollupConfig = {
   entry: string;
   files: string[];
   ignore: Set<string>;
+  external: string[];
   minify: Parameters<typeof terser>[0];
 };

package/support/bin/docker-operation.ts

@@ -22,8 +22,13 @@ export class DockerPackOperation {
     // Read os before writing
     cfg.dockerRuntime.os = await PackUtil.runCommand(
       ['docker', 'run', '--entrypoint', '/bin/sh', cfg.dockerImage, '-c', 'cat /etc/*release*']
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    ).then(out => out.match(/\b(?:debian|alpine|centos)\b/i)?.[0].toLowerCase() as 'alpine' ?? 'unknown');
+    ).then(out => {
+      const found = out.match(/\b(?:debian|alpine|centos)\b/i)?.[0].toLowerCase();
+      switch (found) {
+        case 'debian': case 'alpine': case 'centos': return found;
+        default: return 'unknown';
+      }
+    });
     yield* PackOperation.title(cfg, cliTpl`${{ title: 'Detected Image OS' }} ${{ param: cfg.dockerImage }} as ${{ param: cfg.dockerRuntime.os }}`);
   }
 

package/support/bin/operation.ts

@@ -67,7 +67,8 @@ export class PackOperation {
         ['BUNDLE_SOURCES', cfg.includeSources],
         ['BUNDLE_OUTPUT', cfg.buildDir],
         ['BUNDLE_FORMAT', Runtime.workspace.type],
-        ['BUNDLE_ENV_FILE', cfg.envFile]
+        ['BUNDLE_ENV_FILE', cfg.envFile],
+        ['BUNDLE_EXTERNAL', cfg.externalDependencies.join(',')]
       ] as const)
         .filter(x => x[1] === false || x[1])
         .map(x => [x[0], `${x[1]}`])

package/support/bin/util.ts

@@ -29,7 +29,7 @@ export class PackUtil {
       }
       await fs.mkdir(final, { recursive: true });
       await fs.cp(src, final, { recursive: true });
-    } catch (err) {
+    } catch {
       if (!ignoreFailure) {
         throw new Error(`Failed to copy ${src} to ${dest}`);
       }

package/support/pack.base.ts

@@ -71,6 +71,9 @@ export abstract class BasePackCommand implements CliCommandShape {
   @CliFlag({ desc: 'Include workspace resources', short: 'wr' })
   includeWorkspaceResources: boolean = false;
 
+  @CliFlag({ desc: 'External NPM Packages', short: 'np', name: 'npm-package', envVars: ['PACK_EXTERNAL_PACKAGES'] })
+  externalDependencies: string[] = [];
+
   @Ignore()
   module: string;
 

package/support/rollup/build.ts

@@ -16,6 +16,7 @@ export default function buildConfig(): RollupOptions {
   return {
     input: [config.entry],
     output: config.output,
+    external: config.external,
     plugins: [
       jsonImport(),
       travettoEntryPlugin(config),

package/support/rollup/config.ts

@@ -21,9 +21,16 @@ function getFilesFromModule(m: ManifestModule): string[] {
     .map(([f]) => ManifestModuleUtil.withOutputExtension(path.resolve(m.outputFolder, f)));
 }
 
+function getFormat(value: string = 'commonjs'): NodeModuleType {
+  switch (value) {
+    case 'module':
+    case 'commonjs': return value;
+    default: return 'commonjs';
+  }
+}
+
 export function getOutput(): OutputOptions {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-  const format = (process.env.BUNDLE_FORMAT ?? 'commonjs') as NodeModuleType;
+  const format = getFormat(process.env.BUNDLE_FORMAT);
   const dir = process.env.BUNDLE_OUTPUT!;
   const mainFile = process.env.BUNDLE_MAIN_FILE!;
   return {
@@ -79,9 +86,10 @@ export function getCoreConfig(): CoreRollupConfig {
   const ignoreFiles = ignoreModules.flatMap(getFilesFromModule);
   const minify = getMinifyConfig();
   const envFile = new EnvProp('BUNDLE_ENV_FILE').val;
+  const external = new EnvProp('BUNDLE_EXTERNAL').list ?? [];
 
   return {
-    output, entry, files, envFile, minify,
+    output, entry, files, envFile, minify, external,
     ignore: new Set([...ignoreModules.map(x => x.name), ...ignoreFiles]),
   };
 }