@ts-ioc-container/bundler 2.0.0 → 2.1.0

package/cjm/build.js

@@ -1,106 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TSCONFIG_FILE = void 0;
-exports.build = build;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const config_1 = require("./config");
-const emit_1 = require("./emit");
-const glob_1 = require("./glob");
-const errors_1 = require("./errors");
-const scan_1 = require("./scan");
-const tsconfig_1 = require("./tsconfig");
-exports.TSCONFIG_FILE = 'tsconfig.json';
-function build({ config, cwd = process.cwd(), check = false } = {}) {
-    const resolved = config === undefined
-        ? (0, config_1.resolveConfig)({ extends: config_1.DEFAULT_EXTENDS }, node_path_1.default.join((0, config_1.findPackageRoot)(cwd), exports.TSCONFIG_FILE))
-        : (0, config_1.loadConfig)(node_path_1.default.resolve(cwd, config));
-    const { output, content, registrations, warnings } = generate(resolved);
-    const current = (0, node_fs_1.existsSync)(output) ? (0, node_fs_1.readFileSync)(output, 'utf8') : undefined;
-    const status = current === content ? 'unchanged' : check ? 'stale' : 'written';
-    if (status === 'written') {
-        (0, node_fs_1.mkdirSync)(node_path_1.default.dirname(output), { recursive: true });
-        (0, node_fs_1.writeFileSync)(output, content);
-    }
-    return {
-        config: resolved.file,
-        output: { file: output, bundle: resolved.className, status, registrations, content },
-        warnings: [...resolved.warnings, ...warnings],
-    };
-}
-function generate(config) {
-    const { importPaths: paths, fileNames, rootDir } = (0, tsconfig_1.loadTsconfig)(config.tsconfig, config.importExtension);
-    const output = config.output ?? (rootDir && node_path_1.default.join(rootDir, `${config.name}.bundle.ts`));
-    if (output === undefined)
-        throw new errors_1.TicConfigError('output: required when there is no tsconfig to extend');
-    const relative = (file) => (0, glob_1.toPosix)(node_path_1.default.relative(config.dir, file));
-    const { include, exclude } = config.files;
-    const isExcluded = (file) => {
-        if (file === output)
-            return true;
-        const filename = relative(file);
-        if (include && !include.some((glob) => glob.test(filename)))
-            return true;
-        return exclude.some((glob) => glob.test(filename));
-    };
-    const files = new Set();
-    if (config.files.paths) {
-        for (const entry of config.files.paths) {
-            const dir = paths.resolveNamespace(entry.path, config.dir);
-            for (const file of (0, scan_1.listSourceFiles)(dir, entry.recursive, isExcluded))
-                files.add(file);
-        }
-    }
-    else if (fileNames) {
-        for (const file of fileNames)
-            if ((0, scan_1.isSourceFile)(file) && !isExcluded(file))
-                files.add(file);
-    }
-    else {
-        throw new errors_1.TicConfigError(`files.paths: required when there is no tsconfig to extend (${config.tsconfig.file} not found)`);
-    }
-    const classes = [...files]
-        .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0))
-        .flatMap((file) => {
-        const text = (0, node_fs_1.readFileSync)(file, 'utf8');
-        return text.startsWith(emit_1.GENERATED_HEADER) ? [] : (0, scan_1.findClasses)(file, config.classes, text);
-    })
-        .map((cls) => ({ ...cls, specifier: paths.specifier(output, cls.file) }));
-    const content = (0, emit_1.emitBundle)({
-        name: config.className,
-        configPath: (0, glob_1.toPosix)(node_path_1.default.relative(node_path_1.default.dirname(output), config.file)),
-        paths: config.files.paths?.map((entry) => entry.path),
-        tsconfigPath: (0, glob_1.toPosix)(node_path_1.default.relative(node_path_1.default.dirname(output), config.tsconfig.file)),
-        classes,
-    });
-    return { output, content, registrations: classes.length, warnings: tokenCollisions(classes) };
-}
-function tokenCollisions(classes) {
-    const owners = new Map();
-    for (const cls of classes) {
-        for (const token of cls.tokens) {
-            const group = owners.get(token) ?? [];
-            if (!group.some((owner) => owner.className === cls.className))
-                group.push(cls);
-            owners.set(token, group);
-        }
-    }
-    return [...owners]
-        .filter(([, group]) => group.length > 1 && !scopeDisjoint(group))
-        .sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))
-        .map(([token, group]) => {
-        const names = group.map((cls) => cls.className);
-        return (`decorator token "${token}" is passed by ${names.join(', ')}; ` +
-            `registration is last-wins, exclude one with classes.excludeClasses`);
-    });
-}
-function scopeDisjoint(group) {
-    const [first, ...rest] = group;
-    return first.decoratorCalls.some(({ name, args }) => rest.every((cls) => {
-        const same = cls.decoratorCalls.find((call) => call.name === name);
-        return same !== undefined && same.args.join('\u0000') !== args.join('\u0000');
-    }));
-}

