load-populate-files 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# load-populate-files
+
+## 0.0.3
+
+### Patch Changes
+
+- 31f81fa: Internal dependency updates
+- 86a26b1: Add README
+- 3e7ee18: Dependency bumps
+- f6a4729: Update year in LICENSE
+- 9c786d0: Update dependencies
+- 329146b: Add README
+- Updated dependencies [31f81fa]
+- Updated dependencies [85c052c]
+- Updated dependencies [86a26b1]
+- Updated dependencies [3e7ee18]
+- Updated dependencies [f6a4729]
+- Updated dependencies [9c786d0]
+  - populate-files@0.0.3
+  - default-import@1.1.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jacob Ley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,108 @@
+<div style="text-align:center">
+
+# load-populate-files
+Load and dynamically populate file content based on a single files config.
+
+[![npm package](https://badge.fury.io/js/load-populate-files.svg)](https://www.npmjs.com/package/load-populate-files)
+[![License](https://img.shields.io/npm/l/load-populate-files.svg)](https://github.com/JacobLey/leyman/blob/main/tools/load-populate-files/LICENSE)
+
+</div>
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [API](#api)
+    - [loadAndPopulateFiles](#loadandpopulatefilesfilepath-options)
+- [Types](#types)
+    - [PopulateFileParams](#populatefileparams)
+- [Also See](#also-see)
+
+## Introduction
+
+`load-populate-files` is a small library to simplify usage of [populate-files](https://www.npmjs.com/package/populate-files), which will dynamically write files based on calculated content.
+
+Instead of calling `populateFiles()` directly, we can can export the file configs, and defer the execution of file writing to `loadAndPopulateFiles()`.
+
+This is useful for CLI scripts, or NX plugins like [nx-populate-files](https://www.npmjs.com/package/nx-populate-files).
+
+## Installation
+
+`npm i load-populate-files`
+
+Populate-files is an ESM module. That means it _must_ be `import`ed. To load from a CJS module, use dynamic import `const { loadAndPopulateFiles } = await import('load-populate-files');`.
+
+## Usage
+
+Provide the file path to a file that _default exports_ the parameters for `populateFiles()`
+
+Options are supported the same as `populateFiles()`.
+
+```ts
+// config.ts
+export default [
+    {
+        filePath: './foo.json',
+        content: { bar: 123 },
+    },
+    {
+        filePath: './abc.js',
+        content: `
+            console.log('Hello World!');
+        `,
+    },
+];
+
+// index.ts
+await loadAndPopulateFiles('./config.js');
+```
+
+## API
+
+### loadAndPopulateFiles(filePath, options)
+
+Loads the config specified at `filePath`, and passes that to [populateFiles()](https://www.npmjs.com/package/populate-files#populatefilesparams-options).
+
+The loaded file may either be a single object config, or an array of separate configs.
+
+#### options
+
+An optional object as the secondary parameter. Passed to underlying `populateFiles()` call.
+
+| property | type | default | description |
+|----------|------|---------|-------------|
+| check | `boolean` | `true` if in a CI environment. Else `false` | If `true`, will fail if writing the file would result in changing the files content. Useful for CI environments to make sure the version-controlled code is up to date before deployment. |
+| dryRun | `boolean` | `false` | If `true`, will not write file regardless of changes. Can still fail if `check` is `true`. |
+| cwd | `string \| URL` | `process.env.PWD` | Used as the current working directory if `filePath` is a relative file. Will be re-used in filePaths derived from loaded config |
+
+## Types
+
+### PopulateFileParams
+
+Type of the exported config at the specified file. Represents the parametesr to `populateFiles()`. It is highly recommended to combine with the `satisfies` keyword to ensure your exported config will succeed.
+
+```ts
+import type { PopulateFileParams } from 'load-populate-files';
+
+export default {
+    filePath: './foo.json',
+    content: { bar: 123 },
+} satisfies PopulateFileParams;
+```
+
+Note this type can also be imported from [populate-files](https://www.npmjs.com/package/populate-files) directly.
+
+## Also See
+
+### [parse-cwd](https://www.npmjs.com/package/parse-cwd)
+
+Used internally to interpret `cwd` option.
+
+### [populate-files](https://www.npmjs.com/package/populate-files)
+
+Populate and format a file based on dynamic content.
+
+### [nx-populate-files](https://www.npmjs.com/package/nx-populate-files)
+
+Load and populate files as an nx target.

package/dist/index.js

@@ -1,6 +1,6 @@
-import { populateFiles } from "populate-files";
-import { loadFile } from "./lib/loader.js";
-import { normalizeParams } from "./lib/normalize.js";
+import { populateFiles } from 'populate-files';
+import { loadFile } from './lib/loader.js';
+import { normalizeParams } from './lib/normalize.js';
 export const loadAndPopulateFiles = async (params, options)=>{
     const normalized = await normalizeParams(params, options);
     const files = await loadFile(normalized.filePath);

package/dist/lib/loader.js

@@ -1,4 +1,4 @@
-import { defaultImport } from "default-import";
+import { defaultImport } from 'default-import';
 export const loadFile = async (filePath)=>{
     const mod = await import(filePath);
     const params = defaultImport(mod);

package/dist/lib/normalize.js

@@ -1,9 +1,9 @@
-import { resolve } from "node:path";
-import { parseCwd } from "npm-parse-cwd";
+import Path from 'node:path';
+import { parseCwd } from 'npm-parse-cwd';
 export const normalizeParams = async (params, options = {})=>{
     const cwd = await parseCwd(options.cwd);
     return {
-        filePath: resolve(cwd, params.filePath),
+        filePath: Path.resolve(cwd, params.filePath),
         options: {
             cwd,
             check: options.check,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "load-populate-files",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Load and dynamically populate file content",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "author": "JacobLey",
@@ -23,21 +23,21 @@
     ".": "./dist/index.js"
   },
   "dependencies": {
-    "npm-parse-cwd": "npm:parse-cwd@^1.0.8",
-    "populate-files": "^0.0.2",
-    "default-import": "^1.1.5"
+    "npm-parse-cwd": "npm:parse-cwd@latest",
+    "populate-files": "^0.0.3",
+    "default-import": "^1.1.6"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.6.4",
-    "@types/chai": "^4.3.12",
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.26",
-    "chai": "^5.1.0",
-    "mocha": "^10.4.0",
-    "npm-nx-update-ts-references": "npm:nx-update-ts-references@^0.0.2",
-    "nyc": "^15.1.0",
-    "typescript": "^5.4.3",
-    "@leyman/eslint-config": "^0.0.0",
-    "nx-tsc": "^0.0.4"
+    "@biomejs/biome": "^1.8.3",
+    "@types/chai": "^4.3.17",
+    "@types/mocha": "^10.0.7",
+    "@types/node": "^22.1.0",
+    "chai": "^5.1.1",
+    "mocha": "^10.7.0",
+    "npm-nx-update-ts-references": "npm:nx-update-ts-references@latest",
+    "nyc": "^17.0.0",
+    "typescript": "^5.5.4",
+    "nx-tsc": "^0.0.7",
+    "@leyman/eslint-config": "^0.0.0"
   }
 }