@travetto/pack 3.0.1 → 3.0.2-rc.1

package/README.md

@@ -29,16 +29,17 @@ $ trv pack --help
 Usage:  pack [options] [args...]
 
 Options:
-  -w, --workspace <workspace>           Workspace for building
-  -c, --no-clean                        Disables: Clean workspace
-  -o, --output <output>                 Output Location
-  -e, --entry-point <entry-point>       Entry point (default: "node_modules/@travetto/cli/support/cli.js")
-  -ec, --entry-command <entry-command>  Entry command
-  -m, --no-minify                       Disables: Minify output
-  -sm, --sourcemap                      Bundle source maps
-  -is, --include-sources                Include source with source maps
-  -x, --eject-file <eject-file>         Eject commands to file
-  -h, --help                            display help for command
+  -w, --workspace <workspace>         Workspace for building
+  -c, --no-clean                      Disables: Clean workspace
+  -o, --output <output>               Output location
+  -es, --main-scripts <main-scripts>  Create entry scripts
+  -f, --main-name <main-name>         Main name for build artifact (default: "cli")
+  -e, --entry-point <entry-point>     Entry point (default: "@travetto/cli/support/entry.cli")
+  -m, --no-minify                     Disables: Minify output
+  -sm, --sourcemap                    Bundle source maps
+  -is, --include-sources              Include source with source maps
+  -x, --eject-file <eject-file>       Eject commands to file
+  -h, --help                          display help for command
 ```
 
 This command line operation will compile your project, and produce a ready to use workspace as a deliverable. Additionally, you can pass in a file to the `eject-file` flag that will allow for a script to be produced (base on the host operating system).
@@ -90,16 +91,17 @@ $ trv pack:zip --help
 Usage:  pack:zip [options] [args...]
 
 Options:
-  -w, --workspace <workspace>           Workspace for building
-  -c, --no-clean                        Disables: Clean workspace
-  -o, --output <output>                 Output Location (default: "travetto_pack.zip")
-  -e, --entry-point <entry-point>       Entry point (default: "node_modules/@travetto/cli/support/cli.js")
-  -ec, --entry-command <entry-command>  Entry command
-  -m, --no-minify                       Disables: Minify output
-  -sm, --sourcemap                      Bundle source maps
-  -is, --include-sources                Include source with source maps
-  -x, --eject-file <eject-file>         Eject commands to file
-  -h, --help                            display help for command
+  -w, --workspace <workspace>         Workspace for building
+  -c, --no-clean                      Disables: Clean workspace
+  -o, --output <output>               Output location (default: "travetto_pack.zip")
+  -es, --main-scripts <main-scripts>  Create entry scripts
+  -f, --main-name <main-name>         Main name for build artifact (default: "cli")
+  -e, --entry-point <entry-point>     Entry point (default: "@travetto/cli/support/entry.cli")
+  -m, --no-minify                     Disables: Minify output
+  -sm, --sourcemap                    Bundle source maps
+  -is, --include-sources              Include source with source maps
+  -x, --eject-file <eject-file>       Eject commands to file
+  -h, --help                          display help for command
 ```
 
 ## CLI - pack:docker
@@ -115,9 +117,10 @@ Usage:  pack:docker [options] [args...]
 Options:
   -w, --workspace <workspace>               Workspace for building
   -c, --no-clean                            Disables: Clean workspace
-  -o, --output <output>                     Output Location
-  -e, --entry-point <entry-point>           Entry point (default: "node_modules/@travetto/cli/support/cli.js")
-  -ec, --entry-command <entry-command>      Entry command
+  -o, --output <output>                     Output location
+  -es, --main-scripts <main-scripts>        Create entry scripts
+  -f, --main-name <main-name>               Main name for build artifact (default: "cli")
+  -e, --entry-point <entry-point>           Entry point (default: "@travetto/cli/support/entry.cli")
   -m, --no-minify                           Disables: Minify output
   -sm, --sourcemap                          Bundle source maps
   -is, --include-sources                    Include source with source maps
@@ -157,34 +160,46 @@ export MOD=@travetto/todo-app
 
 # Cleaning Output $DIST 
 
+echo "Cleaning Output $DIST
+"
 rm -rf $DIST
 mkdir -p $DIST
 
 # Writing .env.js 
 
+echo "Writing .env.js
+"
 echo "process.env.TRV_MANIFEST = 'node_modules/$MOD';" > $DIST/.env.js
 echo "process.env.TRV_CLI_IPC = '';" >> $DIST/.env.js
 
 # Writing package.json 
 
+echo "Writing package.json
+"
 echo "{\"type\":\"commonjs\"}" > $DIST/package.json
 
 # Writing entry scripts cli.sh args=(run rest) 
 
+echo "Writing entry scripts cli.sh args=(run rest)
+"
 echo "#!/bin/sh" > $DIST/cli.sh
 echo "cd \$(dirname \"\$0\")" >> $DIST/cli.sh
-echo "node cli run rest \$@" >> $DIST/cli.sh
+echo "node cli.js run rest \$@" >> $DIST/cli.sh
 chmod 755 $DIST/cli.sh
 
 # Writing entry scripts cli.cmd args=(run rest) 
 
