@nshiab/setup-data-project 1.0.32 → 1.0.34

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

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

package/esm/helpers/createFolderStructure.js

@@ -1,5 +1,6 @@
 import { existsSync, lstatSync, mkdirSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
+import { log } from "@clack/prompts";
 export function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
     const folders = ["data", "helpers", "output"];
@@ -34,6 +35,7 @@ await sdb.done();
     }
     if (lstatSync(mainTsPath, { throwIfNoEntry: false }) === undefined) {
         writeFileSync(mainTsPath, mainTsContent);
+        log.info(`Created ${mainTsPath}`);
     }
     return sdaFolder;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AAOA,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAA6B,QAuHvD"}
+{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AAOA,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAA6B,QAyHvD"}

package/esm/helpers/ensureAgents.js

@@ -101,7 +101,10 @@ ${sdaClassesAndMethods}`;
         content,
         createContent: (managedSection) => managedSection,
     });
-    if (status === "created" || status === "updated") {
+    if (status === "created") {
+        log.info("Created AGENTS.md");
+    }
+    else if (status === "updated") {
         log.info("Updated AGENTS.md");
     }
 }

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

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

package/esm/helpers/ensureEnvFile.js

@@ -1,6 +1,8 @@
 import { lstatSync, writeFileSync } from "node:fs";
+import { log } from "@clack/prompts";
 export function ensureEnvFile() {
     if (lstatSync(".env", { throwIfNoEntry: false }) === undefined) {
         writeFileSync(".env", "");
+        log.info("Created .env");
     }
 }

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

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

package/esm/helpers/ensureGitignore.js

@@ -20,7 +20,5 @@ export function ensureGitignore() {
             : "\n\n";
     const block = `${GITIGNORE_SENTINEL}\n${GITIGNORE_ENTRIES.join("\n")}\n`;
     writeFileSync(path, content + separator + block);
-    if (stats !== undefined) {
-        log.info(`Updated ${path}`);
-    }
+    log.info(`${stats === undefined ? "Created" : "Updated"} ${path}`);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QAwDjC"}
+{"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA0DjC"}

package/esm/helpers/ensureReadme.js

@@ -20,13 +20,13 @@ export function ensureReadme(runtime, installedPackages = []) {
     ].filter(Boolean);
     const librarySection = libraryLinks.length === 0
         ? ""
-        : `It's installing ${libraryLinks.join(" and ")} libraries, with up-to-date
-documentation and AI agent instructions.`;
+        : `It has installed ${libraryLinks.join(" and ")} libraries, along with
+up-to-date documentation and AI agent instructions.`;
     const status = ensureManagedSection({
         path: "README.md",
         name: "libraries",
         content: librarySection,
-        createContent: (managedSection) => `This repository has been created with
+        createContent: (managedSection) => `This repository was created with
 [setup-data-project](https://github.com/nshiab/setup-data-project/).
 
 ${managedSection}
@@ -34,19 +34,22 @@ ${managedSection}
 Here's the recommended workflow:
 
 - Put your raw data in the \`sda/data\` folder. Note that this folder is
-  gitignored.
+  ignored by Git.
 - 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:
 
-- \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies. Everytime
-  you'll save some changes, the data will be reprocessed.
+- \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies.
+  Whenever you save changes, the data will be reprocessed.
 - \`${runCommand} clean\` will remove cache and temporary files, if present.
 
 Have fun!`,
     });
-    if (status === "created" || status === "updated") {
+    if (status === "created") {
+        log.info("Created README.md");
+    }
+    else if (status === "updated") {
         log.info("Updated README.md");
     }
 }

package/package.json

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

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

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

package/script/helpers/createFolderStructure.js

@@ -3,6 +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");
 function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
     const folders = ["data", "helpers", "output"];
@@ -37,6 +38,7 @@ await sdb.done();
     }
     if ((0, node_fs_1.lstatSync)(mainTsPath, { throwIfNoEntry: false }) === undefined) {
         (0, node_fs_1.writeFileSync)(mainTsPath, mainTsContent);
+        prompts_1.log.info(`Created ${mainTsPath}`);
     }
     return sdaFolder;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AAOA,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAA6B,QAuHvD"}
+{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AAOA,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAA6B,QAyHvD"}

package/script/helpers/ensureAgents.js

@@ -104,7 +104,10 @@ ${sdaClassesAndMethods}`;
         content,
         createContent: (managedSection) => managedSection,
     });
-    if (status === "created" || status === "updated") {
+    if (status === "created") {
+        prompts_1.log.info("Created AGENTS.md");
+    }
+    else if (status === "updated") {
         prompts_1.log.info("Updated AGENTS.md");
     }
 }

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

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

package/script/helpers/ensureEnvFile.js

@@ -2,8 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureEnvFile = ensureEnvFile;
 const node_fs_1 = require("node:fs");
+const prompts_1 = require("@clack/prompts");
 function ensureEnvFile() {
     if ((0, node_fs_1.lstatSync)(".env", { throwIfNoEntry: false }) === undefined) {
         (0, node_fs_1.writeFileSync)(".env", "");
+        prompts_1.log.info("Created .env");
     }
 }

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

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

package/script/helpers/ensureGitignore.js

@@ -24,7 +24,5 @@ function ensureGitignore() {
             : "\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}`);
-    }
+    prompts_1.log.info(`${stats === undefined ? "Created" : "Updated"} ${path}`);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QAwDjC"}
+{"version":3,"file":"ensureReadme.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureReadme.ts"],"names":[],"mappings":"AAIA,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAAO,QA0DjC"}

package/script/helpers/ensureReadme.js

@@ -23,13 +23,13 @@ function ensureReadme(runtime, installedPackages = []) {
     ].filter(Boolean);
     const librarySection = libraryLinks.length === 0
         ? ""
-        : `It's installing ${libraryLinks.join(" and ")} libraries, with up-to-date
-documentation and AI agent instructions.`;
+        : `It has installed ${libraryLinks.join(" and ")} libraries, along with
+up-to-date documentation and AI agent instructions.`;
     const status = (0, ensureManagedSection_js_1.ensureManagedSection)({
         path: "README.md",
         name: "libraries",
         content: librarySection,
-        createContent: (managedSection) => `This repository has been created with
+        createContent: (managedSection) => `This repository was created with
 [setup-data-project](https://github.com/nshiab/setup-data-project/).
 
 ${managedSection}
@@ -37,19 +37,22 @@ ${managedSection}
 Here's the recommended workflow:
 
 - Put your raw data in the \`sda/data\` folder. Note that this folder is
-  gitignored.
+  ignored by Git.
 - 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:
 
-- \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies. Everytime
-  you'll save some changes, the data will be reprocessed.
+- \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies.
+  Whenever you save changes, the data will be reprocessed.
 - \`${runCommand} clean\` will remove cache and temporary files, if present.
 
 Have fun!`,
     });
-    if (status === "created" || status === "updated") {
+    if (status === "created") {
+        prompts_1.log.info("Created README.md");
+    }
+    else if (status === "updated") {
         prompts_1.log.info("Updated README.md");
     }
 }