elrh-cosca 0.2.0 → 0.2.1

package/README.md

@@ -7,11 +7,13 @@ The **"COSCA"** abbreviation stands for **CO**de **SCA**ffolding which points ou
 
 ## How to use
 
+**NOTE:** The library is **ESM only** and it is advised to use with at least **Node 18**.
+
 `npm install elrh-cosca` to include into your project.
 
-**List of available functions:**
+### List of file-manipulation functions
 
-### `createFileFromTemplate`
+#### `createFileFromTemplate`
 
 ```ts
 async function createFileFromTemplate(
@@ -27,15 +29,7 @@ Path to `targetFile` is relative to `process.cwd()` which allows consumers to ru
 
 By default the function asks for confirmation before attempting to create the file and if the file with the same name as `targetFile` is detected. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts.
 
-### `promptUser`
-
-```ts
-export async function promptUser(question: string): Promise<boolean>
-```
-
-Prints out a `question` to the console and waits for the input. Returns `true` when `y` is pressed and `false` otherwise.
-
-### `updateConfigFile`
+#### `updateConfigFile`
 
 ```ts
 async function updateConfigFile(
@@ -45,7 +39,7 @@ async function updateConfigFile(
 
 Prints out a `question` to the console and waits for the input. Returns `true` when `y` is pressed and `false` otherwise.
 
-### `updateConfigFile`
+#### `updateConfigFile`
 
 ```ts
 async function updateConfigFile(
@@ -67,7 +61,7 @@ Please [report](https://github.com/AloisSeckar/elrh-cosca/issues) any logical fl
 
 By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts.
 
-### `updateJsonFile`
+#### `updateJsonFile`
 
 ```ts
 async function updateJsonFile(
@@ -83,10 +77,10 @@ Currently it only allows adding new values under top-level keys. If the `jsonKey
 
 By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts.
 
-### `updateTextFile`
+#### `updateTextFile`
 
 ```ts
-export async function updateTextFile(
+async function updateTextFile(
     pathToFile: string, rowsToAdd: string[], force: boolean = false
 ): Promise<void>
 ```
@@ -95,6 +89,34 @@ Takes a path to a plain text file and injects `rowsToAdd` at the end of the file
 
 By default the function asks for confirmation before attempting to alter the `targetFile`. Setting the last optional parameter `force` to `true` will suppress manual confirmation prompts.
 
+### List of terminal helpers
+
+#### `promptUser`
+
+```ts
+async function promptUser(question: string): Promise<boolean>
+```
+
+Prints out a `question` to the console and waits for the input. Returns `true` when `y` is pressed and `false` otherwise.
+
+### List of other utils
+
+#### `parseQualifiedPath`
+
+```ts
+function parseQualifiedPath(path: string): { pkg: string; file: string }
+```
+
+Expects path to file in `"package:relative/path/to/file"` format and splits it into `{ pkg, file }`. The package name can be scoped (e.g. `@scope/package`).
+
+#### `resolvePackagePath`
+
+```ts
+function resolvePackagePath(pkg: string): string
+```
+
+Resolve a package's installed root directory *from the target app* - which can be either from within itself during development or from corresponding package dir inside *node_modules*. The package name can be scoped (e.g. `@scope/package`).
+
 ## Tech stack
 
 - Developed with [TypeScript](https://www.typescriptlang.org/) in mind
@@ -102,6 +124,8 @@ By default the function asks for confirmation before attempting to alter the `ta
 - Build with [Vite](https://vitejs.dev/)
 - Tested with [Vitest](https://vitest.dev/)
 
+See [Changelog](https://github.com/AloisSeckar/elrh-cosca/blob/main/CHANGELOG.md) for project history and development.
+
 ## Report bugs & contact
 
 Use GitHub issues to report bugs / propose enhancements / give feedback:

package/dist/elrh-cosca.mjs

@@ -16298,20 +16298,26 @@ async function Dl(a, l, i = !1) {
     const o = At(process.cwd(), a), u = await Pl(o);
     let h = u.exports?.default;
     if (!h) {
-      const P = Object.keys(u.exports);
-      P.length === 1 && (h = u.exports[P[0]]);
+      const S = Object.keys(u.exports);
+      S.length === 1 && (h = u.exports[S[0]]);
     }
     if (!h && typeof u.exports == "object" && u.exports !== null)
       throw new Error(`It is currently not possible to handle CommonJS module.exports syntax of ${a}`);
-    if (console.warn("f", a), console.warn("e", h), !h)
+    if (!h)
       throw new Error(`No suitable config export found in ${a}`);
     const d = h.$type === "function-call" ? h.$args?.[0] : h;
     if (!d || typeof d != "object")
       throw new Error(`Could not access config object in ${a}`);
-    console.warn("o", d), console.warn("n", l), sn(d, l);
-    const { code: g } = tn(u);
-    Rs(o, g, "utf8");
-  }
+    const g = JSON.stringify(d);
+    sn(d, l);
+    const P = JSON.stringify(d);
+    if (g !== P) {
+      const { code: S } = tn(u);
+      Rs(o, S, "utf8"), console.log(`'${a}' file updated.`);
+    } else
+      console.log(`'${a}' file already up to date.`);
+  } else
+    console.log(`Updating '${a}' skipped.`);
 }
 async function Ol(a, l, i, r = !1) {
   if (r || await wt(
@@ -16360,7 +16366,9 @@ async function Ml(a, l, i = !1) {
 }
 export {
   wl as createFileFromTemplate,
+  Ca as parseQualifiedPath,
   wt as promptUser,
+  Ia as resolvePackagePath,
   Dl as updateConfigFile,
   Ol as updateJsonFile,
   Ml as updateTextFile

package/dist/types/main.d.ts

@@ -1,6 +1,8 @@
-import { createFileFromTemplate } from './lib/create-file-from-template';
-import { promptUser } from './lib/prompt-user';
-import { updateConfigFile } from './lib/update-config-file';
-import { updateJsonFile } from './lib/update-json-file';
-import { updateTextFile } from './lib/update-text-file';
-export { createFileFromTemplate, promptUser, updateConfigFile, updateJsonFile, updateTextFile, };
+import { createFileFromTemplate } from './functions/create-file-from-template';
+import { updateConfigFile } from './functions/update-config-file';
+import { updateJsonFile } from './functions/update-json-file';
+import { updateTextFile } from './functions/update-text-file';
+import { promptUser } from './terminal/prompt-user';
+import { parseQualifiedPath } from './utils/parse-qualified-path';
+import { resolvePackagePath } from './utils/resolve-package-path';
+export { createFileFromTemplate, updateConfigFile, updateJsonFile, updateTextFile, promptUser, parseQualifiedPath, resolvePackagePath, };

package/dist/types/utils/parse-qualified-path.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Expects path to file in `"package:relative/path/to/file"` format and splits it into `{ pkg, file }`.
+ * The package name can be scoped (e.g. `@scope/package`). Throws error on invalid input.
+ */
+export declare function parseQualifiedPath(path: string): {
+    pkg: string;
+    file: string;
+};

package/dist/types/utils/resolve-package-path.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Resolve a package's installed root directory *from the target app*.
+ * Package name can be scoped (e.g. `@scope/package`).
+ * Works with npm/yarn/pnpm, hoisting or not.
+ */
+export declare function resolvePackagePath(packageName: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "elrh-cosca",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "files": [
     "dist"
@@ -12,11 +12,9 @@
     ".": {
       "types": "./dist/types/index.d.ts",
       "import": "./dist/elrh-cosca.mjs",
-      "require": "./dist/elrh-cosca.cjs",
       "default": "./dist/elrh-cosca.mjs"
     }
   },
-  "main": "./dist/elrh-cosca.cjs",
   "module": "./dist/elrh-cosca.mjs",
   "types": "./dist/types/index.d.ts",
   "devDependencies": {

package/test/cosca-test.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 // manual test script for COSCA functions
 
@@ -7,26 +7,22 @@ import {
 } from '../dist/elrh-cosca.mjs'
 
 async function main() {
-  /*
   console.log('Test promptUser')
   const input = await promptUser('Is it today?')
   console.log('User input:', input)
 
   console.log('\nTest createFileFromTemplate')
-  await createFileFromTemplate('vite:README.md', 'test.file1')
-  await createFileFromTemplate('elrh-cosca:README.md', 'test.file2')
-  */
+  await createFileFromTemplate('vitest:README.md', 'test/snapshots/test.file1')
+  await createFileFromTemplate('elrh-cosca:test/fixtures/text-file.txt', 'test/snapshots/test.file2')
 
   console.log('\nTest updateConfigFile')
-  await updateConfigFile('test/cosca-test-config.ts', { compatibilityDate: '2025-08-26', extends: ['nuxt-iignis'], cosca: { exists: true, data: ['some', 'other'], raw: 'war' } })
+  await updateConfigFile('test/fixtures/config-file-default.ts', { compatibilityDate: '2025-08-26', extends: ['nuxt-iignis'], cosca: { exists: true, data: ['some', 'other'], raw: 'war' } })
 
-  /*
   console.log('\nTest updateJsonFile')
-  await updateJsonFile('package.json', 'scripts', { 'cosca' : 'cosca' })
+  await updateJsonFile('test/fixtures/json-file.json', 'scripts', { 'cosca' : 'cosca' })
 
   console.log('\nTest updateTextFile')
-  await updateTextFile('.gitignore', ['# COSCA'])
-  */
+  await updateTextFile('test/fixtures/text-file.txt', ['# COSCA'])
 }
 
 main().catch((err) => {

package/dist/types/utils/resolve-package.d.ts

@@ -1,14 +0,0 @@
-/**
- * Expects path to file template in `"package:relative/path/to/file"` format and splits it into `{ pkg, file }`.
- * Throws error on invalid input.
- */
-export declare function parseTemplatePath(input: string): {
-    pkg: string;
-    file: string;
-};
-/**
- * Resolve a package's installed root directory *from the target app*.
- * Package name can be scoped.
- * Works with npm/yarn/pnpm, hoisting or not.
- */
-export declare function resolvePackagePath(packageName: string): string;

package/dist/types/utils/resolve-path.d.ts

@@ -1,12 +0,0 @@
-/**
- * Normalized __filename that works in both ESM (.mjs) and CJS (.cjs).
- * In CJS, __filename is available as a global variable.
- * In MJS, import.meta.url is available instead.
- */
-export declare const module_file: string;
-/**
- * Normalized __dirname that works in both ESM (.mjs) and CJS (.cjs).
- * In CJS, __filename is available as a global variable.
- * In MJS, import.meta.url is available instead.
- */
-export declare const module_dir: string;