@travetto/pack 3.0.2-rc.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/pack/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/pack/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Pack
+
 ## Code packing utilities
 
 **Install: @travetto/pack**
@@ -12,15 +13,14 @@ npm install @travetto/pack
 yarn add @travetto/pack
 ```
 
-This module provides the necessary tools to produce deliverable output for [Travetto](https://travetto.dev) based projects.  The main interaction with this module is through the command line interface, and the operations it provides.  Under the covers, the code bundling is performed by [Rollup](https://rollupjs.org/), with specific configuration to support the frameworks runtime expectations.
+This module provides the necessary tools to produce deliverable output for [Travetto](https://travetto.dev) based projects.  The main interaction with this module is through the command line interface, and the operations it provides.  Under the covers, the code bundling is performed by [Rollup](https://rollupjs.org/), with specific configuration to support the frameworks runtime expectations. 
 
 There are three primary cli commands for packing your code:
-   
    *  pack
    *  pack:zip
    *  pack:docker
 
-## CLI - pack 
+## CLI - pack
 
 **Terminal: Pack usage**
 ```bash
@@ -42,14 +42,14 @@ Options:
   -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).
+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). 
 
-Specific to this CLI command, the `output` field determines where the final folder is written that contains all the compiled source. 
+Specific to this CLI command, the `output` field determines where the final folder is written that contains all the compiled source.
 
 ### Entry Point Configuration
-Every application requires an entry point to determine execution flow (and in [Rollup](https://rollupjs.org/)'s case, tree-shaking as well.).  By default the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") acts as the entry point.  This bypasses the [Compiler](https://github.com/travetto/travetto/tree/main/module/compiler#readme "The compiler infrastructure for the Travetto framework") intentionally, as the compiler is not available at runtime.
+Every application requires an entry point to determine execution flow (and in [Rollup](https://rollupjs.org/)'s case, tree-shaking as well.).  By default the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") acts as the entry point.  This bypasses the [Compiler](https://github.com/travetto/travetto/tree/main/module/compiler#readme "The compiler infrastructure for the Travetto framework") intentionally, as the compiler is not available at runtime. 
 
-Within the command line, the `args` are positional arguments that will be passed to the entry point on application run. 
+Within the command line, the `args` are positional arguments that will be passed to the entry point on application run.
 
 **Code: Packing an application run**
 ```typescript
@@ -60,6 +60,7 @@ Would then produce an executable script, in the output folder, that would look l
 
 **Code: Entry script for Packed application**
 ```typescript
+
 #!/bin/sh
 cd $(dirname "$0")
 node cli run myapp
@@ -69,8 +70,6 @@ And this entry point would be what is executed by [docker](https://www.docker.co
 
 ### General Packing Operations
 Every [Pack](https://github.com/travetto/travetto/tree/main/module/pack#readme "Code packing utilities") operation extends from the base command, and that provides some consistent operations that run on every packing command.
-
-   
    *  `clean` - Empties workspace before beginning, controlled by the `--clean` flag, defaults to on
    *  `writeEnv` - Writes the .env.js files that includes the necessary details to start the application.  This is primarily to identify the location of the manifest file needed to run.
    *  `writePackageJson` - Generates the [Package JSON](https://docs.npmjs.com/cli/v9/configuring-npm/package-json) with the appropriate module type ([CommonJS](https://nodejs.org/api/modules.html) or [Ecmascript Module](https://nodejs.org/api/esm.html)) for interpreting plain `.js` files
@@ -81,8 +80,7 @@ Every [Pack](https://github.com/travetto/travetto/tree/main/module/pack#readme "
    *  `bundle` - Invokes [Rollup](https://rollupjs.org/) with the appropriate file set to produce a single output .js file.  Depending on the module type ([CommonJS](https://nodejs.org/api/modules.html) or [Ecmascript Module](https://nodejs.org/api/esm.html)) the build process differs to handle the dynamic loading that application does at runtime.
 
 ## CLI - pack:zip
-
-This command is nearly identical to the standard `pack` operation, except for the `output` flag.  In this scenario, the `output` flag determines the location and name of the final zip file. 
+This command is nearly identical to the standard `pack` operation, except for the `output` flag.  In this scenario, the `output` flag determines the location and name of the final zip file.
 
 **Terminal: Pack:zip usage**
 ```bash
@@ -105,7 +103,6 @@ Options:
 ```
 
 ## CLI - pack:docker
-
 This command starts off identical to the standard `pack` operation, but it contains a few additional flags, and ultimately a few additional operations to support creating of the final [docker](https://www.docker.com/community-edition) image.
 
 **Terminal: Pack:docker usage**
@@ -135,17 +132,15 @@ Options:
   -h, --help                                display help for command
 ```
 
-The additional flags provided are allow for specifying the base image, the final docker image name (and tags), and which registry to push to (if  any).  Additionally, there are flags for exposing which ports the image should expect to open as well.   When using the `--eject-file`  flag, the output script will produce the entire Dockerfile output inline, so that it can be easily modified as needed.
+The additional flags provided are allow for specifying the base image, the final docker image name (and tags), and which registry to push to (if  any).  Additionally, there are flags for exposing which ports the image should expect to open as well.   When using the `--eject-file`  flag, the output script will produce the entire Dockerfile output inline, so that it can be easily modified as needed. 
 
 In addition to the standard operations, this command adds the following steps:
-   
    *  `writeDockerFile` - Generate the docker file contents
    *  `pullDockerBaseImage` - Pull base image, to ensure its available and primed
    *  `buildDockerContainer` - Build final container
    *  `pushDockerContainer` - Push container with appropriate tags.  Only applies if `--docker-push` is specified
 
 ## Ejected File
-
 As indicated, any of the pack operations can be ejected, and produce an output that can be run independent of the pack command.  This is helpful when integrating with more complicated build processes.
 
 **Terminal: Sample Ejected File**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/pack",
-  "version": "3.0.2-rc.2",
+  "version": "3.0.3",
   "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.2-rc.1",
+    "@travetto/base": "^3.0.3",
     "rollup": "^3.17.2",
     "rollup-plugin-sourcemaps": "^0.6.3"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.2-rc.1"
+    "@travetto/cli": "^3.0.3"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/bin/config.ts

@@ -2,7 +2,7 @@ import type { OutputOptions } from 'rollup';
 import type terser from '@rollup/plugin-terser';
 
 import { Env } from '@travetto/base';
-import { ManifestModule, Package, path, RootIndex } from '@travetto/manifest';
+import { ManifestModule, ManifestModuleUtil, Package, path, RootIndex } from '@travetto/manifest';
 
 const INTRO = {
   commonjs: `
@@ -32,7 +32,7 @@ function getFilesFromModule(m: ManifestModule): string[] {
       .filter(f => !/support\/(test|doc)/.test(f[0]))
   ]
     .filter(([, t]) => t === 'ts' || t === 'js' || t === 'json')
-    .map(([f]) => path.resolve(m.outputFolder, f.replace(/[.]ts$/, '.js')));
+    .map(([f]) => ManifestModuleUtil.sourceToOutputExt(path.resolve(m.outputFolder, f)));
 }
 
 export function getOutput(): OutputOptions {