package/cjm/cli.js

@@ -1,109 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = run;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const build_1 = require("./build");
-const config_1 = require("./config");
-const errors_1 = require("./errors");
-const USAGE = [
-    'Usage: ts-ioc-container <command> [options]',
-    '       tic is a shortcut for ts-ioc-container',
-    '',
-    'Commands:',
-    '  ts-ioc-container build [--config <path>]... [--check]   generate one bundle per *.bundle.{json,yaml,yml} config',
-    '                                                          (none: one bundle from tsconfig.json, all defaults)',
-    '',
-    'Options:',
-    '  -c, --config <path>   build only this config; repeatable (default: every *.bundle.{json,yaml,yml} of the package, else tsconfig.json)',
-    '  --check               write nothing; exit 1 when a generated bundle is out of date',
-    '  -h, --help            show this help',
-    '  -v, --version         show the version',
-].join('\n');
-const VERB = { written: 'wrote', unchanged: 'unchanged', stale: 'stale' };
-const plural = (n) => `${n} registration${n === 1 ? '' : 's'}`;
-function version() {
-    return JSON.parse((0, node_fs_1.readFileSync)(node_path_1.default.join(__dirname, '..', 'package.json'), 'utf8')).version;
-}
-class UsageError extends errors_1.TicError {
-}
-function parseBuildArgs(args) {
-    const options = { configs: [], check: false };
-    for (let i = 0; i < args.length; i++) {
-        const arg = args[i];
-        if (arg === '--check')
-            options.check = true;
-        else if (arg === '--config' || arg === '-c') {
-            const config = args[++i];
-            if (!config)
-                throw new UsageError(`${arg} needs a path`);
-            options.configs.push(config);
-        }
-        else if (arg.startsWith('--config='))
-            options.configs.push(arg.slice('--config='.length));
-        else
-            throw new UsageError(`unknown option "${arg}"`);
-    }
-    return options;
-}
-function configsToBuild(named, cwd) {
-    if (named.length > 0)
-        return named.map((config) => node_path_1.default.resolve(cwd, config));
-    const root = (0, config_1.findPackageRoot)(cwd);
-    const found = (0, config_1.findConfigFiles)(root);
-    if (found.length > 0)
-        return found;
-    if ((0, node_fs_1.existsSync)(node_path_1.default.join(root, build_1.TSCONFIG_FILE)))
-        return [undefined];
-    throw new errors_1.TicConfigError(`no *.bundle.{json,yaml,yml} or ${build_1.TSCONFIG_FILE} in ${root}; name a config with --config`);
-}
-function run(argv, io = { cwd: process.cwd(), stdout: console.log, stderr: console.error }) {
-    const [command, ...rest] = argv;
-    if (command === '--help' || command === '-h' || command === 'help') {
-        io.stdout(USAGE);
-        return 0;
-    }
-    if (command === '--version' || command === '-v') {
-        io.stdout(version());
-        return 0;
-    }
-    try {
-        if (command !== 'build') {
-            io.stderr(command ? `tic: unknown command "${command}"` : USAGE);
-            return 1;
-        }
-        const { configs, check } = parseBuildArgs(rest);
-        let stale = 0;
-        for (const config of configsToBuild(configs, io.cwd)) {
-            const name = config === undefined ? build_1.TSCONFIG_FILE : node_path_1.default.relative(io.cwd, config);
-            try {
-                const { output, warnings } = (0, build_1.build)({ config, check, cwd: io.cwd });
-                for (const warning of warnings)
-                    io.stderr(`tic: warning: ${name}: ${warning}`);
-                const { status, file, registrations } = output;
-                io.stdout(`${VERB[status].padEnd(10)}${node_path_1.default.relative(io.cwd, file)} (${plural(registrations)})`);
-                if (status === 'stale')
-                    stale++;
-            }
-            catch (e) {
-                if (e instanceof errors_1.TicError)
-                    e.message = `${name}: ${e.message}`;
-                throw e;
-            }
-        }
-        if (stale > 0) {
-            io.stderr(`tic: ${stale} generated bundle${stale === 1 ? ' is' : 's are'} out of date — run \`tic build\``);
-            return 1;
-        }
-        return 0;
-    }
-    catch (e) {
-        if (!(e instanceof errors_1.TicError))
-            throw e;
-        io.stderr(`tic: ${e.message}`);
-        return 1;
-    }
-}

