elrh-cosca 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alois Sečkár
+
+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,27 @@
+# COSCA
+Library of file-writting functions that help building CLI scripts for making changes in target projects - like adding default configuration files or new sections in `package.json`.
+
+The first experimental "customers" are my [Nuxt Spec](https://github.com/AloisSeckar/nuxt-spec) and [Nuxt Ignis](https://github.com/AloisSeckar/nuxt-ignis) projects.
+
+The **"COSCA"** abbreviation stands for **CO**de **SCA**ffolding which points out the library's purpose of providing methods for altering existing and adding new files from scratch using Node-based filesystem APIs.
+
+## How to use
+
+`npm install elrh-cosca` to include into your project.
+
+List of available functions:
+- `createFileFromTemplate`
+- `promptUser`
+- `updateJsonFile`
+- `updateTextFile`
+
+## Tech stack
+
+- Developed with [TypeScript](https://www.typescriptlang.org/)
+- Build with [Vite](https://vitejs.dev/)
+- Tested with [Vitest](https://vitest.dev/)
+
+## Report bugs & contact
+
+Use GitHub issues to report bugs / propose enhancements / give feedback:
+https://github.com/AloisSeckar/elrh-cosca/issues

package/dist/elrh-cosca.cjs

@@ -0,0 +1,4 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const y=require("path"),o=require("fs"),$=require("readline"),w=e=>e&&e.__esModule?e:{default:e},d=w(y),g=w($);async function u(e){const t=g.default.createInterface({input:process.stdin,output:process.stdout});return new Promise(n=>{t.question(e+" (y/N): ",c=>{t.close(),n(/^y(es)?$/i.test(c.trim()))})})}async function m(e,t,n=!1){if(n||await u(`This will create '${t}' file. Continue?`)){const l=d.default.resolve(process.cwd(),e),i=d.default.resolve(process.cwd(),t);o.existsSync(l)||(console.error(`Template file not found at ${l}`),process.exit(1)),o.existsSync(i)&&(n||await u(`File '${t}' already exists. Overwrite?`)||(console.log("Aborted."),process.exit(0))),o.copyFileSync(l,i),console.log(`New file '${t}' successfully created.`)}else console.log(`Creation of '${t}' skipped.`)}async function S(e,t,n,c=!1){if(c||await u(`This will update '${e}' file. Continue?`)){const i=d.default.resolve(process.cwd(),e);if(!o.existsSync(i)){console.warn(`No '${e}' found in project root — skipping updates.`);return}const r=o.readFileSync(i,"utf8");let s;try{s=JSON.parse(r)}catch{console.error(`Could not parse '${e}' — skipping updates.`);return}s[t]=s[t]||{};let a=!1;for(const[f,p]of Object.entries(n))s[t][f]!==p&&(s[t][f]=p,a=!0);a?(o.writeFileSync(i,JSON.stringify(s,null,2)+`
+`,"utf8"),console.log(`'${e}' file updated.`)):console.log(`'${e}' file already up to date.`)}else console.log(`Updating '${e}' skipped.`)}async function x(e,t,n=!1){if(n||await u(`This will update '${e}' file. Continue?`)){const l=d.default.resolve(process.cwd(),e);if(!o.existsSync(l)){console.warn(`No '${e}' found in project root — skipping updates.`);return}const r=o.readFileSync(l,"utf8").split(/\r?\n/);let s=!1;for(const a of t)r.includes(a)||(r.push(a),s=!0);s?(o.writeFileSync(l,r.join(`
+`)+`
+`,"utf8"),console.log(`'${e}' file updated.`)):console.log(`'${e}' file already up to date.`)}else console.log(`Updating '${e}' skipped.`)}exports.createFileFromTemplate=m;exports.promptUser=u;exports.updateJsonFile=S;exports.updateTextFile=x;

package/dist/elrh-cosca.mjs

@@ -0,0 +1,76 @@
+import a from "path";
+import { existsSync as d, copyFileSync as m, readFileSync as w, writeFileSync as $ } from "fs";
+import y from "readline";
+async function u(e) {
+  const o = y.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  return new Promise((t) => {
+    o.question(e + " (y/N): ", (r) => {
+      o.close(), t(/^y(es)?$/i.test(r.trim()));
+    });
+  });
+}
+async function h(e, o, t = !1) {
+  if (t || await u(
+    `This will create '${o}' file. Continue?`
+  )) {
+    const n = a.resolve(process.cwd(), e), i = a.resolve(process.cwd(), o);
+    d(n) || (console.error(`Template file not found at ${n}`), process.exit(1)), d(i) && (t || await u(
+      `File '${o}' already exists. Overwrite?`
+    ) || (console.log("Aborted."), process.exit(0))), m(n, i), console.log(`New file '${o}' successfully created.`);
+  } else
+    console.log(`Creation of '${o}' skipped.`);
+}
+async function k(e, o, t, r = !1) {
+  if (r || await u(
+    `This will update '${e}' file. Continue?`
+  )) {
+    const i = a.resolve(process.cwd(), e);
+    if (!d(i)) {
+      console.warn(`No '${e}' found in project root — skipping updates.`);
+      return;
+    }
+    const l = w(i, "utf8");
+    let s;
+    try {
+      s = JSON.parse(l);
+    } catch {
+      console.error(`Could not parse '${e}' — skipping updates.`);
+      return;
+    }
+    s[o] = s[o] || {};
+    let c = !1;
+    for (const [f, p] of Object.entries(t))
+      s[o][f] !== p && (s[o][f] = p, c = !0);
+    c ? ($(i, JSON.stringify(s, null, 2) + `
+`, "utf8"), console.log(`'${e}' file updated.`)) : console.log(`'${e}' file already up to date.`);
+  } else
+    console.log(`Updating '${e}' skipped.`);
+}
+async function C(e, o, t = !1) {
+  if (t || await u(
+    `This will update '${e}' file. Continue?`
+  )) {
+    const n = a.resolve(process.cwd(), e);
+    if (!d(n)) {
+      console.warn(`No '${e}' found in project root — skipping updates.`);
+      return;
+    }
+    const l = w(n, "utf8").split(/\r?\n/);
+    let s = !1;
+    for (const c of o)
+      l.includes(c) || (l.push(c), s = !0);
+    s ? ($(n, l.join(`
+`) + `
+`, "utf8"), console.log(`'${e}' file updated.`)) : console.log(`'${e}' file already up to date.`);
+  } else
+    console.log(`Updating '${e}' skipped.`);
+}
+export {
+  h as createFileFromTemplate,
+  u as promptUser,
+  k as updateJsonFile,
+  C as updateTextFile
+};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './main'
+export {}

package/dist/types/lib/create-file-from-template.d.ts

@@ -0,0 +1 @@
+export declare function createFileFromTemplate(templateFile: string, targetFile: string, force?: boolean): Promise<void>;

package/dist/types/lib/prompt-user.d.ts

@@ -0,0 +1 @@
+export declare function promptUser(question: string): Promise<boolean>;

package/dist/types/lib/update-json-file.d.ts

@@ -0,0 +1 @@
+export declare function updateJsonFile(pathToFile: string, jsonKey: string, newValues: Record<string, string>, force?: boolean): Promise<void>;

package/dist/types/lib/update-text-file.d.ts

@@ -0,0 +1 @@
+export declare function updateTextFile(pathToFile: string, rowsToAdd: string[], force?: boolean): Promise<void>;

package/dist/types/main.d.ts

@@ -0,0 +1,5 @@
+import { createFileFromTemplate } from './lib/create-file-from-template';
+import { promptUser } from './lib/prompt-user';
+import { updateJsonFile } from './lib/update-json-file';
+import { updateTextFile } from './lib/update-text-file';
+export { createFileFromTemplate, promptUser, updateJsonFile, updateTextFile, };

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "elrh-cosca",
+  "version": "0.1.0",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/elrh-cosca.cjs",
+  "module": "./dist/elrh-cosca.mjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/elrh-cosca.cjs",
+      "require": "./dist/elrh-cosca.mjs"
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.3",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "pnpm install && vitest run && tsc && vite build",
+    "preview": "vite preview",
+    "test": "vitest run"
+  }
+}