+echo "Writing entry scripts cli.cmd args=(run rest)
+"
 echo "" > $DIST/cli.cmd
 echo "cd %~p0" >> $DIST/cli.cmd
-echo "node cli run rest %*" >> $DIST/cli.cmd
+echo "node cli.js run rest %*" >> $DIST/cli.cmd
 chmod 755 $DIST/cli.cmd
 
 # Copying over resources 
 
+echo "Copying over resources
+"
 mkdir -p $DIST/node_modules/$MOD
 cp $TRV_OUT/node_modules/$MOD/package.json $DIST/node_modules/$MOD/package.json
 mkdir -p $DIST/node_modules/@travetto/manifest
@@ -193,17 +208,23 @@ cp -r -p $ROOT/resources $DIST/resources
 
 # Generating App Cache node_modules/$MOD/trv-app-cache.json 
 
+echo "Generating App Cache node_modules/$MOD/trv-app-cache.json
+"
 mkdir -p $DIST/node_modules/$MOD
 DEBUG=0 TRV_MODULE=$MOD npx trv main @travetto/app/support/bin/list > $DIST/node_modules/$MOD/trv-app-cache.json
 
 # Writing Manifest node_modules/$MOD 
 
+echo "Writing Manifest node_modules/$MOD
+"
 TRV_MODULE=$MOD npx trv manifest $DIST/node_modules/$MOD prod
 
-# Bundling Output minify=true sourcemap= entryPoint=node_modules/@travetto/cli/support/cli.js 
+# Bundling Output minify=true sourcemap= entryPoint=@travetto/cli/support/entry.cli 
 
-export BUNDLE_ENTRY=node_modules/@travetto/cli/support/cli.js
-export BUNDLE_ENTRY_NAME=cli
+echo "Bundling Output minify=true sourcemap= entryPoint=@travetto/cli/support/entry.cli
+"
+export BUNDLE_ENTRY=node_modules/@travetto/cli/support/entry.cli.js
+export BUNDLE_MAIN_FILE=cli.js
 export BUNDLE_COMPRESS=true
 export BUNDLE_OUTPUT=$DIST
 export BUNDLE_FORMAT=commonjs
@@ -214,6 +235,8 @@ cd $ROOT
 
 # Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile 
 
+echo "Generating Docker File $DIST/Dockerfile @travetto/pack/support/pack.dockerfile
+"
 echo "FROM node:18-alpine3.16" > $DIST/Dockerfile
 echo "WORKDIR /app" >> $DIST/Dockerfile
 echo "COPY . ." >> $DIST/Dockerfile
@@ -222,10 +245,14 @@ echo "ENTRYPOINT [\"/app/cli.sh\"]" >> $DIST/Dockerfile
 
 # Pulling Docker Base Image node:18-alpine3.16 
 
+echo "Pulling Docker Base Image node:18-alpine3.16
+"
 docker pull node:18-alpine3.16
 
 # Building Docker Container latest 
 
+echo "Building Docker Container latest
+"
 cd $DIST
 docker build -t travetto_todo-app:latest .
 cd $ROOT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "3.0.1",
