@nshiab/setup-data-project 1.0.7

package/npm/package-lock.json

@@ -0,0 +1,135 @@
+{
+  "name": "@nshiab/setup-data-project",
+  "version": "1.0.7",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "@nshiab/setup-data-project",
+      "version": "1.0.7",
+      "license": "MIT",
+      "dependencies": {
+        "@clack/prompts": "^1.3.0",
+        "@deno/shim-deno": "~0.18.0"
+      },
+      "devDependencies": {
+        "@types/node": "^20.9.0"
+      }
+    },
+    "node_modules/@clack/core": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/@clack/core/-/core-1.3.0.tgz",
+      "integrity": "sha512-xJPHpAmEQUBrXSLx0gF+q5K/IyihXpsHZcha+jB+tyahsKRK3Dxo4D0coZDewHo12NhiuzC3dTtMPbm53GEAAA==",
+      "license": "MIT",
+      "dependencies": {
+        "fast-wrap-ansi": "^0.2.0",
+        "sisteransi": "^1.0.5"
+      },
+      "engines": {
+        "node": ">= 20.12.0"
+      }
+    },
+    "node_modules/@clack/prompts": {
+      "version": "1.3.0",
+      "resolved": "https://registry.npmjs.org/@clack/prompts/-/prompts-1.3.0.tgz",
+      "integrity": "sha512-GgcWwRCs/xPtaqlMy8qRhPnZf9vlWcWZNHAitnVQ3yk7JmSralSiq5q07yaffYE8SogtDm7zFeKccx1QNVARpw==",
+      "license": "MIT",
+      "dependencies": {
+        "@clack/core": "1.3.0",
+        "fast-string-width": "^3.0.2",
+        "fast-wrap-ansi": "^0.2.0",
+        "sisteransi": "^1.0.5"
+      },
+      "engines": {
+        "node": ">= 20.12.0"
+      }
+    },
+    "node_modules/@deno/shim-deno": {
+      "version": "0.18.2",
+      "resolved": "https://registry.npmjs.org/@deno/shim-deno/-/shim-deno-0.18.2.tgz",
+      "integrity": "sha512-oQ0CVmOio63wlhwQF75zA4ioolPvOwAoK0yuzcS5bDC1JUvH3y1GS8xPh8EOpcoDQRU4FTG8OQfxhpR+c6DrzA==",
+      "license": "MIT",
+      "dependencies": {
+        "@deno/shim-deno-test": "^0.5.0",
+        "which": "^4.0.0"
+      }
+    },
+    "node_modules/@deno/shim-deno-test": {
+      "version": "0.5.0",
+      "resolved": "https://registry.npmjs.org/@deno/shim-deno-test/-/shim-deno-test-0.5.0.tgz",
+      "integrity": "sha512-4nMhecpGlPi0cSzT67L+Tm+GOJqvuk8gqHBziqcUQOarnuIax1z96/gJHCSIz2Z0zhxE6Rzwb3IZXPtFh51j+w==",
+      "license": "MIT"
+    },
+    "node_modules/@types/node": {
+      "version": "20.19.39",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.39.tgz",
+      "integrity": "sha512-orrrD74MBUyK8jOAD/r0+lfa1I2MO6I+vAkmAWzMYbCcgrN4lCrmK52gRFQq/JRxfYPfonkr4b0jcY7Olqdqbw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "undici-types": "~6.21.0"
+      }
+    },
+    "node_modules/fast-string-truncated-width": {
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/fast-string-truncated-width/-/fast-string-truncated-width-3.0.3.tgz",
+      "integrity": "sha512-0jjjIEL6+0jag3l2XWWizO64/aZVtpiGE3t0Zgqxv0DPuxiMjvB3M24fCyhZUO4KomJQPj3LTSUnDP3GpdwC0g==",
+      "license": "MIT"
+    },
+    "node_modules/fast-string-width": {
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/fast-string-width/-/fast-string-width-3.0.2.tgz",
+      "integrity": "sha512-gX8LrtNEI5hq8DVUfRQMbr5lpaS4nMIWV+7XEbXk2b8kiQIizgnlr12B4dA3ZEx3308ze0O4Q1R+cHts8kyUJg==",
+      "license": "MIT",
+      "dependencies": {
+        "fast-string-truncated-width": "^3.0.2"
+      }
+    },
+    "node_modules/fast-wrap-ansi": {
+      "version": "0.2.0",
+      "resolved": "https://registry.npmjs.org/fast-wrap-ansi/-/fast-wrap-ansi-0.2.0.tgz",
+      "integrity": "sha512-rLV8JHxTyhVmFYhBJuMujcrHqOT2cnO5Zxj37qROj23CP39GXubJRBUFF0z8KFK77Uc0SukZUf7JZhsVEQ6n8w==",
+      "license": "MIT",
+      "dependencies": {
+        "fast-string-width": "^3.0.2"
+      }
+    },
+    "node_modules/isexe": {
+      "version": "3.1.5",
+      "resolved": "https://registry.npmjs.org/isexe/-/isexe-3.1.5.tgz",
+      "integrity": "sha512-6B3tLtFqtQS4ekarvLVMZ+X+VlvQekbe4taUkf/rhVO3d/h0M2rfARm/pXLcPEsjjMsFgrFgSrhQIxcSVrBz8w==",
+      "license": "BlueOak-1.0.0",
+      "engines": {
+        "node": ">=18"
+      }
+    },
+    "node_modules/sisteransi": {
+      "version": "1.0.5",
+      "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+      "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==",
+      "license": "MIT"
+    },
+    "node_modules/undici-types": {
+      "version": "6.21.0",
+      "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz",
+      "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==",
+      "dev": true,
+      "license": "MIT"
+    },
+    "node_modules/which": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/which/-/which-4.0.0.tgz",
+      "integrity": "sha512-GlaYyEb07DPxYCKhKzplCWBJtvxZcZMrL+4UkrTSJHHPyZU4mYYTv3qaOe77H7EODLSSopAUFAc6W8U4yqvscg==",
+      "license": "ISC",
+      "dependencies": {
+        "isexe": "^3.1.1"
+      },
+      "bin": {
+        "node-which": "bin/which.js"
+      },
+      "engines": {
+        "node": "^16.13.0 || >=18.0.0"
+      }
+    }
+  }
+}

