@ts-ioc-container/bundler 8.0.0 → 8.2.0

package/AGENTS.md

@@ -14,8 +14,9 @@ it.
   prints the bundle to **stdout**; it writes nothing. Saving is the shell's
   job: `tic build app.bundle.json > src/di/app.bundle.ts`,
   `cat dev.bundle.json | tic build > src/di/dev.bundle.ts`; CI checks with
-  `tic build app.bundle.json | diff - src/di/app.bundle.ts`. Warnings and errors
-  go to stderr. The bundle is `export class AppBundle implements
+  `tic build app.bundle.json | diff - src/di/app.bundle.ts`. Progress (each
+  bundled class as `  Name: path`, then a `Bundled …` summary), warnings and
+  errors go to stderr. The bundle is `export class AppBundle implements
 IContainerModule`, applied with `container.useModule(new AppBundle())`.
 - Every import in a bundle is written through a tsconfig `paths` alias, so the
   bundle works wherever it is saved; a selected class no alias covers fails the

package/README.md

@@ -39,8 +39,15 @@ tic build [<config>...]
 `tic build` prints the bundle to **stdout** and writes nothing. `<config>` is a
 config file — JSON for `.json`, YAML for `.yaml` / `.yml`. Several are
 [merged](#merging-configs) left to right into one bundle. Without one (or with
-`-`) the config is read from **stdin**. Warnings and errors go to stderr, so
-they never end up in the bundle.
+`-`) the config is read from **stdin**. Progress, warnings and errors go to
+stderr, so they never end up in the bundle:
+
+```text
+Bundling AppBundle...
+  Clock: src/infra/Clock.ts
+  Greeter: src/services/Greeter.ts
+Bundled AppBundle: 2 dependencies from 2 files
+```
 
 ```bash
 # a config file in, the bundle saved by the shell

package/cjm/cli/usage.js

