@nshiab/setup-data-project 1.0.39 → 2.0.1

package/script/main.js

@@ -10,7 +10,7 @@ const getRuntime_js_1 = require("./helpers/getRuntime.js");
 const packageOptions_js_1 = require("./helpers/packageOptions.js");
 const ensureGitignore_js_1 = require("./helpers/ensureGitignore.js");
 const ensureReadme_js_1 = require("./helpers/ensureReadme.js");
-const installPackagesAndFetchDocs_js_1 = require("./helpers/installPackagesAndFetchDocs.js");
+const installPackages_js_1 = require("./helpers/installPackages.js");
 const getProjectTasks_js_1 = require("./helpers/getProjectTasks.js");
 const createFolderStructure_js_1 = require("./helpers/createFolderStructure.js");
 const ensureEnvFile_js_1 = require("./helpers/ensureEnvFile.js");
@@ -18,6 +18,7 @@ const ensureAgents_js_1 = require("./helpers/ensureAgents.js");
 const packageRegistry_js_1 = require("./helpers/packageRegistry.js");
 const projectManifest_js_1 = require("./helpers/projectManifest.js");
 const syncPackageDocs_js_1 = require("./helpers/syncPackageDocs.js");
+const getInstalledPackageVersions_js_1 = require("./helpers/getInstalledPackageVersions.js");
 async function main() {
     const runtime = (0, getRuntime_js_1.getRuntime)();
     console.log();
@@ -64,10 +65,10 @@ async function main() {
         }
     }
     const sInstall = (0, prompts_1.spinner)();
-    sInstall.start("Installing packages and fetching documentation...");
+    sInstall.start("Installing packages...");
     for (const pkg of packagesToInstall) {
         try {
-            await (0, installPackagesAndFetchDocs_js_1.installPackagesAndFetchDocs)([pkg], { silent: true });
+            await (0, installPackages_js_1.installPackages)([pkg], { silent: true });
         }
         catch (error) {
             sInstall.stop(`❌ Failed to install ${pkg}.`);
@@ -75,11 +76,15 @@ async function main() {
             node_process_1.default.exit(1);
         }
     }
-    sInstall.stop("✅ Packages installed and documentation fetched.");
+    sInstall.stop("✅ Package installation complete.");
     projectManifest.reload();
     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);
+    const finalInstalledVersions = (0, getInstalledPackageVersions_js_1.getInstalledPackageVersions)(projectManifest.getInstalledPackageSpecifiers());
+    const sDocs = (0, prompts_1.spinner)();
+    sDocs.start("Fetching documentation for installed package versions...");
+    const docsMapping = await (0, syncPackageDocs_js_1.syncPackageDocs)(finalInstalledPackages, finalInstalledVersions);
+    sDocs.stop("✅ Documentation synchronization complete.");
     (0, createFolderStructure_js_1.createFolderStructure)(finalInstalledPackages);
     (0, ensureGitignore_js_1.ensureGitignore)();
     (0, ensureEnvFile_js_1.ensureEnvFile)();

package/esm/helpers/installPackagesAndFetchDocs.d.ts

@@ -1,10 +0,0 @@
-export declare const commandRunner: {
-    exec: any;
-};
-export declare function fetchPackageDocs(pkg: string, options?: {
-    silent?: boolean;
-}): Promise<string | undefined>;
-export declare function installPackagesAndFetchDocs(selectedPackages: string[], options?: {
-    silent?: boolean;
-}): Promise<string | void>;
-//# sourceMappingURL=installPackagesAndFetchDocs.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"installPackagesAndFetchDocs.d.ts","sourceRoot":"","sources":["../../src/helpers/installPackagesAndFetchDocs.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa;;CAEzB,CAAC;AAEF,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA4C7B;AAED,wBAAsB,2BAA2B,CAC/C,gBAAgB,EAAE,MAAM,EAAE,EAC1B,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA4DxB"}

package/esm/helpers/installPackagesAndFetchDocs.js

