load-populate-files 1.1.2 → 1.1.3

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/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,6 +1,6 @@
 {
   "name": "load-populate-files",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Load and dynamically populate file content",
   "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,15 +38,15 @@
   },
   "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",
+    "haywire": "^2.0.4",
+    "haywire-launcher": "^1.1.1",
+    "juniper": "^2.5.0",
+    "juniper-validator": "^0.5.1",
+    "parse-cwd": "^2.0.3",
+    "populate-files": "^1.2.0",
+    "unknown-error": "^0.1.1",
     "yargs": "^18.2.0"
   },
   "devDependencies": {
@@ -54,16 +54,16 @@
     "@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.18",
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.19.0",
     "@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"
   },