@@ -16,7 +16,7 @@ exports.USAGE = [
     '  -h, --help      show this help',
     '  -v, --version   show the version',
     '',
-    'The bundle goes to stdout; the files in it and warnings to stderr.',
+    'The bundle goes to stdout; progress (the classes in it and a summary) and warnings to stderr.',
     'Saving it is up to you:',
     '  tic build app.bundle.json > src/di/app.bundle.ts',
     '  tic build common.bundle.yml prod.bundle.yml > src/di/prod.bundle.ts   # merged left to right',

package/cjm/features/bundle/BundleController.js

@@ -40,6 +40,7 @@ exports.BUILD_OPTIONS = zod_1.z.object({ positionals: zod_1.z.array(zod_1.z.stri
     return { configs: positionals.length > 0 ? positionals : [BuildConfig_1.STDIN] };
 });
 const buildArgs = (0, cli_1.parseOptions)({}, { positionals: true });
+const count = (n, one, many = `${one}s`) => `${n} ${n === 1 ? one : many}`;
 let BundleController = class BundleController {
     io;
     configService;
@@ -60,12 +61,18 @@ let BundleController = class BundleController {
             const config = stdin
                 ? this.configService.parse(this.stdin(), this.io.cwd)
                 : this.configService.load(configs.map((file) => node_path_1.default.resolve(this.io.cwd, file)));
-            const { content, files, warnings } = this.bundleService.bundle(config);
-            for (const file of files)
-                this.logger.info((0, glob_1.toPosix)(node_path_1.default.relative(this.io.cwd, file)));
+            this.logger.info(`Bundling ${config.bundleClassName}...`);
+            const { bundle, content, classes, files, warnings } = this.bundleService.bundle(config);
+            for (const { file, className } of classes) {
+                this.logger.info(`  ${className}: ${(0, glob_1.toPosix)(node_path_1.default.relative(this.io.cwd, file))}`);
+            }
             for (const warning of warnings)
                 this.logger.warn(`${label}: ${warning}`);
             this.output.write(content.replace(/\n$/, ''));
+            const summary = [count(classes.length, 'dependency', 'dependencies'), `from ${count(files.length, 'file')}`];
+            if (warnings.length > 0)
+                summary.push(`(${count(warnings.length, 'warning')})`);
+            this.logger.info(`Bundled ${bundle}: ${summary.join(' ')}`);
         }
         catch (e) {
             if (e instanceof DomainException_1.TicError && !(e instanceof DomainException_1.UsageError))

package/cjm/features/bundle/services/BundleService.js

@@ -68,6 +68,7 @@ let BundleService = class BundleService {
             bundle: config.bundleClassName,
             registrations: classes.length,
             files: [...new Set(classes.map((cls) => cls.file))],
+            classes: classes.map(({ file, className }) => ({ file, className })),
             content,
             warnings: [...config.warnings, ...(0, tokenCollisions_1.tokenCollisions)(classes)],
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-ioc-container/bundler",
-  "version": "8.0.0",
+  "version": "8.2.0",
   "description": "Bundles your dependencies into a single container module for ts-ioc-container: the `tic` CLI scans folders (by path or tsconfig alias) and generates one typed bundle that registers every class — `container.useModule(new AppBundle())`.",
   "publishConfig": {
     "access": "public",

package/typings/features/bundle/BundleController.d.ts

@@ -29,8 +29,10 @@ export declare class BundleController {
      * stdout. Saving it is the shell's job: `tic build app.bundle.json > src/di/app.bundle.ts`,
      * `tic build common.bundle.yml prod.bundle.yml > src/di/prod.bundle.ts`,
      * `cat app.bundle.yml | tic build > out.ts`.
-     * The files in the bundle, one path per line relative to the working directory, and warnings
-     * go to stderr, so they never end up in the bundle; an error names the configs.
+     * Progress goes to stderr, so it never ends up in the bundle: `Bundling AppBundle...`, then
+     * each class in it, one per line as its name and its file's path relative to the working
+     * directory (`  Clock: src/infra/Clock.ts`), the warnings, and a summary
+     * (`Bundled AppBundle: 3 dependencies from 2 files (1 warning)`). An error names the configs.
      *
      * @throws {UsageError} when an option is unknown, `-` is given with config files, or the config should come from stdin and nothing is piped in.
      * @throws {TicConfigError} when a config file is missing or unreadable, several are in different folders, the config or its tsconfig is invalid, the bundle has no name, or no tsconfig paths alias covers a selected class's file.

package/typings/features/bundle/BundleController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BundleController.d.ts","sourceRoot":"","sources":["../../../lib/features/bundle/BundleController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,KAAK,EAAY,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,KAAK,OAAO,EAAc,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,8BAA8B,CAAC;AAGtF,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,0BAA0B,CAAC;AAClF,OAAO,EAAE,KAAK,iBAAiB,EAAwB,MAAM,6BAA6B,CAAC;AAE3F,eAAO,MAAM,aAAa;;;;;;GAWxB,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,aAAa,CAAC,CAAC;AAI7D;;;GAGG;AACH,qBACa,gBAAgB;IAEH,OAAO,CAAC,QAAQ,CAAC,EAAE;IACP,OAAO,CAAC,QAAQ,CAAC,aAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAJR,EAAE,EAAE,KAAK,EACG,aAAa,EAAE,iBAAiB,EACnC,aAAa,EAAE,cAAc,EAC7B,MAAM,EAAE,cAAc,EAC7B,MAAM,EAAE,OAAO;IAG1D;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAgE,EAAE,OAAO,EAAE,EAAE,eAAe,GAAG,IAAI;IAkBzG;;OAEG;IACH,OAAO,CAAC,KAAK;CAOd"}
+{"version":3,"file":"BundleController.d.ts","sourceRoot":"","sources":["../../../lib/features/bundle/BundleController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,KAAK,EAAY,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EAAE,KAAK,OAAO,EAAc,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,8BAA8B,CAAC;AAGtF,OAAO,EAAE,KAAK,cAAc,EAAqB,MAAM,0BAA0B,CAAC;AAClF,OAAO,EAAE,KAAK,iBAAiB,EAAwB,MAAM,6BAA6B,CAAC;AAE3F,eAAO,MAAM,aAAa;;;;;;GAWxB,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,aAAa,CAAC,CAAC;AAO7D;;;GAGG;AACH,qBACa,gBAAgB;IAEH,OAAO,CAAC,QAAQ,CAAC,EAAE;IACP,OAAO,CAAC,QAAQ,CAAC,aAAa;IACjC,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAJR,EAAE,EAAE,KAAK,EACG,aAAa,EAAE,iBAAiB,EACnC,aAAa,EAAE,cAAc,EAC7B,MAAM,EAAE,cAAc,EAC7B,MAAM,EAAE,OAAO;IAG1D;;;;;;;;;;;;;;OAcG;IAEH,MAAM,CAAgE,EAAE,OAAO,EAAE,EAAE,eAAe,GAAG,IAAI;IAwBzG;;OAEG;IACH,OAAO,CAAC,KAAK;CAOd"}

package/typings/features/bundle/services/BundleService.d.ts

@@ -8,6 +8,8 @@ export interface Bundle {
     registrations: number;
     /** Absolute paths of the files the bundle imports from, sorted. */
     files: string[];
+    /** The classes the bundle registers, sorted by file and then by declaration order. */
+    classes: BundledClass[];
     /** The generated bundle. Nothing is written: saving it is the caller's job (`tic build app.bundle.json > src/di/app.bundle.ts`). */
     content: string;
     /**
@@ -16,6 +18,13 @@ export interface Bundle {
      */
     warnings: string[];
 }
+/** A class the bundle registers. */
+export interface BundledClass {
+    /** Absolute path of the file it is declared in. */
+    file: string;
+    /** The declared class name; an anonymous default export is named after its file. */
+    className: string;
+}
 export interface IBundleService {
     /**
      * Generates the bundle a resolved config describes and returns it; nothing is written.

package/typings/features/bundle/services/BundleService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BundleService.d.ts","sourceRoot":"","sources":["../../../../lib/features/bundle/services/BundleService.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,KAAK,kBAAkB,EAAyB,MAAM,yCAAyC,CAAC;AAEzG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAoB,KAAK,WAAW,EAAkB,MAAM,cAAc,CAAC;AAMlF,MAAM,WAAW,MAAM;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,oIAAoI;IACpI,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC;CACtC;AAED,eAAO,MAAM,iBAAiB,6BAAoD,CAAC;AAEnF,qBACa,aAAc,YAAW,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,EAAE;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI;gBADG,EAAE,EAAE,kBAAkB,EAC7B,IAAI,EAAE,WAAW;IAGhE;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;CA6CrC"}
+{"version":3,"file":"BundleService.d.ts","sourceRoot":"","sources":["../../../../lib/features/bundle/services/BundleService.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,KAAK,kBAAkB,EAAyB,MAAM,yCAAyC,CAAC;AAEzG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAoB,KAAK,WAAW,EAAkB,MAAM,cAAc,CAAC;AAMlF,MAAM,WAAW,MAAM;IACrB,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,sFAAsF;IACtF,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,oIAAoI;IACpI,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,oCAAoC;AACpC,MAAM,WAAW,YAAY;IAC3B,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAAC;CACtC;AAED,eAAO,MAAM,iBAAiB,6BAAoD,CAAC;AAEnF,qBACa,aAAc,YAAW,cAAc;IAEb,OAAO,CAAC,QAAQ,CAAC,EAAE;IAC1B,OAAO,CAAC,QAAQ,CAAC,IAAI;gBADG,EAAE,EAAE,kBAAkB,EAC7B,IAAI,EAAE,WAAW;IAGhE;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;CA8CrC"}

package/typings/index.d.ts

@@ -4,7 +4,7 @@ export { type GlobalConfig, GlobalConfigKey, globalConfig } from './domain/Globa
 export { Application, action, onDefault, DEFAULT_ACTION, commandArgs, parseOptions, validate, type IErrorHandler, IErrorHandlerKey, USAGE, } from './cli.js';
 export { BuildModule } from './features/bundle/BuildModule.js';
 export { BundleController, BUILD_OPTIONS, type BuildCliOptions } from './features/bundle/BundleController.js';
-export { BundleService, IBundleServiceKey, type IBundleService, type Bundle, } from './features/bundle/services/BundleService.js';
+export { BundleService, IBundleServiceKey, type IBundleService, type Bundle, type BundledClass, } from './features/bundle/services/BundleService.js';
 export { TicConfigService, ITicConfigServiceKey, type ITicConfigService, } from './features/bundle/services/TicConfigService.js';
 export { resolveConfig, BUNDLE_CONFIG_SCHEMA, BUNDLE_CONFIG_FILE_SCHEMA, mergeConfigs, parseConfig, CONFIG_FILE_SUFFIXES, STDIN, configFormat, DEFAULT_TSCONFIG, DEFAULT_EXCLUDE, DEFAULT_DECORATORS, toClassName, type BundleConfigFile, type ClassSelector, type ExportKind, type ResolvedClassSelector, type PathSelector, type ResolvedPathSelector, type BundleConfig, type ConfigFormat, } from './features/bundle/BuildConfig.js';
 export { ticConfigJsonSchema } from './schema/ticConfigSchema.js';