@@ -1,100 +0,0 @@
-import { log, spinner } from "@clack/prompts";
-import * as childProcess from "node:child_process";
-import { existsSync, mkdirSync, writeFileSync } from "node:fs";
-import { join } from "node:path";
-import { getRuntime } from "./getRuntime.js";
-export const commandRunner = {
-    exec: childProcess.exec,
-};
-export async function fetchPackageDocs(pkg, options = {}) {
-    if (!existsSync("docs")) {
-        mkdirSync("docs");
-    }
-    const sFetch = spinner();
-    if (!options.silent) {
-        sFetch.start("Fetching documentation for " + pkg + "...");
-    }
-    try {
-        const repoName = pkg.split("/")[1];
-        const url = "https://raw.githubusercontent.com/nshiab/" + repoName +
-            "/refs/heads/main/llm.md";
-        const response = await fetch(url);
-        if (!response.ok) {
-            if (!options.silent) {
-                sFetch.stop("⚠️  No documentation (llm.md) found for " + pkg + ".");
-            }
-            log.warn(`Documentation for ${pkg} could not be refreshed. Rerun the script ` +
-                "later to try again.");
-            return undefined;
-        }
-        const docContent = await response.text();
-        writeFileSync(join("docs", repoName + ".md"), docContent);
-        if (!options.silent) {
-            sFetch.stop("✅ Documentation for " + pkg + " saved!");
-        }
-        return docContent;
-    }
-    catch (error) {
-        if (!options.silent) {
-            sFetch.stop("❌ Failed to fetch documentation for " + pkg + ".");
-        }
-        log.warn(`Documentation for ${pkg} could not be refreshed. Rerun the script ` +
-            "later to try again.");
-        console.error(error);
-        return undefined;
-    }
-}
-export async function installPackagesAndFetchDocs(selectedPackages, options = {}) {
-    const runtime = getRuntime();
-    if (Array.isArray(selectedPackages) && selectedPackages.length > 0) {
-        if (!existsSync("docs")) {
-            mkdirSync("docs");
-        }
-        let lastDoc = "";
-        for (const pkg of selectedPackages) {
-            const s = spinner();
-            const pkgsToInstall = [pkg];
-            if (pkg === "@nshiab/simple-data-analysis" ||
-                pkg === "@nshiab/journalism-dataviz") {
-                pkgsToInstall.push("@observablehq/plot");
-            }
-            for (const p of pkgsToInstall) {
-                const isObservablePlot = p === "@observablehq/plot";
-                const installCmd = runtime === "deno"
-                    ? (isObservablePlot ? "deno add npm:" + p : "deno add jsr:" + p)
-                    : runtime === "bun"
-                        ? "bun add " + p
-                        : "npm install " + p;
-                if (!options.silent) {
-                    s.start("Installing " + p + " via " + runtime + "...");
-                }
-                try {
-                    await new Promise((resolve, reject) => {
-                        commandRunner.exec(installCmd, (error) => {
-                            if (error) {
-                                reject(error);
-                            }
-                            else {
-                                resolve(void 0);
-                            }
-                        });
-                    });
-                    if (!options.silent) {
-                        s.stop("✅ " + p + " installed!");
-                    }
-                }
-                catch (error) {
-                    if (!options.silent) {
-                        s.stop("❌ Failed to install " + p + ".");
-                    }
-                    throw error;
-                }
-            }
-            const docContent = await fetchPackageDocs(pkg, options);
-            if (docContent !== undefined) {
-                lastDoc = docContent;
-            }
-        }
-        return lastDoc;
-    }
-}

package/script/helpers/installPackagesAndFetchDocs.d.ts

@@ -1,10 +0,0 @@
-export declare const commandRunner: {
-    exec: any;
-};
-export declare function fetchPackageDocs(pkg: string, options?: {
-    silent?: boolean;
-}): Promise<string | undefined>;
-export declare function installPackagesAndFetchDocs(selectedPackages: string[], options?: {
-    silent?: boolean;
-}): Promise<string | void>;
-//# sourceMappingURL=installPackagesAndFetchDocs.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"installPackagesAndFetchDocs.d.ts","sourceRoot":"","sources":["../../src/helpers/installPackagesAndFetchDocs.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa;;CAEzB,CAAC;AAEF,wBAAsB,gBAAgB,CACpC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CA4C7B;AAED,wBAAsB,2BAA2B,CAC/C,gBAAgB,EAAE,MAAM,EAAE,EAC1B,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA4DxB"}