package/cjm/config.js

@@ -1,199 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_EXCLUDE = exports.DEFAULT_DECORATORS = exports.DEFAULT_BUNDLE_NAME = exports.DEFAULT_EXTENDS = exports.CONFIG_FILE_SUFFIXES = void 0;
-exports.resolveConfig = resolveConfig;
-exports.toClassName = toClassName;
-exports.findPackageRoot = findPackageRoot;
-exports.findConfigFiles = findConfigFiles;
-exports.loadConfig = loadConfig;
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const yaml_1 = require("yaml");
-const errors_1 = require("./errors");
-const glob_1 = require("./glob");
-exports.CONFIG_FILE_SUFFIXES = ['.bundle.json', '.bundle.yaml', '.bundle.yml'];
-const configSuffix = (file) => exports.CONFIG_FILE_SUFFIXES.find((suffix) => file.endsWith(suffix));
-exports.DEFAULT_EXTENDS = './tsconfig.json';
-exports.DEFAULT_BUNDLE_NAME = 'base';
-exports.DEFAULT_DECORATORS = ['register'];
-exports.DEFAULT_EXCLUDE = [
-    '**/*.spec.ts',
-    '**/*.test.ts',
-    '**/*.spec.tsx',
-    '**/*.test.tsx',
-    '**/__tests__/**',
-    '**/node_modules/**',
-];
-const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
-const isNonEmptyString = (value) => typeof value === 'string' && value.length > 0;
-const isStringArray = (value) => Array.isArray(value) && value.every(isNonEmptyString);
-const isBundleName = (value) => typeof value === 'string' && /^[A-Za-z][\w-]*$/.test(value);
-const fail = (field, expected) => {
-    throw new errors_1.TicConfigError(`${field}: expected ${expected}`);
-};
-function toPath(value, field) {
-    if (isNonEmptyString(value))
-        return { path: value, recursive: true };
-    if (!isObject(value))
-        return fail(field, 'a string or an object with "path"');
-    if (!isNonEmptyString(value.path))
-        return fail(`${field}.path`, 'a non-empty string');
-    if (value.recursive !== undefined && typeof value.recursive !== 'boolean')
-        return fail(`${field}.recursive`, 'a boolean');
-    return { path: value.path, recursive: value.recursive ?? true };
-}
-const FILE_SELECTOR_FIELDS = new Set(['paths', 'include', 'exclude']);
-function toFileSelector(value, field) {
-    if (value === undefined)
-        return { exclude: exports.DEFAULT_EXCLUDE.map(glob_1.globToRegExp) };
-    if (!isObject(value))
-        return fail(field, 'an object');
-    const unknown = Object.keys(value).find((key) => !FILE_SELECTOR_FIELDS.has(key));
-    if (unknown)
-        throw new errors_1.TicConfigError(`${field}.${unknown}: unknown field`);
-    const { paths, include, exclude } = value;
-    if (paths !== undefined && !(Array.isArray(paths) && paths.length > 0)) {
-        return fail(`${field}.paths`, 'a non-empty array');
-    }
-    if (include !== undefined && !(isStringArray(include) && include.length > 0)) {
-        return fail(`${field}.include`, 'a non-empty array of strings');
-    }
-    if (exclude !== undefined && !isStringArray(exclude))
-        return fail(`${field}.exclude`, 'an array of strings');
-    return {
-        paths: paths?.map((entry, i) => toPath(entry, `${field}.paths[${i}]`)),
-        include: include?.map(glob_1.globToRegExp),
-        exclude: (exclude ?? exports.DEFAULT_EXCLUDE).map(glob_1.globToRegExp),
-    };
-}
-const CLASS_SELECTOR_FIELDS = new Set(['export', 'decorators', 'name', 'excludeClasses', 'excludeName']);
-function toClassSelector(value, field) {
-    if (value === undefined)
-        return { export: 'any', decorators: exports.DEFAULT_DECORATORS };
-    if (!isObject(value))
-        return fail(field, 'an object');
-    const unknown = Object.keys(value).find((key) => !CLASS_SELECTOR_FIELDS.has(key));
-    if (unknown)
-        throw new errors_1.TicConfigError(`${field}.${unknown}: unknown field`);
-    const { export: kind, decorators, name, excludeClasses, excludeName } = value;
-    if (kind !== undefined && kind !== 'any' && kind !== 'named' && kind !== 'default') {
-        return fail(`${field}.export`, '"any", "named" or "default"');
-    }
-    if (decorators !== undefined && !isStringArray(decorators))
-        return fail(`${field}.decorators`, 'an array of strings');
-    if (name !== undefined && !isNonEmptyString(name))
-        return fail(`${field}.name`, 'a non-empty string');
-    if (excludeClasses !== undefined && !(isStringArray(excludeClasses) && excludeClasses.length > 0)) {
-        return fail(`${field}.excludeClasses`, 'a non-empty array of strings');
-    }
-    if (excludeName !== undefined && !isNonEmptyString(excludeName)) {
-        return fail(`${field}.excludeName`, 'a non-empty string');
-    }
-    return {
-        export: kind ?? 'any',
-        decorators: decorators === undefined ? exports.DEFAULT_DECORATORS : decorators.length > 0 ? decorators : undefined,
-        name: name === undefined ? undefined : (0, glob_1.globToRegExp)(name),
-        excludeClasses,
-        excludeName: excludeName === undefined ? undefined : (0, glob_1.globToRegExp)(excludeName),
-    };
-}
-function excludeWarnings(files) {
-    if (!isObject(files))
-        return [];
-    const exclude = files.exclude;
-    if (!isStringArray(exclude) || exclude.length === 0)
-        return [];
-    const missing = exports.DEFAULT_EXCLUDE.filter((glob) => !exclude.includes(glob));
-    if (missing.length === 0)
-        return [];
-    return [
-        `files.exclude replaces the default excludes and omits ${missing.map((glob) => `"${glob}"`).join(', ')}; ` +
-            `add them back`,
-    ];
-}
-const CONFIG_FIELDS = new Set(['$schema', 'output', 'name', 'tags', 'extends', 'importExtension', 'files', 'classes']);
-function resolveConfig(content, file) {
-    const dir = node_path_1.default.dirname(file);
-    if (!isObject(content))
-        return fail('config', 'an object');
-    const unknown = Object.keys(content).find((key) => !CONFIG_FIELDS.has(key));
-    if (unknown)
-        throw new errors_1.TicConfigError(`${unknown}: unknown field`);
-    const { output, name, tags, extends: tsconfig, importExtension, files, classes } = content;
-    if (output !== undefined && !isNonEmptyString(output))
-        return fail('output', 'a non-empty string');
-    if (name !== undefined && !isBundleName(name)) {
-        return fail('name', 'letters, digits, "-" or "_", starting with a letter');
-    }
-    const bundleName = name ?? configStem(file) ?? exports.DEFAULT_BUNDLE_NAME;
-    if (tags !== undefined && !isStringArray(tags))
-        return fail('tags', 'an array of strings');
-    if (tsconfig !== undefined && !isNonEmptyString(tsconfig))
-        return fail('extends', 'a non-empty string');
-    if (importExtension !== undefined && typeof importExtension !== 'string')
-        return fail('importExtension', 'a string');
-    return {
-        file,
-        dir,
-        output: output === undefined ? undefined : node_path_1.default.resolve(dir, output),
-        name: bundleName,
-        className: toClassName(bundleName),
-        tags: tags ?? [],
-        tsconfig: { file: node_path_1.default.resolve(dir, tsconfig ?? exports.DEFAULT_EXTENDS), required: tsconfig !== undefined },
-        importExtension,
-        files: toFileSelector(files, 'files'),
-        classes: toClassSelector(classes, 'classes'),
-        warnings: excludeWarnings(files),
-    };
-}
-function configStem(file) {
-    const base = node_path_1.default.basename(file);
-    const suffix = configSuffix(base);
-    const stem = suffix ? base.slice(0, -suffix.length) : '';
-    return isBundleName(stem) ? stem : undefined;
-}
-function toClassName(name) {
-    const words = name.split(/[-_]+/).filter(Boolean);
-    return `${words.map((word) => word[0].toUpperCase() + word.slice(1)).join('')}Bundle`;
-}
-function findPackageRoot(dir) {
-    const start = node_path_1.default.resolve(dir);
-    for (let current = start;; current = node_path_1.default.dirname(current)) {
-        if ((0, node_fs_1.existsSync)(node_path_1.default.join(current, 'package.json')))
-            return current;
-        if (node_path_1.default.dirname(current) === current)
-            return start;
-    }
-}
-function findConfigFiles(dir) {
-    const files = (0, node_fs_1.readdirSync)(dir, { withFileTypes: true })
-        .filter((entry) => entry.isFile() && configSuffix(entry.name) !== undefined)
-        .map((entry) => entry.name)
-        .sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));
-    const byStem = new Map();
-    for (const file of files) {
-        const stem = file.slice(0, -configSuffix(file).length);
-        const other = byStem.get(stem);
-        if (other)
-            throw new errors_1.TicConfigError(`${other} and ${file} describe the same bundle; keep one`);
-        byStem.set(stem, file);
-    }
-    return files.map((file) => node_path_1.default.join(dir, file));
-}
-function parseConfig(file, text) {
-    const yaml = file.endsWith('.yaml') || file.endsWith('.yml');
-    try {
-        return yaml ? ((0, yaml_1.parse)(text) ?? {}) : JSON.parse(text);
-    }
-    catch (e) {
-        throw new errors_1.TicConfigError(`${file} is not valid ${yaml ? 'YAML' : 'JSON'}: ${e.message}`);
-    }
-}
-function loadConfig(file) {
-    if (!(0, node_fs_1.existsSync)(file))
-        throw new errors_1.TicConfigError(`config file not found: ${file}`);
-    return resolveConfig(parseConfig(file, (0, node_fs_1.readFileSync)(file, 'utf8')), file);
-}