package/npm/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@nshiab/setup-data-project",
+  "version": "1.0.7",
+  "description": "Quickly kick off your data project using the simple-data-analysis and journalism libraries.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nshiab/setup-data-project"
+  },
+  "license": "MIT",
+  "main": "./script/main.js",
+  "module": "./esm/main.js",
+  "exports": {
+    ".": {
+      "import": "./esm/main.js",
+      "require": "./script/main.js"
+    }
+  },
+  "scripts": {},
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@clack/prompts": "^1.3.0",
+    "@deno/shim-deno": "~0.18.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/npm/script/_dnt.shims.d.ts

@@ -0,0 +1,8 @@
+import * as dntShim from "./_dnt_2.shims.js";
+export { Deno } from "@deno/shim-deno";
+export declare const dntGlobalThis: Omit<Omit<typeof globalThis, "Deno"> & {
+    Deno: typeof dntShim.Deno;
+}, "Deno"> & {
+    Deno: typeof dntShim.Deno;
+};
+//# sourceMappingURL=_dnt.shims.d.ts.map

package/npm/script/_dnt.shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.shims.d.ts","sourceRoot":"","sources":["../src/_dnt.shims.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;;;CAAsD,CAAC"}

package/npm/script/_dnt.shims.js

@@ -0,0 +1,99 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dntGlobalThis = exports.Deno = void 0;
+const dntShim = __importStar(require("./_dnt_2.shims.js"));
+const shim_deno_1 = require("@deno/shim-deno");
+var shim_deno_2 = require("@deno/shim-deno");
+Object.defineProperty(exports, "Deno", { enumerable: true, get: function () { return shim_deno_2.Deno; } });
+const dntGlobals = {
+    Deno: shim_deno_1.Deno,
+};
+exports.dntGlobalThis = createMergeProxy(dntShim.dntGlobalThis, dntGlobals);
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/npm/script/_dnt_2.shims.d.ts

