load-populate-files 1.1.2 → 1.1.4

package/README.md

@@ -8,7 +8,7 @@ Load and dynamically populate file content based on a single file's config.
 
 </div>
 
-Guides and the full reference are on the [docs site](https://jacobley.github.io/leyman/populate-files/guides/config-modules).
+Guides and the full reference are on the [docs site](https://jacobley.github.io/leyman/packages/populate-files/), including [Config modules](https://jacobley.github.io/leyman/packages/populate-files/guides/config-modules) for this package.
 
 ## Contents
 
@@ -30,7 +30,7 @@ npm i load-populate-files
 ## Example
 
 ```ts
-// config.ts
+// config.ts, compiled to config.js
 export default [
     {
         filePath: './foo.json',
@@ -54,7 +54,7 @@ await loadAndPopulateFiles({ filePath: './config.js' });
 
 `load-populate-files` is an ESM module. It must be `import`ed. To load from a CJS module, use dynamic import: `const { loadAndPopulateFiles } = await import('load-populate-files');`.
 
-Instead of calling `populateFiles()` directly, export file configs from a dedicated config module, then point `loadAndPopulateFiles()` at that file. The loaded file may export a single config object or an array of configs.
+Instead of calling `populateFiles()` directly, export file configs from a dedicated config module, then point `loadAndPopulateFiles()` at that file. The config module is loaded with `import()`, so it must be JavaScript that Node can run: point at the compiled `.js`, not the `.ts` source. Its default export may be a single config object or an array of configs.
 
 This package is also available as a CLI:
 
@@ -78,15 +78,17 @@ Loads the config exported at `params.filePath` and passes it to [`populateFiles(
 
 **Returns** `Promise<PopulationResponse[]>`, from `populateFiles()`.
 
+**Throws** (rejects) `Error` with `JS file not found: <path>` if the module doesn't exist, or with `File content does not fulfill populate-file input at: <path>` followed by a line per problem (e.g. `- 0.filePath: must have required property 'filePath'`) if the default export isn't a valid config. Errors from `populateFiles()` (such as a `PopulateFilesCheckError` with `check`) pass through. The CLI prints the error and exits with code 1.
+
 #### `options`
 
 Options are passed through to the underlying `populateFiles()` call. They are also available as CLI flags.
 
 | Property | CLI flag | Type | Default | Description |
 |----------|----------|------|---------|-------------|
-| `check` | `--ci` | `boolean` | `true` in CI, else `false` | If `true`, fails if writing a file would change its content. Useful for verifying version-controlled files are up to date before deployment. |
+| `check` | `--ci`, `--check` (`--no-ci` to write in CI) | `boolean` | `true` in CI, else `false` | If `true`, fails if writing a file would change its content. Useful for verifying version-controlled files are up to date before deployment. |
 | `dryRun` | `--dry-run` | `boolean` | `false` | If `true`, does not write any files regardless of changes. Can still fail if `check` is `true`. |
-| `cwd` | `--cwd` | `string \| URL` | `process.env.PWD` | Used as the current working directory for `filePath` and re-used for relative `filePath`s in the loaded config. |
+| `cwd` | `--cwd` | `string \| URL` | `process.cwd()` | Used as the current working directory for `filePath` and the `targetDir` and `manifest` paths. Must be an existing directory. |
 | `targetDir` | `--target-dir`, `-t` | `string` | `'.'` | Target directory for resolving output file paths. Resolved relative to `cwd`. |
 | `clean` | `--clean` | `boolean` | `false` | If `true`, removes files in `targetDir` that were not generated (with `manifest`, only files it lists). In `--ci` mode, fails instead of removing. |
 | `force` | `--force` | `boolean` | `false` | Applies to `signed` files and the `manifest`. If `true`, overwrites files that were edited, are not signed or not listed, or are malformed. See [`populate-files`](https://www.npmjs.com/package/populate-files#signed-files). |

package/bin.mjs

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-export { default } from './dist/bin.js';
+export { default } from './dist/cli.js';

package/dist/cli.d.ts

@@ -1,24 +1,13 @@
-import type { Main } from 'entry-script';
-import type { RegisterCommand } from './commands/lib/types.js';
+import { EntryScript } from 'entry-script';
 /**
  * LoadPopulateFiles CLI. Run `./bin.mjs --help` for options.
- *
- * Uses `yargs` package for command line parsing and logic flow.
  */
-export declare class LoadPopulateFilesCli implements Main {
-    #private;
-    /**
-     * @param commands - every command the CLI runs
-     */
-    constructor(commands: readonly RegisterCommand[]);
+export default class Cli extends EntryScript {
     /**
      * Entry point to CLI script.
      *
-     * Sets high level Yargs settings. Command/options logic is implemented in individual command modules.
-     *
      * @param argv - process arguments
      */
-    main(argv: string[]): Promise<void>;
+    static main(argv: string[]): Promise<void>;
 }
-export declare const loadPopulateFilesCliBinding: import("haywire").Binding<import("haywire").OutputHaywireId<import("haywire").HaywireId<LoadPopulateFilesCli, typeof LoadPopulateFilesCli, null, false, false, false, false, false>>, [import("haywire").HaywireId<RegisterCommand, null, null, true, false, false, false, false>], false>;
 //# sourceMappingURL=cli.d.ts.map

package/dist/cli.js

@@ -1,18 +1,25 @@
+import { isCI } from 'ci-info';
 import yargs from 'yargs';
-import { bind } from 'haywire';
-import { commandId } from './commands/lib/types.js';
-export class LoadPopulateFilesCli {
-    #commands;
-    constructor(commands){
-        this.#commands = commands;
+import { EntryScript } from "entry-script";
+import { loadAndPopulateFiles } from './lib/load-populate-files.js';
+const yargsOutput = (e, _argv, log)=>{
+    if (e) {
+        process.exitCode = 1;
+        if (log) {
+            console.error(log);
+        }
+    } else if (log) {
+        console.log(log);
     }
-    async main(argv) {
+};
+export default class Cli extends EntryScript {
+    static async main(argv) {
         const packageJson = await import('../package.json', {
             with: {
                 type: 'json'
             }
         });
-        let cli = yargs().scriptName('load-populate-files').option({
+        await yargs().scriptName('load-populate-files').option({
             cwd: {
                 type: 'string',
                 default: '.',
@@ -24,25 +31,54 @@ export class LoadPopulateFilesCli {
                 describe: 'Target directory for resolving output file paths. Defaults to resolved cwd.',
                 alias: 't'
             }
-        }).strict().help().alias('help', 'info').version(packageJson.default.version);
-        for (const register of this.#commands){
-            cli = register(cli);
-        }
-        await cli.parseAsync(argv, {}, LoadPopulateFilesCli.#yargsOutput);
-    }
-    static #yargsOutput(e, _argv, log) {
-        if (e) {
-            process.exitCode = 1;
-            if (log) {
-                console.error(log);
-            }
-        } else if (log) {
-            console.log(log);
-        }
+        }).strict().help().alias('help', 'info').version(packageJson.default.version).command([
+            '$0',
+            'load-populate-files'
+        ], 'Read pre-generated content and write to file', (command)=>command.options({
+                filePath: {
+                    describe: 'File that exports data content to populate',
+                    type: 'string',
+                    required: true
+                },
+                ci: {
+                    describe: 'Fail if file is not up to date. Implies --dry-run',
+                    type: 'boolean',
+                    default: isCI,
+                    alias: 'check'
+                },
+                dryRun: {
+                    describe: 'Do not write file',
+                    type: 'boolean',
+                    default: false
+                },
+                clean: {
+                    describe: 'Remove files in --target-dir that were not generated. In --ci mode, fail instead of removing.',
+                    type: 'boolean',
+                    default: false
+                },
+                force: {
+                    describe: 'Overwrite signed files even if they were edited, are not signed, or would lose manual sections',
+                    type: 'boolean',
+                    default: false
+                },
+                manifest: {
+                    describe: 'Record generated files in this manifest (relative to --cwd), to detect edits to them and only --clean files it lists',
+                    type: 'string'
+                }
+            }).strict(), async (options)=>{
+            await loadAndPopulateFiles({
+                filePath: options.filePath
+            }, {
+                cwd: options.cwd,
+                targetDir: options.targetDir,
+                check: options.ci,
+                dryRun: options.dryRun,
+                clean: options.clean,
+                force: options.force,
+                manifest: options.manifest
+            });
+        }).parseAsync(argv, {}, yargsOutput);
     }
 }
-export const loadPopulateFilesCliBinding = bind(LoadPopulateFilesCli).withDependencies([
-    commandId
-]).withConstructorProvider();
 
 //# sourceMappingURL=cli.js.map

package/dist/lib/loader.d.ts

@@ -4,6 +4,7 @@ import type { PopulateFileParams } from 'populate-files';
  *
  * @param filePath - absolute path to JS file
  * @returns list of populate-files params exported by the file
+ * @rejects {Error} if the file doesn't exist, fails to load, or doesn't export populate-files params
  */
 export declare const loadFile: (filePath: string) => Promise<PopulateFileParams[]>;
 //# sourceMappingURL=loader.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "load-populate-files",
-  "version": "1.1.2",
-  "description": "Load and dynamically populate file content",
+  "version": "1.1.4",
+  "description": "Load and dynamically populate file content based on a single file's config.",
   "engines": {
     "node": ">=24"
   },
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/JacobLey/leyman.git",
     "directory": "apps/populate-files/load-populate-files"
   },
-  "homepage": "https://github.com/JacobLey/leyman/tree/main/apps/populate-files/load-populate-files#readme",
+  "homepage": "https://jacobley.github.io/leyman/packages/populate-files/",
   "bugs": {
     "url": "https://github.com/JacobLey/leyman/issues"
   },
@@ -38,32 +38,30 @@
   },
   "dependencies": {
     "ci-info": "^4.4.0",
-    "default-import": "^3.0.1",
-    "entry-script": "^4.1.1",
-    "haywire": "^2.0.2",
-    "haywire-launcher": "^1.1.0",
-    "juniper": "^2.4.1",
-    "juniper-validator": "^0.5.0",
-    "parse-cwd": "^2.0.2",
-    "populate-files": "^1.1.2",
-    "unknown-error": "^0.1.0",
+    "default-import": "^3.0.2",
+    "entry-script": "^4.1.2",
+    "juniper": "^2.6.0",
+    "juniper-validator": "^0.5.2",
+    "parse-cwd": "^2.0.3",
+    "populate-files": "^1.2.0",
+    "unknown-error": "^0.1.1",
     "yargs": "^18.2.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.5.14",
+    "@biomejs/biome": "^2.6.3",
     "@leyman/eslint-config": "^0.0.1",
     "@leyman/expect": "^0.0.1",
     "@swc/cli": "^0.8.1",
-    "@swc/core": "^1.16.2",
+    "@swc/core": "^1.16.20",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24.19.0",
+    "@types/node": "^24.19.2",
     "@types/yargs": "^17.0.35",
     "@typescript/native": "npm:typescript@^7.0.2",
     "c8": "^12.0.0",
-    "eslint": "^10.12.0",
-    "generated-signature": "^0.1.1",
-    "mocha": "^12.0.2",
-    "mocha-chain": "^1.0.1",
+    "eslint": "^10.13.0",
+    "generated-signature": "^0.1.3",
+    "mocha": "^12.0.3",
+    "mocha-chain": "^1.0.2",
     "tmp-promise": "^3.0.3",
     "typescript": "npm:@typescript/typescript6@^6.0.2"
   },

package/dist/bin.d.ts

@@ -1,3 +0,0 @@
-declare const _default: import("haywire-launcher").WrapperMain;
-export default _default;
-//# sourceMappingURL=bin.d.ts.map

package/dist/bin.js

@@ -1,7 +0,0 @@
-import { identifier } from 'haywire';
-import { launch } from 'haywire-launcher';
-import { LoadPopulateFilesCli } from './cli.js';
-import { cliContainer } from './container.js';
-export default launch(cliContainer, identifier(LoadPopulateFilesCli));
-
-//# sourceMappingURL=bin.js.map

package/dist/commands/lib/types.d.ts

@@ -1,20 +0,0 @@
-import type { Argv, CommandModule } from 'yargs';
-export interface LoadPopulateFilesCommandInput {
-    cwd: string;
-    targetDir: string;
-}
-export type Command<ExtendedInput extends LoadPopulateFilesCommandInput> = Pick<CommandModule<LoadPopulateFilesCommandInput, ExtendedInput>, 'builder' | 'command' | 'describe' | 'handler'>;
-/**
- * Adds a command to the CLI.
- *
- * Commands differ in the input their handler receives, so they cannot share an element type.
- * Wrapping each in a function that registers it keeps every command type-checked against its own input.
- */
-export type RegisterCommand = (cli: Argv<LoadPopulateFilesCommandInput>) => Argv<LoadPopulateFilesCommandInput>;
-/**
- * Every command the CLI runs. Each command binds itself:
- *
- * `bind(commandId).withInstance(cli => cli.command(myCommand))`
- */
-export declare const commandId: import("haywire").HaywireId<RegisterCommand, null, null, true, false, false, false, false>;
-//# sourceMappingURL=types.d.ts.map

package/dist/commands/lib/types.js

@@ -1,4 +0,0 @@
-import { identifier } from 'haywire';
-export const commandId = identifier().list();
-
-//# sourceMappingURL=types.js.map

package/dist/commands/load-populate-files-command.d.ts

@@ -1,16 +0,0 @@
-import type { Command, LoadPopulateFilesCommandInput } from './lib/types.js';
-interface LoadPopulateFilesCommandExtendedInput extends LoadPopulateFilesCommandInput {
-    filePath: string;
-    ci: boolean;
-    dryRun: boolean;
-    clean: boolean;
-    force: boolean;
-    manifest: string | undefined;
-}
-/**
- * Main `load-populate-files` command
- */
-export declare const loadPopulateFilesCommand: Command<LoadPopulateFilesCommandExtendedInput>;
-export declare const loadPopulateFilesCommandBinding: import("haywire").Binding<import("haywire").OutputHaywireId<import("haywire").HaywireId<import("./lib/types.js").RegisterCommand, null, null, true, false, false, false, false>>, [], false>;
-export {};
-//# sourceMappingURL=load-populate-files-command.d.ts.map

package/dist/commands/load-populate-files-command.js

@@ -1,59 +0,0 @@
-import { isCI } from 'ci-info';
-import { bind } from 'haywire';
-import { loadAndPopulateFiles } from '../lib/load-populate-files.js';
-import { commandId } from './lib/types.js';
-export const loadPopulateFilesCommand = {
-    command: [
-        '$0',
-        'load-populate-files'
-    ],
-    describe: 'Read pre-generated content and write to file',
-    builder: (yargs)=>yargs.options({
-            filePath: {
-                describe: 'File that exports data content to populate',
-                type: 'string',
-                required: true
-            },
-            ci: {
-                describe: 'Fail if file is not up to date. Implies --dry-run',
-                type: 'boolean',
-                default: isCI,
-                alias: 'check'
-            },
-            dryRun: {
-                describe: 'Do not write file',
-                type: 'boolean',
-                default: false
-            },
-            clean: {
-                describe: 'Remove files in --target-dir that were not generated. In --ci mode, fail instead of removing.',
-                type: 'boolean',
-                default: false
-            },
-            force: {
-                describe: 'Overwrite signed files even if they were edited, are not signed, or would lose manual sections',
-                type: 'boolean',
-                default: false
-            },
-            manifest: {
-                describe: 'Record generated files in this manifest (relative to --cwd), to detect edits to them and only --clean files it lists',
-                type: 'string'
-            }
-        }).strict(),
-    handler: async (options)=>{
-        await loadAndPopulateFiles({
-            filePath: options.filePath
-        }, {
-            cwd: options.cwd,
-            targetDir: options.targetDir,
-            check: options.ci,
-            dryRun: options.dryRun,
-            clean: options.clean,
-            force: options.force,
-            manifest: options.manifest
-        });
-    }
-};
-export const loadPopulateFilesCommandBinding = bind(commandId).withInstance((cli)=>cli.command(loadPopulateFilesCommand));
-
-//# sourceMappingURL=load-populate-files-command.js.map

package/dist/container.d.ts

@@ -1,3 +0,0 @@
-export declare const cliModule: import("haywire").Module<[import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, false, false>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, false, true>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, true, false>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, true, true>], [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>], [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>], false>;
-export declare const cliContainer: import("haywire").SyncContainer<[import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, false, false>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, false, true>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, true, false>] | [import("haywire").NonExtendable<import("./cli.js").LoadPopulateFilesCli, typeof import("./cli.js").LoadPopulateFilesCli, null, false, true, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, false, true>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, false>] | [import("haywire").NonExtendable<import("./commands/lib/types.js").RegisterCommand, null, null, true, true, true>]>;
-//# sourceMappingURL=container.d.ts.map

package/dist/container.js

@@ -1,7 +0,0 @@
-import { createContainer, createModule } from 'haywire';
-import { loadPopulateFilesCliBinding } from './cli.js';
-import { loadPopulateFilesCommandBinding } from './commands/load-populate-files-command.js';
-export const cliModule = createModule(loadPopulateFilesCliBinding).addBinding(loadPopulateFilesCommandBinding);
-export const cliContainer = createContainer(cliModule);
-
-//# sourceMappingURL=container.js.map