package/cjm/errors.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NamespaceNotFoundError = exports.TicConfigError = exports.TicError = void 0;
-class TicError extends Error {
-    name = 'TicError';
-}
-exports.TicError = TicError;
-class TicConfigError extends TicError {
-    name = 'TicConfigError';
-}
-exports.TicConfigError = TicConfigError;
-class NamespaceNotFoundError extends TicError {
-    name = 'NamespaceNotFoundError';
-}
-exports.NamespaceNotFoundError = NamespaceNotFoundError;

package/cjm/render.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderProtocol = renderProtocol;
-require("../tpl/index.cjs");
-const handlebars_1 = __importDefault(require("handlebars"));
-handlebars_1.default.registerHelper('join', (items, separator) => items.join(separator));
-function renderProtocol(name, data) {
-    const protocol = handlebars_1.default.templates?.[name];
-    if (!protocol)
-        throw new Error(`Protocol not found: ${name}`);
-    return protocol(data);
-}

package/typings/build.d.ts

@@ -1,42 +0,0 @@
-/** The tsconfig a build without a config file extends. */
-export declare const TSCONFIG_FILE = "tsconfig.json";
-export interface BuildOptions {
-    /**
-     * Path of the `*.bundle.json` to build, relative to `cwd`. Omitted: build from the
-     * `tsconfig.json` of the package `cwd` is in (see `findPackageRoot`), every setting at its default.
-     */
-    config?: string;
-    /** Default `process.cwd()`. */
-    cwd?: string;
-    /** Compare instead of writing: outputs that would change are reported `stale`. */
-    check?: boolean;
-}
-/** `written` / `unchanged` after a build; `stale` / `unchanged` after a check. */
-export type OutputStatus = 'written' | 'unchanged' | 'stale';
-export interface OutputResult {
-    /** Absolute path of the generated file. */
-    file: string;
-    /** Name of the generated class. */
-    bundle: string;
-    status: OutputStatus;
-    registrations: number;
-    content: string;
-}
-export interface BuildResult {
-    /** Absolute path of the config that was built. */
-    config: string;
-    output: OutputResult;
-    /**
-     * Non-fatal problems found while building, e.g. a `files.exclude` that drops a default
-     * test glob or two selected classes passing the same decorator token.
-     */
-    warnings: string[];
-}
-/**
- * Generates the bundle a config describes. Nothing is written unless generation succeeds.
- *
- * @throws {TicConfigError} when the config or its tsconfig is missing or invalid, or the config has neither `files.paths` nor a tsconfig.
- * @throws {NamespaceNotFoundError} when a path is neither a folder nor a tsconfig paths alias of one.
- */
-export declare function build({ config, cwd, check }?: BuildOptions): BuildResult;
-//# sourceMappingURL=build.d.ts.map