@@ -0,0 +1,6 @@
+import { Deno } from "@deno/shim-deno";
+export { Deno } from "@deno/shim-deno";
+export declare const dntGlobalThis: Omit<typeof globalThis, "Deno"> & {
+    Deno: typeof Deno;
+};
+//# sourceMappingURL=_dnt_2.shims.d.ts.map

package/npm/script/_dnt_2.shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt_2.shims.d.ts","sourceRoot":"","sources":["../src/_dnt_2.shims.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;CAA2C,CAAC"}

package/npm/script/_dnt_2.shims.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dntGlobalThis = exports.Deno = void 0;
+const shim_deno_1 = require("@deno/shim-deno");
+var shim_deno_2 = require("@deno/shim-deno");
+Object.defineProperty(exports, "Deno", { enumerable: true, get: function () { return shim_deno_2.Deno; } });
+const dntGlobals = {
+    Deno: shim_deno_1.Deno,
+};
+exports.dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
+function createMergeProxy(baseObj, extObj) {
+    return new Proxy(baseObj, {
+        get(_target, prop, _receiver) {
+            if (prop in extObj) {
+                return extObj[prop];
+            }
+            else {
+                return baseObj[prop];
+            }
+        },
+        set(_target, prop, value) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            baseObj[prop] = value;
+            return true;
+        },
+        deleteProperty(_target, prop) {
+            let success = false;
+            if (prop in extObj) {
+                delete extObj[prop];
+                success = true;
+            }
+            if (prop in baseObj) {
+                delete baseObj[prop];
+                success = true;
+            }
+            return success;
+        },
+        ownKeys(_target) {
+            const baseKeys = Reflect.ownKeys(baseObj);
+            const extKeys = Reflect.ownKeys(extObj);
+            const extKeysSet = new Set(extKeys);
+            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
+        },
+        defineProperty(_target, prop, desc) {
+            if (prop in extObj) {
+                delete extObj[prop];
+            }
+            Reflect.defineProperty(baseObj, prop, desc);
+            return true;
+        },
+        getOwnPropertyDescriptor(_target, prop) {
+            if (prop in extObj) {
+                return Reflect.getOwnPropertyDescriptor(extObj, prop);
+            }
+            else {
+                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
+            }
+        },
+        has(_target, prop) {
+            return prop in extObj || prop in baseObj;
+        },
+    });
+}

package/npm/script/helpers/createFolderStructure.d.ts

@@ -0,0 +1,2 @@
+export declare function createFolderStructure(selectedPackages: string[]): Promise<string>;
+//# sourceMappingURL=createFolderStructure.d.ts.map

package/npm/script/helpers/createFolderStructure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFolderStructure.d.ts","sourceRoot":"","sources":["../../src/helpers/createFolderStructure.ts"],"names":[],"mappings":"AAKA,wBAAsB,qBAAqB,CAAC,gBAAgB,EAAE,MAAM,EAAE,mBA+CrE"}

