@nshiab/setup-data-project 2.0.2 → 3.0.0

package/esm/helpers/syncPackageDocs.js

@@ -1,46 +0,0 @@
-import { log } from "@clack/prompts";
-import { existsSync, mkdirSync, renameSync, rmSync } from "node:fs";
-import { join } from "node:path";
-import { fetchPackageDocs } from "./fetchPackageDocs.js";
-import { SUPPORTED_PACKAGES } from "./packageRegistry.js";
-export async function syncPackageDocs(installedPackages, installedVersions) {
-    const installedSet = new Set(installedPackages);
-    const docsMapping = {};
-    for (const pkg of SUPPORTED_PACKAGES) {
-        const repoName = pkg.value.split("/")[1];
-        const docsDirectory = join("docs", repoName);
-        const llmDocsPath = join(docsDirectory, "llm.md");
-        const legacyDocsPath = join("docs", repoName + ".md");
-        if (!installedSet.has(pkg.value)) {
-            for (const path of [docsDirectory, legacyDocsPath]) {
-                if (existsSync(path)) {
-                    rmSync(path, { recursive: true });
-                    log.info(`Removed stale documentation at ${path}.`);
-                }
-            }
-            continue;
-        }
-        if (existsSync(legacyDocsPath)) {
-            if (!existsSync(llmDocsPath)) {
-                mkdirSync(docsDirectory, { recursive: true });
-                renameSync(legacyDocsPath, llmDocsPath);
-                log.info(`Moved documentation to ${llmDocsPath}.`);
-            }
-            else {
-                rmSync(legacyDocsPath);
-            }
-        }
-        const version = installedVersions[pkg.value];
-        if (version === undefined) {
-            log.warn(`Could not determine the exact installed version of ${pkg.value}. ` +
-                "Existing local documentation was preserved but will not be " +
-                "included in AGENTS.md.");
-            continue;
-        }
-        const docs = await fetchPackageDocs(pkg.value, version, { silent: true });
-        if (docs.readme !== undefined || docs.llm !== undefined) {
-            docsMapping[pkg.value] = docs;
-        }
-    }
-    return docsMapping;
-}

package/esm/main.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=main.d.ts.map

package/esm/main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":""}

package/esm/main.js