package/typings/cli.d.ts

@@ -1,8 +0,0 @@
-export interface CliIo {
-    cwd: string;
-    stdout: (line: string) => void;
-    stderr: (line: string) => void;
-}
-/** Runs the `tic` CLI and returns its exit code; output goes through `io`. */
-export declare function run(argv: string[], io?: CliIo): number;
-//# sourceMappingURL=cli.d.ts.map

package/typings/errors.d.ts

@@ -1,13 +0,0 @@
-/** Base class of every error the bundler raises on purpose; the CLI prints its message without a stack. */
-export declare class TicError extends Error {
-    name: string;
-}
-/** The config file is missing, is not JSON, or does not match the `.bundles.json` shape. */
-export declare class TicConfigError extends TicError {
-    name: string;
-}
-/** A namespace is neither an existing folder nor a `tsconfig.json` `paths` alias of one. */
-export declare class NamespaceNotFoundError extends TicError {
-    name: string;
-}
-//# sourceMappingURL=errors.d.ts.map

package/typings/render.d.ts

@@ -1,8 +0,0 @@
-import '../tpl/index.cjs';
-/**
- * Renders a precompiled protocol, looked up by its file basename (`Bundle.ts.hbs`).
- *
- * @throws {Error} when no protocol is registered under `name`.
- */
-export declare function renderProtocol(name: string, data: unknown): string;
-//# sourceMappingURL=render.d.ts.map