package/npm/script/helpers/createFolderStructure.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFolderStructure = createFolderStructure;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const prompts_1 = require("@clack/prompts");
+const handleFileConflict_js_1 = require("./handleFileConflict.js");
+async function createFolderStructure(selectedPackages) {
+    const sdaFolder = "sda";
+    const folders = ["data", "helpers", "output"];
+    if (!(0, node_fs_1.existsSync)(sdaFolder)) {
+        (0, node_fs_1.mkdirSync)(sdaFolder, { recursive: true });
+        prompts_1.log.info(`Created folder ${sdaFolder}/`);
+    }
+    else {
+        prompts_1.log.warn(`Folder ${sdaFolder}/ already exists. Skipping creation.`);
+    }
+    for (const folder of folders) {
+        const path = (0, node_path_1.join)(sdaFolder, folder);
+        if (!(0, node_fs_1.existsSync)(path)) {
+            (0, node_fs_1.mkdirSync)(path, { recursive: true });
+            prompts_1.log.info(`Created folder ${path}/`);
+        }
+        else {
+            prompts_1.log.warn(`Folder ${path}/ already exists. Skipping creation.`);
+        }
+    }
+    const mainTsPath = (0, node_path_1.join)(sdaFolder, "main.ts");
+    let mainTsContent = 'console.log("Hello simple-data-analysis!");\n';
+    if (selectedPackages.includes("@nshiab/simple-data-analysis")) {
+        mainTsContent = `import { SimpleDB } from "@nshiab/simple-data-analysis";
+
+const sdb = new SimpleDB();
+const table = await sdb.newTable();
+
+// Do your magic here!
+
+await sdb.done();
+`;
+    }
+    const status = await (0, handleFileConflict_js_1.handleFileConflict)(mainTsPath, mainTsContent);
+    if (status === "created") {
+        prompts_1.log.info(`Created ${mainTsPath}`);
+    }
+    else if (status === "updated") {
+        prompts_1.log.info(`Updated ${mainTsPath}`);
+    }
+    else {
+        prompts_1.log.warn(`${mainTsPath} skipping creation.`);
+    }
+    return sdaFolder;
+}

package/npm/script/helpers/ensureAgents.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureAgents(docsMapping: Record<string, string>, runtime: string): Promise<void>;
+//# sourceMappingURL=ensureAgents.d.ts.map

package/npm/script/helpers/ensureAgents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AAIA,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,OAAO,EAAE,MAAM,iBA+FhB"}

