@nshiab/setup-data-project 1.0.34 → 1.0.36

package/esm/helpers/createFolderStructure.js

@@ -3,7 +3,7 @@ import { join } from "node:path";
 import { log } from "@clack/prompts";
 export function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
-    const folders = ["data", "helpers", "output"];
+    const folders = ["data", "helpers", "output", "tests"];
     if (!existsSync(sdaFolder)) {
         mkdirSync(sdaFolder, { recursive: true });
     }

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,QAyHvD"}
+{"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,QAgIvD"}

package/esm/helpers/ensureAgents.js

@@ -48,8 +48,17 @@ export function ensureAgents(docsMapping, runtime, installedPackages = Object.ke
         }
     }
     const configFile = runtime === "deno" ? "deno.json" : "package.json";
-    const runSda = runtime === "deno" ? "deno task sda" : "npm run sda";
+    const runSdaOnce = runtime === "deno"
+        ? "deno run -A --env --check sda/main.ts"
+        : runtime === "bun"
+            ? "bun run sda/main.ts"
+            : "node --env-file-if-exists=.env --experimental-strip-types sda/main.ts";
     const runClean = runtime === "deno" ? "deno task clean" : "npm run clean";
+    const runAllTests = runtime === "deno"
+        ? "deno task all-tests"
+        : runtime === "bun"
+            ? "bun run all-tests"
+            : "npm run all-tests";
     const installedPackageConfigs = getInstalledPackageConfigs(installedPackages);
     const importExamples = installedPackageConfigs.map((pkg) => {
         const repoName = pkg.value.split("/")[1];
@@ -69,21 +78,21 @@ ${importExamples.join("\n")}
     }
     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}\`).
+Run \`sda/main.ts\` with \`${runSdaOnce}\`. Do not use the \`sda\` task for agent-driven checks because it runs in watch mode and will keep waiting for file changes.
 
-${runtime === "deno"
-        ? "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."}
+Before handing off your work, always run \`${runAllTests}\`, even if no tests have been added yet. Fix any errors or warnings it reports.
 
-Use the \`clean\` task (e.g. \`${runClean}\`) to remove the cache and other temporary files.
+The \`clean\` task (e.g. \`${runClean}\`) removes caches and other temporary files. Do not run it routinely. Cached results can be especially valuable for computationally expensive operations or API calls. If you are unsure whether the caches should be removed, ask the user first.
 
 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. 
+Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate.
 
-If you need to output data to a file, always put the file in the "sda/output" folder.
+If you need to download data, always put the files in the "sda/data" folder, which is ignored by Git.
+
+If you need to output data to a file, always put the file in the "sda/output" folder, which is also ignored by Git.
 ${libraryGuidance}`;
     if (journalismFunctions !== "") {
         content += `

package/esm/helpers/ensureReadme.js

@@ -35,8 +35,8 @@ Here's the recommended workflow:
 
 - Put your raw data in the \`sda/data\` folder. Note that this folder is
   ignored by Git.
-- Use the \`sda/main.ts\` file to clean and process your raw data. Write the
-  results to the \`sda/output\` folder.
+- Use the \`sda/main.ts\` file to process your raw data. Write the
+  results to the \`sda/output\` folder, which is also ignored by Git.
 
 When working on your project, use the following command:
 

package/esm/helpers/getProjectTasks.d.ts

@@ -1,5 +1,6 @@
 export declare function getProjectTasks(): {
     sda: string;
+    "all-tests": string;
     clean: string;
 };
 //# sourceMappingURL=getProjectTasks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getProjectTasks.d.ts","sourceRoot":"","sources":["../../src/helpers/getProjectTasks.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe;;;EAW9B"}
+{"version":3,"file":"getProjectTasks.d.ts","sourceRoot":"","sources":["../../src/helpers/getProjectTasks.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe;;;;EAgB9B"}

package/esm/helpers/getProjectTasks.js

@@ -7,6 +7,11 @@ export function getProjectTasks() {
             : runtime === "bun"
                 ? "bun run --watch sda/main.ts"
                 : "node --env-file-if-exists=.env --watch --experimental-strip-types sda/main.ts",
+        "all-tests": runtime === "deno"
+            ? "deno fmt --check && deno lint && deno check sda/main.ts && deno test -A"
+            : runtime === "bun"
+                ? "bun test --pass-with-no-tests"
+                : "node --env-file-if-exists=.env --experimental-strip-types --test",
         clean: "rm -rf .sda-cache .journalism-cache .tmp",
     };
 }

package/package.json

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

package/script/helpers/createFolderStructure.js

@@ -6,7 +6,7 @@ const node_path_1 = require("node:path");
 const prompts_1 = require("@clack/prompts");
 function createFolderStructure(selectedPackages) {
     const sdaFolder = "sda";
-    const folders = ["data", "helpers", "output"];
+    const folders = ["data", "helpers", "output", "tests"];
     if (!(0, node_fs_1.existsSync)(sdaFolder)) {
         (0, node_fs_1.mkdirSync)(sdaFolder, { recursive: true });
     }

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,QAyHvD"}
+{"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,QAgIvD"}

package/script/helpers/ensureAgents.js

@@ -51,8 +51,17 @@ function ensureAgents(docsMapping, runtime, installedPackages = Object.keys(docs
         }
     }
     const configFile = runtime === "deno" ? "deno.json" : "package.json";
-    const runSda = runtime === "deno" ? "deno task sda" : "npm run sda";
+    const runSdaOnce = runtime === "deno"
+        ? "deno run -A --env --check sda/main.ts"
+        : runtime === "bun"
+            ? "bun run sda/main.ts"
+            : "node --env-file-if-exists=.env --experimental-strip-types sda/main.ts";
     const runClean = runtime === "deno" ? "deno task clean" : "npm run clean";
+    const runAllTests = runtime === "deno"
+        ? "deno task all-tests"
+        : runtime === "bun"
+            ? "bun run all-tests"
+            : "npm run all-tests";
     const installedPackageConfigs = (0, packageRegistry_js_1.getInstalledPackageConfigs)(installedPackages);
     const importExamples = installedPackageConfigs.map((pkg) => {
         const repoName = pkg.value.split("/")[1];
@@ -72,21 +81,21 @@ ${importExamples.join("\n")}
     }
     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}\`).
+Run \`sda/main.ts\` with \`${runSdaOnce}\`. Do not use the \`sda\` task for agent-driven checks because it runs in watch mode and will keep waiting for file changes.
 
-${runtime === "deno"
-        ? "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."}
+Before handing off your work, always run \`${runAllTests}\`, even if no tests have been added yet. Fix any errors or warnings it reports.
 
-Use the \`clean\` task (e.g. \`${runClean}\`) to remove the cache and other temporary files.
+The \`clean\` task (e.g. \`${runClean}\`) removes caches and other temporary files. Do not run it routinely. Cached results can be especially valuable for computationally expensive operations or API calls. If you are unsure whether the caches should be removed, ask the user first.
 
 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. 
+Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate.
 
-If you need to output data to a file, always put the file in the "sda/output" folder.
+If you need to download data, always put the files in the "sda/data" folder, which is ignored by Git.
+
+If you need to output data to a file, always put the file in the "sda/output" folder, which is also ignored by Git.
 ${libraryGuidance}`;
     if (journalismFunctions !== "") {
         content += `

package/script/helpers/ensureReadme.js

@@ -38,8 +38,8 @@ Here's the recommended workflow:
 
 - Put your raw data in the \`sda/data\` folder. Note that this folder is
   ignored by Git.
-- Use the \`sda/main.ts\` file to clean and process your raw data. Write the
-  results to the \`sda/output\` folder.
+- Use the \`sda/main.ts\` file to process your raw data. Write the
+  results to the \`sda/output\` folder, which is also ignored by Git.
 
 When working on your project, use the following command:
 

package/script/helpers/getProjectTasks.d.ts

@@ -1,5 +1,6 @@
 export declare function getProjectTasks(): {
     sda: string;
+    "all-tests": string;
     clean: string;
 };
 //# sourceMappingURL=getProjectTasks.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getProjectTasks.d.ts","sourceRoot":"","sources":["../../src/helpers/getProjectTasks.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe;;;EAW9B"}
+{"version":3,"file":"getProjectTasks.d.ts","sourceRoot":"","sources":["../../src/helpers/getProjectTasks.ts"],"names":[],"mappings":"AAEA,wBAAgB,eAAe;;;;EAgB9B"}

package/script/helpers/getProjectTasks.js

@@ -10,6 +10,11 @@ function getProjectTasks() {
             : runtime === "bun"
                 ? "bun run --watch sda/main.ts"
                 : "node --env-file-if-exists=.env --watch --experimental-strip-types sda/main.ts",
+        "all-tests": runtime === "deno"
+            ? "deno fmt --check && deno lint && deno check sda/main.ts && deno test -A"
+            : runtime === "bun"
+                ? "bun test --pass-with-no-tests"
+                : "node --env-file-if-exists=.env --experimental-strip-types --test",
         clean: "rm -rf .sda-cache .journalism-cache .tmp",
     };
 }