@@ -1,94 +0,0 @@
-#!/usr/bin/env node
-import { cancel, intro, isCancel, multiselect, outro, select, spinner, } from "@clack/prompts";
-import process from "node:process";
-import { getRuntime } from "./helpers/getRuntime.js";
-import { PACKAGE_OPTIONS } from "./helpers/packageOptions.js";
-import { ensureGitignore } from "./helpers/ensureGitignore.js";
-import { ensureReadme } from "./helpers/ensureReadme.js";
-import { installPackages } from "./helpers/installPackages.js";
-import { getProjectTasks } from "./helpers/getProjectTasks.js";
-import { createFolderStructure } from "./helpers/createFolderStructure.js";
-import { ensureEnvFile } from "./helpers/ensureEnvFile.js";
-import { ensureAgents } from "./helpers/ensureAgents.js";
-import { getInstalledPackageConfigs } from "./helpers/packageRegistry.js";
-import { ProjectManifest } from "./helpers/projectManifest.js";
-import { syncPackageDocs } from "./helpers/syncPackageDocs.js";
-import { getInstalledPackageVersions } from "./helpers/getInstalledPackageVersions.js";
-async function main() {
-    const runtime = getRuntime();
-    console.log();
-    intro(`Hi! 👋 (Running on ${runtime})`);
-    const projectManifest = ProjectManifest.open(runtime);
-    projectManifest.updateTasks(getProjectTasks());
-    const installedPackages = projectManifest.getInstalledPackages();
-    const options = PACKAGE_OPTIONS.map((opt) => ({
-        ...opt,
-        label: installedPackages.includes(opt.value)
-            ? `${opt.label} \x1b[2m(installed)\x1b[22m`
-            : opt.label,
-    }));
-    const selectedPackages = (await multiselect({
-        message: "Which libraries would you like to install?\n\x1b[2m(space to select, arrows to navigate, enter to confirm)\x1b[22m\n",
-        options,
-        required: false,
-    }));
-    if (isCancel(selectedPackages)) {
-        cancel("Installation cancelled.");
-        process.exit(0);
-    }
-    const alreadyInstalled = selectedPackages.filter((pkg) => installedPackages.includes(pkg));
-    const packagesToInstall = [];
-    for (const pkg of selectedPackages) {
-        if (alreadyInstalled.includes(pkg)) {
-            const action = await select({
-                message: `${pkg} is already installed. What would you like to do?`,
-                options: [
-                    { value: "skip", label: "Keep existing version" },
-                    { value: "update", label: "Update to latest" },
-                ],
-            });
-            if (isCancel(action)) {
-                cancel("Installation cancelled.");
-                process.exit(0);
-            }
-            if (action === "update") {
-                packagesToInstall.push(pkg);
-            }
-        }
-        else {
-            packagesToInstall.push(pkg);
-        }
-    }
-    const sInstall = spinner();
-    sInstall.start("Installing packages...");
-    for (const pkg of packagesToInstall) {
-        try {
-            await installPackages([pkg], { silent: true });
-        }
-        catch (error) {
-            sInstall.stop(`❌ Failed to install ${pkg}.`);
-            console.error(error);
-            process.exit(1);
-        }
-    }
-    sInstall.stop("✅ Package installation complete.");
-    projectManifest.reload();
-    projectManifest.updateTasks(getProjectTasks());
-    const finalInstalledPackages = getInstalledPackageConfigs(projectManifest.getInstalledPackages()).map((pkg) => pkg.value);
-    const finalInstalledVersions = getInstalledPackageVersions(projectManifest.getInstalledPackageSpecifiers());
-    const sDocs = spinner();
-    sDocs.start("Fetching documentation for installed package versions...");
-    const docsMapping = await syncPackageDocs(finalInstalledPackages, finalInstalledVersions);
-    sDocs.stop("✅ Documentation synchronization complete.");
-    createFolderStructure(finalInstalledPackages);
-    ensureGitignore();
-    ensureEnvFile();
-    await ensureReadme(runtime, finalInstalledPackages);
-    await ensureAgents(docsMapping, runtime, finalInstalledPackages);
-    outro("You are all set! 🙌");
-}
-main().catch((error) => {
-    const message = error instanceof Error ? error.message : String(error);
-    console.error(`❌ Error: ${message}`);
-    process.exitCode = 1;
-});

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}

package/script/_dnt.shims.d.ts

@@ -1,2 +0,0 @@
-export declare const dntGlobalThis: Omit<typeof globalThis, never>;
-//# sourceMappingURL=_dnt.shims.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"_dnt.shims.d.ts","sourceRoot":"","sources":["../src/_dnt.shims.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,gCAA2C,CAAC"}

package/script/_dnt.shims.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dntGlobalThis = void 0;
-const dntGlobals = {};
-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/script/helpers/createFolderStructure.d.ts

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

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

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

package/script/helpers/createFolderStructure.js

@@ -1,43 +0,0 @@
-"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");
-function createFolderStructure(selectedPackages) {
-    const sdaFolder = "sda";
-    const folders = ["data", "helpers", "output", "tests"];
-    if (!(0, node_fs_1.existsSync)(sdaFolder)) {
-        (0, node_fs_1.mkdirSync)(sdaFolder, { recursive: true });
-    }
-    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 });
-        }
-    }
-    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") ||
-        selectedPackages.includes("@nshiab/simple-data-analysis-core")) {
-        const pkg = selectedPackages.includes("@nshiab/simple-data-analysis")
-            ? "@nshiab/simple-data-analysis"
-            : "@nshiab/simple-data-analysis-core";
-        mainTsContent = `import { SimpleDB } from "${pkg}";
-
-const sdb = new SimpleDB();
-const table = sdb.newTable();
-
-await table
-  .loadArray([{ message: "Hello simple-data-analysis!" }])
-  .log();
-
-await sdb.close();
-`;
-    }
-    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

@@ -1,3 +0,0 @@
-import type { PackageDocs } from "./fetchPackageDocs.js";
-export declare function ensureAgents(docsMapping: Record<string, PackageDocs>, runtime: string, installedPackages?: string[]): void;
-//# sourceMappingURL=ensureAgents.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ensureAgents.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureAgents.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAOzD,wBAAgB,YAAY,CAC1B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,EACxC,OAAO,EAAE,MAAM,EACf,iBAAiB,GAAE,MAAM,EAA6B,QAqLvD"}