package/npm/script/helpers/ensureAgents.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureAgents = ensureAgents;
+const prompts_1 = require("@clack/prompts");
+const handleFileConflict_js_1 = require("./handleFileConflict.js");
+const packageRegistry_js_1 = require("./packageRegistry.js");
+async function ensureAgents(docsMapping, runtime) {
+    let journalismFunctions = "";
+    let sdaClassesAndMethods = "";
+    for (const [pkg, doc] of Object.entries(docsMapping)) {
+        const pkgConfig = packageRegistry_js_1.SUPPORTED_PACKAGES.find((p) => p.value === pkg);
+        const pkgType = pkgConfig?.type || "other";
+        if (pkgType === "journalism") {
+            const repoName = pkg.split("/")[1];
+            journalismFunctions += `\n### ${repoName}\n\n`;
+            journalismFunctions += doc
+                .split("\n")
+                .filter((line) => line.trim().startsWith("#"))
+                .filter((line) => {
+                const depth = line.match(/^#+/)?.[0].length || 0;
+                return depth >= 2; // Match ##, ###, #### etc.
+            })
+                .map((line) => line.replace(/^#+\s+/, "").trim())
+                .join("\n") + "\n";
+        }
+        else if (pkgType === "sda") {
+            sdaClassesAndMethods = doc
+                .split("\n")
+                .filter((line) => line.trim().startsWith("#"))
+                .filter((line) => {
+                const depth = line.match(/^#+/)?.[0].length || 0;
+                return depth === 2 || depth === 4;
+            })
+                .map((line) => {
+                const depth = line.match(/^#+/)?.[0].length || 0;
+                if (depth === 2) {
+                    return "\n" + line.replace(/^#+\s+/, "").trim();
+                }
+                else {
+                    return line.replace(/^#+\s+Parameters/, "  - ")
+                        .replace(/^#+\s+/, "  - ")
+                        .replaceAll("`", "");
+                }
+            })
+                .join("\n");
+        }
+    }
+    const configFile = runtime === "deno" ? "deno.json" : "package.json";
+    const runSda = runtime === "deno" ? "deno task sda" : "npm run sda";
+    const runClean = runtime === "deno" ? "deno task clean" : "npm run clean";
+    let content = `Always verify if there is a ${configFile} file in the root of the project and familiarize yourself with the scripts available in it and the libraries already installed in the project.
+
+Always use "sda" task when available (e.g. \`${runSda}\`).
+
+${runtime === "deno"
+        ? "If it's a Deno project, you can also run `deno run -A --node-modules-dir=auto --env-file --check sda/main.ts` to test your code. Before handing off your work, run `deno lint` and `deno fmt` as well. Fix any errors or warnings triggered along the way."
+        : "If it's a Node.js project, you can also run `node --env-file=.env --experimental-strip-types --no-warnings sda/main.ts` to test your code. Before handing off your work, always fix any errors or warnings triggered along the way."}
+
+Use the \`clean\` task (e.g. \`${runClean}\`) to remove the cache and other temporary files.
+
+Always use "sda/main.ts" as the entry point.
+
+If you need to create other TypeScript files, create them in the "sda/helpers" folder. Prioritize the use of helper functions to keep the code well organized and maintainable, with one helper function per file, with the file named after the function. Prioritize default exports for helper functions.
+
+If you need to download data, always put the files in the "sda/data" folder, which is gitignored. 
+
+If you need to output data to a file, always put the file in the "sda/output" folder.
+
+Always prioritize the use of the "journalism" and "simple-data-analysis" libraries when they are installed. These libraries can be used directly like this:
+\`\`\`typescript
+import { formatDate } from "@nshiab/journalism-format";
+import { SimpleDB } from "@nshiab/simple-data-analysis";
+\`\`\`
+`;
+    if (journalismFunctions !== "") {
+        content += `
+Here are the functions available in the "journalism" libraries. If one of the function might be relevant, read the complete documentation in the "./docs/" folder to properly use it.
+${journalismFunctions}`;
+    }
+    if (sdaClassesAndMethods !== "") {
+        content += `
+Here are the classes and their methods available in the "simple-data-analysis" library. If one of the classes or methods might be relevant, read the complete documentation at "./docs/simple-data-analysis.md" to properly use it. Remember that almost all methods are asynchronous, so you need to use \`await\` when calling them.
+${sdaClassesAndMethods}`;
+    }
+    const status = await (0, handleFileConflict_js_1.handleFileConflict)("AGENTS.md", content);
+    if (status === "created") {
+        prompts_1.log.info("Created AGENTS.md");
+    }
+    else if (status === "updated") {
+        prompts_1.log.info("Updated AGENTS.md");
+    }
+    else {
+        prompts_1.log.warn("AGENTS.md skipping creation.");
+    }
+}

package/npm/script/helpers/ensureEnvFile.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureEnvFile(): Promise<void>;
+//# sourceMappingURL=ensureEnvFile.d.ts.map

package/npm/script/helpers/ensureEnvFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensureEnvFile.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureEnvFile.ts"],"names":[],"mappings":"AAGA,wBAAsB,aAAa,kBASlC"}

package/npm/script/helpers/ensureEnvFile.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureEnvFile = ensureEnvFile;
+const prompts_1 = require("@clack/prompts");
+const handleFileConflict_js_1 = require("./handleFileConflict.js");
+async function ensureEnvFile() {
+    const status = await (0, handleFileConflict_js_1.handleFileConflict)(".env", "");
+    if (status === "created") {
+        prompts_1.log.info("Created .env");
+    }
+    else if (status === "updated") {
+        prompts_1.log.info("Updated .env");
+    }
+    else {
+        prompts_1.log.warn(".env skipping creation.");
+    }
+}

package/npm/script/helpers/ensureGitignore.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureGitignore(): void;
+//# sourceMappingURL=ensureGitignore.d.ts.map

package/npm/script/helpers/ensureGitignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensureGitignore.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureGitignore.ts"],"names":[],"mappings":"AAIA,wBAAgB,eAAe,SAyB9B"}

package/npm/script/helpers/ensureGitignore.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureGitignore = ensureGitignore;
+const node_fs_1 = require("node:fs");
+const prompts_1 = require("@clack/prompts");
+const gitignoreEntries_js_1 = require("./gitignoreEntries.js");
+function ensureGitignore() {
+    const path = ".gitignore";
+    let content = "";
+    let exists = false;
+    if ((0, node_fs_1.existsSync)(path)) {
+        content = (0, node_fs_1.readFileSync)(path, "utf-8");
+        exists = true;
+    }
+    const lines = content.split("\n").map((l) => l.trim());
+    const toAdd = gitignoreEntries_js_1.GITIGNORE_ENTRIES.filter((e) => !lines.includes(e));
+    if (toAdd.length > 0) {
+        const prefix = content.endsWith("\n") || content === "" ? "" : "\n";
+        const header = "\n# Added by setup-data-project\n";
+        const newContent = prefix + header + toAdd.join("\n") + "\n";
+        (0, node_fs_1.writeFileSync)(path, content + newContent);
+        if (exists) {
+            prompts_1.log.info(`Updated ${path}`);
+        }
+        else {
+            prompts_1.log.info(`Created ${path}`);
+        }
+    }
+    else if (exists) {
+        prompts_1.log.warn(`${path} already up to date. Skipping.`);
+    }
+}

package/npm/script/helpers/ensureReadme.d.ts

@@ -0,0 +1,2 @@
+export declare function ensureReadme(runtime: string): Promise<void>;
+//# sourceMappingURL=ensureReadme.d.ts.map

package/npm/script/helpers/ensureReadme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAGA,wBAAsB,YAAY,CAAC,OAAO,EAAE,MAAM,iBAoCjD"}

package/npm/script/helpers/ensureReadme.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureReadme = ensureReadme;
+const prompts_1 = require("@clack/prompts");
+const handleFileConflict_js_1 = require("./handleFileConflict.js");
+async function ensureReadme(runtime) {
+    const readmeContent = `This repository has been created with
+[setup-data-project](https://github.com/nshiab/setup-data-project/).
+
+It's installing
+[simple-data-analysis](https://github.com/nshiab/simple-data-analysis) and
+[journalism](https://github.com/nshiab/journalism) libraries, with up-to-date
+documentation and AI agent instructions.
+
+Here's the recommended workflow:
+
+- Put your raw data in the \`sda/data\` folder. Note that this folder is
+  gitignored.
+- Use the \`sda/main.ts\` file to clean and process your raw data. Write the
+  results to the \`sda/output\` folder.
+
+When working on your project, use the following command:
+
+- \`${runtime === "deno" ? "deno task" : "npm run"} sda\` will watch your \`sda/main.ts\` and its dependencies. Everytime
+  you'll save some changes, the data will be reprocessed.
+- \`${runtime === "deno" ? "deno task" : "npm run"} clean\` will remove \`.sda-cache/\`, \`.journalism-cache/\` and \`.tmp/\`,
+  if present.
+
+Have fun!`;
+    const status = await (0, handleFileConflict_js_1.handleFileConflict)("README.md", readmeContent);
+    if (status === "created") {
+        prompts_1.log.info("Created README.md");
+    }
+    else if (status === "updated") {
+        prompts_1.log.info("Updated README.md");
+    }
+    else {
+        prompts_1.log.warn("README.md skipping creation.");
+    }
+}

package/npm/script/helpers/getInstalledPackages.d.ts

@@ -0,0 +1,2 @@
+export declare function getInstalledPackages(): string[];
+//# sourceMappingURL=getInstalledPackages.d.ts.map

package/npm/script/helpers/getInstalledPackages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getInstalledPackages.d.ts","sourceRoot":"","sources":["../../src/helpers/getInstalledPackages.ts"],"names":[],"mappings":"AAEA,wBAAgB,oBAAoB,IAAI,MAAM,EAAE,CA4B/C"}