@nshiab/setup-data-project 1.0.30 → 1.0.31

package/esm/helpers/createFolderStructure.d.ts

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

package/esm/helpers/createFolderStructure.d.ts.map

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

package/esm/helpers/createFolderStructure.js

@@ -1,8 +1,6 @@
-import { existsSync, mkdirSync } from "node:fs";
+import { existsSync, lstatSync, mkdirSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
-import { log } from "@clack/prompts";
-import { handleFileConflict } from "./handleFileConflict.js";
-export async function createFolderStructure(selectedPackages) {
+export function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
     const folders = ["data", "helpers", "output"];
     if (!existsSync(sdaFolder)) {
@@ -34,9 +32,8 @@ await table.logTable();
 await sdb.done();
 `;
     }
-    const status = await handleFileConflict(mainTsPath, mainTsContent);
-    if (status === "updated") {
-        log.info(`Updated ${mainTsPath}`);
+    if (lstatSync(mainTsPath, { throwIfNoEntry: false }) === undefined) {
+        writeFileSync(mainTsPath, mainTsContent);
     }
     return sdaFolder;
 }

package/esm/helpers/ensureEnvFile.d.ts

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

package/esm/helpers/ensureEnvFile.d.ts.map

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

package/esm/helpers/ensureEnvFile.js

@@ -1,8 +1,6 @@
-import { log } from "@clack/prompts";
-import { handleFileConflict } from "./handleFileConflict.js";
-export async function ensureEnvFile() {
-    const status = await handleFileConflict(".env", "");
-    if (status === "updated") {
-        log.info("Updated .env");
+import { lstatSync, writeFileSync } from "node:fs";
+export function ensureEnvFile() {
+    if (lstatSync(".env", { throwIfNoEntry: false }) === undefined) {
+        writeFileSync(".env", "");
     }
 }

package/esm/helpers/ensureGitignore.d.ts

@@ -1,2 +1,3 @@
+export declare const GITIGNORE_SENTINEL = "# Added by setup-data-project. Do not remove this line.";
 export declare function ensureGitignore(): void;
 //# sourceMappingURL=ensureGitignore.d.ts.map

package/esm/helpers/ensureGitignore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ensureGitignore.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureGitignore.ts"],"names":[],"mappings":"AAIA,wBAAgB,eAAe,SAqB9B"}
+{"version":3,"file":"ensureGitignore.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureGitignore.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,kBAAkB,4DAC4B,CAAC;AAE5D,wBAAgB,eAAe,SA4B9B"}

package/esm/helpers/ensureGitignore.js

@@ -1,23 +1,26 @@
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import { lstatSync, readFileSync, writeFileSync } from "node:fs";
 import { log } from "@clack/prompts";
 import { GITIGNORE_ENTRIES } from "./gitignoreEntries.js";
+export const GITIGNORE_SENTINEL = "# Added by setup-data-project. Do not remove this line.";
 export function ensureGitignore() {
     const path = ".gitignore";
-    let content = "";
-    let exists = false;
-    if (existsSync(path)) {
-        content = readFileSync(path, "utf-8");
-        exists = true;
+    const stats = lstatSync(path, { throwIfNoEntry: false });
+    if (stats?.isSymbolicLink()) {
+        return;
     }
-    const lines = content.split("\n").map((l) => l.trim());
-    const toAdd = 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";
-        writeFileSync(path, content + newContent);
-        if (exists) {
-            log.info(`Updated ${path}`);
-        }
+    const content = stats === undefined ? "" : readFileSync(path, "utf-8");
+    const hasSentinel = content.split("\n").some((line) => line.trim() === GITIGNORE_SENTINEL);
+    if (hasSentinel) {
+        return;
+    }
+    const separator = content === ""
+        ? ""
+        : content.endsWith("\n")
+            ? "\n"
+            : "\n\n";
+    const block = `${GITIGNORE_SENTINEL}\n${GITIGNORE_ENTRIES.join("\n")}\n`;
+    writeFileSync(path, content + separator + block);
+    if (stats !== undefined) {
+        log.info(`Updated ${path}`);
     }
 }

package/esm/main.js

@@ -75,9 +75,9 @@ async function main() {
     projectManifest.updateTasks(getProjectTasks());
     const finalInstalledPackages = getInstalledPackageConfigs(projectManifest.getInstalledPackages()).map((pkg) => pkg.value);
     const docsMapping = await syncPackageDocs(finalInstalledPackages, packagesToInstall);
-    await createFolderStructure(finalInstalledPackages);
+    createFolderStructure(finalInstalledPackages);
     ensureGitignore();
-    await ensureEnvFile();
+    ensureEnvFile();
     await ensureReadme(runtime, finalInstalledPackages);
     await ensureAgents(docsMapping, runtime, finalInstalledPackages);
     outro("You are all set! 🙌");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nshiab/setup-data-project",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "description": "Quickly kick off your data project using the simple-data-analysis and journalism libraries.",
   "repository": {
     "type": "git",

package/script/helpers/createFolderStructure.d.ts

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

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

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

package/script/helpers/createFolderStructure.js

@@ -3,9 +3,7 @@ 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) {
+function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
     const folders = ["data", "helpers", "output"];
     if (!(0, node_fs_1.existsSync)(sdaFolder)) {
@@ -37,9 +35,8 @@ await table.logTable();
 await sdb.done();
 `;
     }
-    const status = await (0, handleFileConflict_js_1.handleFileConflict)(mainTsPath, mainTsContent);
-    if (status === "updated") {
-        prompts_1.log.info(`Updated ${mainTsPath}`);
+    if ((0, node_fs_1.lstatSync)(mainTsPath, { throwIfNoEntry: false }) === undefined) {
+        (0, node_fs_1.writeFileSync)(mainTsPath, mainTsContent);
     }
     return sdaFolder;
 }

package/script/helpers/ensureEnvFile.d.ts

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

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

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

package/script/helpers/ensureEnvFile.js

@@ -1,11 +1,9 @@
 "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 === "updated") {
-        prompts_1.log.info("Updated .env");
+const node_fs_1 = require("node:fs");
+function ensureEnvFile() {
+    if ((0, node_fs_1.lstatSync)(".env", { throwIfNoEntry: false }) === undefined) {
+        (0, node_fs_1.writeFileSync)(".env", "");
     }
 }

package/script/helpers/ensureGitignore.d.ts

@@ -1,2 +1,3 @@
+export declare const GITIGNORE_SENTINEL = "# Added by setup-data-project. Do not remove this line.";
 export declare function ensureGitignore(): void;
 //# sourceMappingURL=ensureGitignore.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ensureGitignore.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureGitignore.ts"],"names":[],"mappings":"AAIA,wBAAgB,eAAe,SAqB9B"}
+{"version":3,"file":"ensureGitignore.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureGitignore.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,kBAAkB,4DAC4B,CAAC;AAE5D,wBAAgB,eAAe,SA4B9B"}

package/script/helpers/ensureGitignore.js

@@ -1,26 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GITIGNORE_SENTINEL = void 0;
 exports.ensureGitignore = ensureGitignore;
 const node_fs_1 = require("node:fs");
 const prompts_1 = require("@clack/prompts");
 const gitignoreEntries_js_1 = require("./gitignoreEntries.js");
+exports.GITIGNORE_SENTINEL = "# Added by setup-data-project. Do not remove this line.";
 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 stats = (0, node_fs_1.lstatSync)(path, { throwIfNoEntry: false });
+    if (stats?.isSymbolicLink()) {
+        return;
     }
-    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}`);
-        }
+    const content = stats === undefined ? "" : (0, node_fs_1.readFileSync)(path, "utf-8");
+    const hasSentinel = content.split("\n").some((line) => line.trim() === exports.GITIGNORE_SENTINEL);
+    if (hasSentinel) {
+        return;
+    }
+    const separator = content === ""
+        ? ""
+        : content.endsWith("\n")
+            ? "\n"
+            : "\n\n";
+    const block = `${exports.GITIGNORE_SENTINEL}\n${gitignoreEntries_js_1.GITIGNORE_ENTRIES.join("\n")}\n`;
+    (0, node_fs_1.writeFileSync)(path, content + separator + block);
+    if (stats !== undefined) {
+        prompts_1.log.info(`Updated ${path}`);
     }
 }

package/script/main.js

@@ -80,9 +80,9 @@ async function main() {
     projectManifest.updateTasks((0, getProjectTasks_js_1.getProjectTasks)());
     const finalInstalledPackages = (0, packageRegistry_js_1.getInstalledPackageConfigs)(projectManifest.getInstalledPackages()).map((pkg) => pkg.value);
     const docsMapping = await (0, syncPackageDocs_js_1.syncPackageDocs)(finalInstalledPackages, packagesToInstall);
-    await (0, createFolderStructure_js_1.createFolderStructure)(finalInstalledPackages);
+    (0, createFolderStructure_js_1.createFolderStructure)(finalInstalledPackages);
     (0, ensureGitignore_js_1.ensureGitignore)();
-    await (0, ensureEnvFile_js_1.ensureEnvFile)();
+    (0, ensureEnvFile_js_1.ensureEnvFile)();
     await (0, ensureReadme_js_1.ensureReadme)(runtime, finalInstalledPackages);
     await (0, ensureAgents_js_1.ensureAgents)(docsMapping, runtime, finalInstalledPackages);
     (0, prompts_1.outro)("You are all set! 🙌");

package/esm/helpers/handleFileConflict.d.ts

@@ -1,5 +0,0 @@
-export declare const PROMPT_OVERRIDE: {
-    select: (config: unknown) => Promise<string | symbol>;
-};
-export declare function handleFileConflict(path: string, newContent: string): Promise<"created" | "updated" | "skipped">;
-//# sourceMappingURL=handleFileConflict.d.ts.map

package/esm/helpers/handleFileConflict.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"handleFileConflict.d.ts","sourceRoot":"","sources":["../../src/helpers/handleFileConflict.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,eAAe,EAAE;IAC5B,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CAGvD,CAAC;AAEF,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC,CAoD5C"}

package/esm/helpers/handleFileConflict.js

@@ -1,50 +0,0 @@
-import { existsSync, readFileSync, writeFileSync } from "node:fs";
-import { isCancel, select } from "@clack/prompts";
-import process from "node:process";
-export const PROMPT_OVERRIDE = {
-    select: select,
-};
-export async function handleFileConflict(path, newContent) {
-    if (!existsSync(path)) {
-        writeFileSync(path, newContent);
-        return "created";
-    }
-    // Skip prompt in Deno tests if no override
-    // @ts-ignore: Deno is not defined in type but present in runtime
-    if (globalThis.Deno?.args.includes("--internal-test-mode") &&
-        PROMPT_OVERRIDE.select === select) {
-        return "skipped";
-    }
-    const action = (await PROMPT_OVERRIDE.select({
-        message: `${path} already exists. What would you like to do?`,
-        options: [
-            { value: "skip", label: "Skip", hint: "Keep existing file" },
-            {
-                value: "overwrite",
-                label: "Overwrite",
-                hint: "Replace with new content",
-            },
-            { value: "append", label: "Append", hint: "Add to the end of the file" },
-        ],
-    }));
-    if (isCancel(action)) {
-        console.log("Operation cancelled.");
-        process.exit(0);
-    }
-    if (action === "skip") {
-        return "skipped";
-    }
-    if (action === "overwrite") {
-        writeFileSync(path, newContent);
-        return "updated";
-    }
-    if (action === "append") {
-        const existingContent = readFileSync(path, "utf-8");
-        const prefix = existingContent.endsWith("\n") || existingContent === ""
-            ? ""
-            : "\n";
-        writeFileSync(path, existingContent + prefix + newContent);
-        return "updated";
-    }
-    return "skipped";
-}

package/script/helpers/handleFileConflict.d.ts

@@ -1,5 +0,0 @@
-export declare const PROMPT_OVERRIDE: {
-    select: (config: unknown) => Promise<string | symbol>;
-};
-export declare function handleFileConflict(path: string, newContent: string): Promise<"created" | "updated" | "skipped">;
-//# sourceMappingURL=handleFileConflict.d.ts.map

package/script/helpers/handleFileConflict.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"handleFileConflict.d.ts","sourceRoot":"","sources":["../../src/helpers/handleFileConflict.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,eAAe,EAAE;IAC5B,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CAGvD,CAAC;AAEF,wBAAsB,kBAAkB,CACtC,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC,CAoD5C"}

package/script/helpers/handleFileConflict.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROMPT_OVERRIDE = void 0;
-exports.handleFileConflict = handleFileConflict;
-const node_fs_1 = require("node:fs");
-const prompts_1 = require("@clack/prompts");
-const node_process_1 = __importDefault(require("node:process"));
-exports.PROMPT_OVERRIDE = {
-    select: prompts_1.select,
-};
-async function handleFileConflict(path, newContent) {
-    if (!(0, node_fs_1.existsSync)(path)) {
-        (0, node_fs_1.writeFileSync)(path, newContent);
-        return "created";
-    }
-    // Skip prompt in Deno tests if no override
-    // @ts-ignore: Deno is not defined in type but present in runtime
-    if (globalThis.Deno?.args.includes("--internal-test-mode") &&
-        exports.PROMPT_OVERRIDE.select === prompts_1.select) {
-        return "skipped";
-    }
-    const action = (await exports.PROMPT_OVERRIDE.select({
-        message: `${path} already exists. What would you like to do?`,
-        options: [
-            { value: "skip", label: "Skip", hint: "Keep existing file" },
-            {
-                value: "overwrite",
-                label: "Overwrite",
-                hint: "Replace with new content",
-            },
-            { value: "append", label: "Append", hint: "Add to the end of the file" },
-        ],
-    }));
-    if ((0, prompts_1.isCancel)(action)) {
-        console.log("Operation cancelled.");
-        node_process_1.default.exit(0);
-    }
-    if (action === "skip") {
-        return "skipped";
-    }
-    if (action === "overwrite") {
-        (0, node_fs_1.writeFileSync)(path, newContent);
-        return "updated";
-    }
-    if (action === "append") {
-        const existingContent = (0, node_fs_1.readFileSync)(path, "utf-8");
-        const prefix = existingContent.endsWith("\n") || existingContent === ""
-            ? ""
-            : "\n";
-        (0, node_fs_1.writeFileSync)(path, existingContent + prefix + newContent);
-        return "updated";
-    }
-    return "skipped";
-}