package/script/helpers/ensureAgents.js

@@ -1,179 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureAgents = ensureAgents;
-const prompts_1 = require("@clack/prompts");
-const ensureManagedSection_js_1 = require("./ensureManagedSection.js");
-const packageRegistry_js_1 = require("./packageRegistry.js");
-function ensureAgents(docsMapping, runtime, installedPackages = Object.keys(docsMapping)) {
-    let journalismFunctions = "";
-    let sdaClassesAndMethods = "";
-    let sdaDocsPath = "";
-    let sdaReadmePath = "";
-    let sdaLibraryName = "";
-    const journalismFunctionsByPackage = new Map();
-    for (const [pkg, docs] of Object.entries(docsMapping)) {
-        const pkgConfig = packageRegistry_js_1.SUPPORTED_PACKAGES.find((p) => p.value === pkg);
-        const pkgType = pkgConfig?.type || "other";
-        const doc = docs.llm;
-        if (doc === undefined)
-            continue;
-        if (pkgType === "journalism") {
-            const repoName = pkg.split("/")[1];
-            const functions = doc
-                .split("\n")
-                .filter((line) => line.trim().startsWith("#"))
-                .filter((line) => {
-                const depth = line.match(/^#+/)?.[0].length || 0;
-                return depth === 2;
-            })
-                .map((line) => line.replace(/^#+\s+/, "").trim());
-            journalismFunctionsByPackage.set(pkg, functions);
-            journalismFunctions += `\n### ${repoName}\n\n`;
-            journalismFunctions += functions.map((name) => `- ${name}`).join("\n") +
-                "\n";
-        }
-        else if (pkgType === "sda") {
-            const repoName = pkg.split("/")[1];
-            sdaDocsPath = `./docs/${repoName}/llm.md`;
-            sdaReadmePath = docs.readme === undefined
-                ? ""
-                : `./docs/${repoName}/README.md`;
-            sdaLibraryName = pkgConfig?.label || repoName;
-            sdaClassesAndMethods = doc
-                .split("\n")
-                .filter((line) => line.trim().startsWith("#"))
-                .filter((line) => {
-                const depth = line.match(/^#+/)?.[0].length || 0;
-                if (depth === 2)
-                    return true;
-                if (depth !== 4)
-                    return false;
-                const heading = line.replace(/^#+\s+/, "").replaceAll("`", "")
-                    .trim();
-                return heading !== "Parameters";
-            })
-                .map((line) => {
-                const depth = line.match(/^#+/)?.[0].length || 0;
-                if (depth === 2) {
-                    return "\n" + line.replace(/^#+\s+/, "").trim();
-                }
-                else {
-                    return line.replace(/^#+\s+/, "  - ")
-                        .replaceAll("`", "");
-                }
-            })
-                .join("\n");
-        }
-    }
-    const configFile = runtime === "deno" ? "deno.json" : "package.json";
-    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.flatMap((pkg) => {
-        if (pkg.type === "sda") {
-            return [`import { SimpleDB } from "${pkg.value}";`];
-        }
-        const functionName = journalismFunctionsByPackage.get(pkg.value)
-            ?.map((name) => name.replaceAll("`", ""))
-            .find((name) => /^[A-Za-z_$][\w$]*$/.test(name));
-        return functionName
-            ? [`import { ${functionName} } from "${pkg.value}";`]
-            : [];
-    });
-    let libraryGuidance = "";
-    if (installedPackageConfigs.length > 0) {
-        const libraryNames = installedPackageConfigs.map((pkg) => `"${pkg.value}"`)
-            .join(", ");
-        const libraryNoun = installedPackageConfigs.length === 1
-            ? "library"
-            : "libraries";
-        libraryGuidance = `
-Always prioritize the installed ${libraryNames} ${libraryNoun} when relevant.
-`;
-        const documentationGuidance = installedPackageConfigs.flatMap((pkg) => {
-            const docs = docsMapping[pkg.value];
-            if (!docs)
-                return [];
-            const repoName = pkg.value.split("/")[1];
-            const availableDocs = [
-                docs.readme === undefined
-                    ? ""
-                    : `overview and practical examples at \`./docs/${repoName}/README.md\``,
-                docs.llm === undefined
-                    ? ""
-                    : `complete API documentation at \`./docs/${repoName}/llm.md\``,
-            ].filter(Boolean);
-            return availableDocs.length === 0
-                ? []
-                : [`- \`${pkg.value}\`: ${availableDocs.join("; ")}`];
-        });
-        if (documentationGuidance.length > 0) {
-            libraryGuidance += `
-The following documentation was fetched for the exact installed library versions. Consult it when relevant:
-
-${documentationGuidance.join("\n")}
-`;
-        }
-        if (importExamples.length > 0) {
-            libraryGuidance += `APIs can be imported with named imports like this:
-\`\`\`typescript
-${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.
-
-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.
-
-Before handing off your work, always run \`${runAllTests}\`, even if no tests have been added yet. Fix any errors or warnings it reports.
-
-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.
-
-Put tests in the "sda/tests" folder. Write focused tests for reusable helpers and important data transformations when appropriate. When testing a helper from "sda/helpers/functionName.ts", name its test file "sda/tests/functionName.test.ts".
-
-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 += `
-Here are the functions available in the "journalism" libraries. If one of the functions might be relevant, search its complete API documentation in the corresponding \`./docs/<library-name>/llm.md\` file to properly use it.
-${journalismFunctions}`;
-    }
-    if (sdaClassesAndMethods !== "") {
-        const readmeGuidance = sdaReadmePath === ""
-            ? ""
-            : ` An overview and practical examples are available at "${sdaReadmePath}".`;
-        content += `
-Here are the classes and their methods available in the "${sdaLibraryName}" library.${readmeGuidance} If one of the classes or methods might be relevant, search the complete API documentation at "${sdaDocsPath}" to properly use it.
-
-Most data-loading and transformation methods are synchronous, chainable builders. Await the final asynchronous observer or export method, such as \`log()\`, \`getData()\`, or \`writeData()\`, to execute the queued operations. If a chain ends without an observer, call \`run()\`. Always call \`await sdb.close()\` when the database is no longer needed. Methods that return an answer or export to an external service can be asynchronous, so verify their documentation before calling them.
-${sdaClassesAndMethods}`;
-    }
-    const status = (0, ensureManagedSection_js_1.ensureManagedSection)({
-        path: "AGENTS.md",
-        name: "agents",
-        content,
-        createContent: (managedSection) => managedSection,
-    });
-    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

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

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

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

package/script/helpers/ensureEnvFile.js

@@ -1,11 +0,0 @@
-"use strict";
-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

@@ -1,3 +0,0 @@
-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 +0,0 @@
-{"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

@@ -1,28 +0,0 @@
-"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";
-    const stats = (0, node_fs_1.lstatSync)(path, { throwIfNoEntry: false });
-    if (stats?.isSymbolicLink()) {
-        return;
-    }
-    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);
-    prompts_1.log.info(`${stats === undefined ? "Created" : "Updated"} ${path}`);
-}

package/script/helpers/ensureManagedSection.d.ts

@@ -1,9 +0,0 @@
-interface ManagedSectionOptions {
-    path: string;
-    name: string;
-    content: string;
-    createContent: (section: string) => string;
-}
-export declare function ensureManagedSection(options: ManagedSectionOptions): "created" | "updated" | "unchanged" | "missing-markers";
-export {};
-//# sourceMappingURL=ensureManagedSection.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ensureManagedSection.d.ts","sourceRoot":"","sources":["../../src/helpers/ensureManagedSection.ts"],"names":[],"mappings":"AAGA,UAAU,qBAAqB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC;CAC5C;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,qBAAqB,GAC7B,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,iBAAiB,CAwCzD"}

package/script/helpers/ensureManagedSection.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureManagedSection = ensureManagedSection;
-const prompts_1 = require("@clack/prompts");
-const node_fs_1 = require("node:fs");
-function ensureManagedSection(options) {
-    const startMarker = `<!-- Do not remove / setup-data-project:${options.name}:start -->`;
-    const endMarker = `<!-- Do not remove / setup-data-project:${options.name}:end -->`;
-    const trimmedContent = options.content.trim();
-    const section = trimmedContent === ""
-        ? `${startMarker}\n${endMarker}`
-        : `${startMarker}\n${trimmedContent}\n${endMarker}`;
-    if (!(0, node_fs_1.existsSync)(options.path)) {
-        (0, node_fs_1.writeFileSync)(options.path, ensureFinalNewline(options.createContent(section)));
-        return "created";
-    }
-    const currentContent = (0, node_fs_1.readFileSync)(options.path, "utf-8");
-    const start = currentContent.indexOf(startMarker);
-    const end = currentContent.indexOf(endMarker);
-    if (start === -1 || end === -1 || end < start) {
-        prompts_1.log.warn(`${options.path} was not updated because its setup-data-project markers ` +
-            `were not found. Add ${startMarker} and ${endMarker}, then rerun the ` +
-            "script.");
-        return "missing-markers";
-    }
-    const nextContent = currentContent.slice(0, start) + section +
-        currentContent.slice(end + endMarker.length);
-    if (nextContent === currentContent) {
-        return "unchanged";
-    }
-    (0, node_fs_1.writeFileSync)(options.path, ensureFinalNewline(nextContent));
-    return "updated";
-}
-function ensureFinalNewline(content) {
-    return content.endsWith("\n") ? content : content + "\n";
-}

package/script/helpers/ensureReadme.d.ts

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

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

@@ -1 +0,0 @@
-{"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,QAsEjC"}

package/script/helpers/ensureReadme.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureReadme = ensureReadme;
-const prompts_1 = require("@clack/prompts");
-const ensureManagedSection_js_1 = require("./ensureManagedSection.js");
-const packageRegistry_js_1 = require("./packageRegistry.js");
-function ensureReadme(runtime, installedPackages = []) {
-    let runCommand = "npm run";
-    if (runtime === "deno") {
-        runCommand = "deno task";
-    }
-    else if (runtime === "bun") {
-        runCommand = "bun run";
-    }
-    const installedPackageConfigs = (0, packageRegistry_js_1.getInstalledPackageConfigs)(installedPackages);
-    const hasSdaCore = installedPackageConfigs.some((pkg) => pkg.value === "@nshiab/simple-data-analysis-core");
-    const hasFullSda = installedPackageConfigs.some((pkg) => pkg.value === "@nshiab/simple-data-analysis");
-    const hasJournalism = installedPackageConfigs.some((pkg) => pkg.type === "journalism");
-    const libraryLinks = [
-        hasSdaCore
-            ? "[simple-data-analysis-core](https://github.com/nshiab/simple-data-analysis-core)"
-            : "",
-        hasFullSda
-            ? "[simple-data-analysis](https://github.com/nshiab/simple-data-analysis)"
-            : "",
-        hasJournalism ? "[journalism](https://github.com/nshiab/journalism)" : "",
-    ].filter(Boolean);
-    const librarySection = libraryLinks.length === 0
-        ? ""
-        : `It has installed ${libraryLinks.join(" and ")} ${libraryLinks.length === 1 ? "library" : "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 was created with
-[setup-data-project](https://github.com/nshiab/setup-data-project/).
-
-${managedSection}
-
-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 process your raw data. Write the
-  results to the \`sda/output\` folder, which is also ignored by Git.
-- Put your tests in the \`sda/tests\` folder.
-
-When working on your project, use the following commands:
-
-- \`${runCommand} sda\` will watch your \`sda/main.ts\` and its dependencies.
-  Whenever you save changes, the data will be reprocessed.
-- \`${runCommand} all-tests\` will run the project's test command.
-- \`${runCommand} clean\` will remove cache and temporary files, if present.
-
-Have fun!`,
-    });
-    if (status === "created") {
-        prompts_1.log.info("Created README.md");
-    }
-    else if (status === "updated") {
-        prompts_1.log.info("Updated README.md");
-    }
-}

package/script/helpers/fetchPackageDocs.d.ts

@@ -1,8 +0,0 @@
-export interface PackageDocs {
-    readme?: string;
-    llm?: string;
-}
-export declare function fetchPackageDocs(pkg: string, version: string, options?: {
-    silent?: boolean;
-}): Promise<PackageDocs>;
-//# sourceMappingURL=fetchPackageDocs.d.ts.map