+  "version": "3.0.2-rc.1",
   "description": "Code packing utilities",
   "keywords": [
     "travetto",
@@ -28,12 +28,12 @@
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-terser": "^0.4.0",
-    "@travetto/base": "^3.0.1",
+    "@travetto/base": "^3.0.2-rc.1",
     "rollup": "^3.17.2",
     "rollup-plugin-sourcemaps": "^0.6.3"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.1"
+    "@travetto/cli": "^3.0.2-rc.1"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/bin/config.ts

@@ -38,7 +38,7 @@ function getFilesFromModule(m: ManifestModule): string[] {
 export function getOutput(): OutputOptions {
   const format: Package['type'] = Env.get('BUNDLE_FORMAT', 'commonjs');
   const dir = Env.get('BUNDLE_OUTPUT')!;
-  const entryName = Env.get('BUNDLE_ENTRY_COMMAND')!;
+  const mainFile = Env.get('BUNDLE_MAIN_FILE')!;
   return {
     format,
     intro: INTRO[format],
@@ -50,7 +50,7 @@ export function getOutput(): OutputOptions {
       !(Env.getBoolean('BUNDLE_SOURCES') ?? false),
     compact:
       Env.getBoolean('BUNDLE_COMPRESS') ?? true,
-    file: path.resolve(dir, `${entryName}.js`),
+    file: path.resolve(dir, mainFile),
     ...(format === 'commonjs' ? {} : {
       inlineDynamicImports: true
     }),

package/support/bin/operation.ts

@@ -60,7 +60,7 @@ export class PackOperation {
 
     const env = Object.fromEntries(([
       ['BUNDLE_ENTRY', entryPointFile],
-      ['BUNDLE_ENTRY_COMMAND', cfg.entryCommand],
+      ['BUNDLE_MAIN_FILE', `${cfg.mainName}.js`],
       ['BUNDLE_COMPRESS', cfg.minify],
       ['BUNDLE_SOURCEMAP', cfg.sourcemap],
       ['BUNDLE_SOURCES', cfg.includeSources],
@@ -140,16 +140,20 @@ export class PackOperation {
    * Create launcher scripts (.sh, .cmd) to run output
    */
   static async * writeEntryScript(cfg: CommonPackConfig): AsyncIterable<string[]> {
+    if (!cfg.mainScripts && !cfg.entryPoint.includes('@travetto/cli')) {
+      return;
+    }
+
     const title = 'Writing entry scripts';
 
     const files = ([['posix', 'sh'], ['win32', 'cmd']] as const)
       .map(([type, ext]) => ({
-        fileTitle: cliTpl`${{ title }} ${{ path: `${cfg.entryCommand}.${ext}` }} args=(${{ param: cfg.entryArguments.join(' ') }})`,
-        file: `${cfg.entryCommand}.${ext}`,
+        fileTitle: cliTpl`${{ title }} ${{ path: `${cfg.mainName}.${ext}` }} args=(${{ param: cfg.entryArguments.join(' ') }})`,
+        file: `${cfg.mainName}.${ext}`,
         text: [
           ShellCommands[type].scriptOpen(),
           ShellCommands[type].chdirScript(),
-          ShellCommands[type].callCommandWithAllArgs('node', `${cfg.entryCommand}.js`, ...cfg.entryArguments),
+          ShellCommands[type].callCommandWithAllArgs('node', `${cfg.mainName}.js`, ...cfg.entryArguments),
         ].map(x => x.join(' '))
       }));
 

package/support/bin/types.ts

@@ -5,11 +5,12 @@ export type CommonPackConfig = {
   output: string;
   clean: boolean;
   ejectFile: string;
+  mainName: string;
+  mainScripts: boolean;
   module: string;
 
   // Bundle
   entryPoint: string;
-  entryCommand: string;
   entryArguments: string[];
   minify: boolean;
   sourcemap: boolean;
@@ -21,6 +22,8 @@ export type CommonPackOptions = {
   output: OptionConfig<string>;
   clean: OptionConfig<boolean>;
   ejectFile: OptionConfig<string>;
+  mainName: OptionConfig<string>;
+  mainScripts: OptionConfig<boolean>;
 
   // Bundle
   entryPoint: OptionConfig<string>;

package/support/pack.base.ts

@@ -28,7 +28,7 @@ export abstract class BasePackCommand<T extends CommonPackOptions, S extends Com
     return !!RootIndex.manifest.monoRepo && path.cwd() === RootIndex.manifest.workspacePath;
   }
 
-  get entries(): string[] {
+  get entryPoints(): string[] {
     return RootIndex.findSupport({ filter: x => x.includes('entry.') })
       .map(x => x.import.replace(/[.][^.]+s$/, ''));
   }
@@ -38,13 +38,14 @@ export abstract class BasePackCommand<T extends CommonPackOptions, S extends Com
   }
 
   getCommonOptions(): CommonPackOptions {
-    const entries = this.entries;
-    const mainEntry = this.entries.find(x => x.startsWith('@travetto/cli'))!;
+    const mainEntry = this.entryPoints.find(x => x.startsWith('@travetto/cli'))!;
     return {
       workspace: this.option({ short: 'w', desc: 'Workspace for building' }),
       clean: this.boolOption({ short: 'c', desc: 'Clean workspace', def: true }),
-      output: this.option({ short: 'o', desc: 'Output Location' }),
-      entryPoint: this.choiceOption({ short: 'e', desc: 'Entry point', def: mainEntry, choices: entries }),
+      output: this.option({ short: 'o', desc: 'Output location' }),
+      mainScripts: this.option({ short: 'es', desc: 'Create entry scripts' }),
+      mainName: this.option({ short: 'f', desc: 'Main name for build artifact', def: path.basename(mainEntry).replace(/entry[.]/, '') }),
+      entryPoint: this.option({ short: 'e', desc: 'Entry point', def: mainEntry }),
       minify: this.boolOption({ short: 'm', desc: 'Minify output', def: true }),
       sourcemap: this.boolOption({ short: 'sm', desc: 'Bundle source maps' }),
       includeSources: this.boolOption({ short: 'is', desc: 'Include source with source maps' }),
@@ -94,7 +95,6 @@ export abstract class BasePackCommand<T extends CommonPackOptions, S extends Com
 
   async buildConfig(): Promise<S> {
     this.cmd.workspace ??= path.resolve(os.tmpdir(), RootIndex.mainModule.sourcePath.replace(/[\/\\: ]/g, '_'));
-    this.cmd.entryCommand = path.basename(this.cmd.entryPoint).replace(/entry[.]/, '');
     this.cmd.module = RootIndex.mainModule.name;
     return this.cmd;
   }

package/support/pack.dockerfile.ts

@@ -5,5 +5,5 @@ FROM ${cfg.dockerImage}
 WORKDIR /app
 COPY . .
 ${cfg.dockerPort.map(port => `EXPOSE ${port}`).join('\n')}
-ENTRYPOINT ["/app/${cfg.entryCommand}.sh"]
+ENTRYPOINT ["/app/${cfg.mainName}.sh"]
 `;