package/script/helpers/installPackagesAndFetchDocs.js

@@ -1,138 +0,0 @@
-"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.commandRunner = void 0;
-exports.fetchPackageDocs = fetchPackageDocs;
-exports.installPackagesAndFetchDocs = installPackagesAndFetchDocs;
-const prompts_1 = require("@clack/prompts");
-const childProcess = __importStar(require("node:child_process"));
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const getRuntime_js_1 = require("./getRuntime.js");
-exports.commandRunner = {
-    exec: childProcess.exec,
-};
-async function fetchPackageDocs(pkg, options = {}) {
-    if (!(0, node_fs_1.existsSync)("docs")) {
-        (0, node_fs_1.mkdirSync)("docs");
-    }
-    const sFetch = (0, prompts_1.spinner)();
-    if (!options.silent) {
-        sFetch.start("Fetching documentation for " + pkg + "...");
-    }
-    try {
-        const repoName = pkg.split("/")[1];
-        const url = "https://raw.githubusercontent.com/nshiab/" + repoName +
-            "/refs/heads/main/llm.md";
-        const response = await fetch(url);
-        if (!response.ok) {
-            if (!options.silent) {
-                sFetch.stop("⚠️  No documentation (llm.md) found for " + pkg + ".");
-            }
-            prompts_1.log.warn(`Documentation for ${pkg} could not be refreshed. Rerun the script ` +
-                "later to try again.");
-            return undefined;
-        }
-        const docContent = await response.text();
-        (0, node_fs_1.writeFileSync)((0, node_path_1.join)("docs", repoName + ".md"), docContent);
-        if (!options.silent) {
-            sFetch.stop("✅ Documentation for " + pkg + " saved!");
-        }
-        return docContent;
-    }
-    catch (error) {
-        if (!options.silent) {
-            sFetch.stop("❌ Failed to fetch documentation for " + pkg + ".");
-        }
-        prompts_1.log.warn(`Documentation for ${pkg} could not be refreshed. Rerun the script ` +
-            "later to try again.");
-        console.error(error);
-        return undefined;
-    }
-}
-async function installPackagesAndFetchDocs(selectedPackages, options = {}) {
-    const runtime = (0, getRuntime_js_1.getRuntime)();
-    if (Array.isArray(selectedPackages) && selectedPackages.length > 0) {
-        if (!(0, node_fs_1.existsSync)("docs")) {
-            (0, node_fs_1.mkdirSync)("docs");
-        }
-        let lastDoc = "";
-        for (const pkg of selectedPackages) {
-            const s = (0, prompts_1.spinner)();
-            const pkgsToInstall = [pkg];
-            if (pkg === "@nshiab/simple-data-analysis" ||
-                pkg === "@nshiab/journalism-dataviz") {
-                pkgsToInstall.push("@observablehq/plot");
-            }
-            for (const p of pkgsToInstall) {
-                const isObservablePlot = p === "@observablehq/plot";
-                const installCmd = runtime === "deno"
-                    ? (isObservablePlot ? "deno add npm:" + p : "deno add jsr:" + p)
-                    : runtime === "bun"
-                        ? "bun add " + p
-                        : "npm install " + p;
-                if (!options.silent) {
-                    s.start("Installing " + p + " via " + runtime + "...");
-                }
-                try {
-                    await new Promise((resolve, reject) => {
-                        exports.commandRunner.exec(installCmd, (error) => {
-                            if (error) {
-                                reject(error);
-                            }
-                            else {
-                                resolve(void 0);
-                            }
-                        });
-                    });
-                    if (!options.silent) {
-                        s.stop("✅ " + p + " installed!");
-                    }
-                }
-                catch (error) {
-                    if (!options.silent) {
-                        s.stop("❌ Failed to install " + p + ".");
-                    }
-                    throw error;
-                }
-            }
-            const docContent = await fetchPackageDocs(pkg, options);
-            if (docContent !== undefined) {
-                lastDoc = docContent;
-            }
-        }
-        return lastDoc;
-    }
-}