@nshiab/setup-data-project 2.0.0 → 2.0.1

package/script/helpers/fetchPackageDocs.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchPackageDocs = fetchPackageDocs;
+const prompts_1 = require("@clack/prompts");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const PACKAGE_DOCUMENTS = [
+    {
+        remoteName: "README.md",
+        localName: "README.md",
+        key: "readme",
+        label: "README",
+    },
+    {
+        remoteName: "llm.md",
+        localName: "llm.md",
+        key: "llm",
+        label: "API documentation",
+    },
+];
+async function fetchPackageDocs(pkg, version, options = {}) {
+    const repoName = pkg.split("/")[1];
+    const docsDirectory = (0, node_path_1.join)("docs", repoName);
+    (0, node_fs_1.mkdirSync)(docsDirectory, { recursive: true });
+    const sFetch = (0, prompts_1.spinner)();
+    if (!options.silent) {
+        sFetch.start(`Fetching documentation for ${pkg}@${version}...`);
+    }
+    const fetchedDocuments = await Promise.all(PACKAGE_DOCUMENTS.map(async (document) => {
+        const localPath = (0, node_path_1.join)(docsDirectory, document.localName);
+        try {
+            const url = "https://raw.githubusercontent.com/nshiab/" + repoName +
+                `/refs/tags/v${version}/${document.remoteName}`;
+            const response = await fetch(url);
+            if (!response.ok) {
+                warnAboutFailedFetch(pkg, version, document.label, localPath);
+                return { key: document.key, content: undefined };
+            }
+            const content = await response.text();
+            (0, node_fs_1.writeFileSync)(localPath, content);
+            return { key: document.key, content };
+        }
+        catch (error) {
+            warnAboutFailedFetch(pkg, version, document.label, localPath);
+            console.error(error);
+            return { key: document.key, content: undefined };
+        }
+    }));
+    const docs = {};
+    for (const document of fetchedDocuments) {
+        if (document.content !== undefined) {
+            docs[document.key] = document.content;
+        }
+    }
+    const savedCount = fetchedDocuments.filter((document) => document.content !== undefined)
+        .length;
+    if (!options.silent) {
+        if (savedCount === PACKAGE_DOCUMENTS.length) {
+            sFetch.stop(`✅ Documentation for ${pkg}@${version} saved!`);
+        }
+        else if (savedCount > 0) {
+            sFetch.stop(`⚠️  Some documentation for ${pkg}@${version} could not be fetched.`);
+        }
+        else {
+            sFetch.stop(`❌ Failed to fetch documentation for ${pkg}@${version}.`);
+        }
+    }
+    return docs;
+}
+function warnAboutFailedFetch(pkg, version, label, localPath) {
+    const existingFileGuidance = (0, node_fs_1.existsSync)(localPath)
+        ? ` The existing file at ${localPath} was preserved, but it may not ` +
+            "match the installed version. Double-check it before relying on it, or " +
+            "remove it."
+        : "";
+    prompts_1.log.warn(`Could not fetch ${label} for ${pkg}@${version} from its GitHub tag.` +
+        existingFileGuidance);
+}

package/script/helpers/getInstalledPackageVersions.d.ts

@@ -0,0 +1,2 @@
+export declare function getInstalledPackageVersions(packageSpecifiers: Record<string, string>): Record<string, string>;
+//# sourceMappingURL=getInstalledPackageVersions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getInstalledPackageVersions.d.ts","sourceRoot":"","sources":["../../src/helpers/getInstalledPackageVersions.ts"],"names":[],"mappings":"AAKA,wBAAgB,2BAA2B,CACzC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACxC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAuBxB"}

package/script/helpers/getInstalledPackageVersions.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInstalledPackageVersions = getInstalledPackageVersions;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+function getInstalledPackageVersions(packageSpecifiers) {
+    const denoLock = readJsonFile("deno.lock");
+    const packageLock = readJsonFile("package-lock.json");
+    const bunLock = (0, node_fs_1.existsSync)("bun.lock")
+        ? (0, node_fs_1.readFileSync)("bun.lock", "utf-8")
+        : undefined;
+    const versions = {};
+    for (const [pkg, specifier] of Object.entries(packageSpecifiers)) {
+        const version = specifier.startsWith("jsr:")
+            ? getDenoLockVersion(pkg, specifier, denoLock) ??
+                getExactVersion(specifier)
+            : getNodeModulesVersion(pkg) ??
+                getPackageLockVersion(pkg, packageLock) ??
+                getBunLockVersion(pkg, bunLock) ??
+                getExactVersion(specifier);
+        if (version !== undefined) {
+            versions[pkg] = version;
+        }
+    }
+    return versions;
+}
+function getNodeModulesVersion(pkg) {
+    const packageJson = readJsonFile((0, node_path_1.join)("node_modules", ...pkg.split("/"), "package.json"));
+    return typeof packageJson?.version === "string"
+        ? getExactVersion(packageJson.version)
+        : undefined;
+}
+function getDenoLockVersion(pkg, specifier, lock) {
+    if (!lock || !specifier.startsWith("jsr:"))
+        return undefined;
+    const specifiers = asObject(lock.specifiers);
+    if (!specifiers)
+        return undefined;
+    const directVersion = specifiers[specifier];
+    if (typeof directVersion === "string")
+        return getExactVersion(directVersion);
+    const prefix = `jsr:${pkg}@`;
+    const matchingVersions = Object.entries(specifiers)
+        .filter(([key, value]) => key.startsWith(prefix) && typeof value === "string")
+        .flatMap(([, value]) => {
+        const version = getExactVersion(value);
+        return version === undefined ? [] : [version];
+    });
+    const uniqueVersions = [...new Set(matchingVersions)];
+    return uniqueVersions.length === 1 ? uniqueVersions[0] : undefined;
+}
+function getPackageLockVersion(pkg, lock) {
+    if (!lock)
+        return undefined;
+    const packages = asObject(lock.packages);
+    const packageEntry = packages
+        ? asObject(packages[`node_modules/${pkg}`])
+        : undefined;
+    if (typeof packageEntry?.version === "string") {
+        return getExactVersion(packageEntry.version);
+    }
+    const dependencies = asObject(lock.dependencies);
+    const dependencyEntry = dependencies
+        ? asObject(dependencies[pkg])
+        : undefined;
+    return typeof dependencyEntry?.version === "string"
+        ? getExactVersion(dependencyEntry.version)
+        : undefined;
+}
+function getBunLockVersion(pkg, lock) {
+    if (!lock)
+        return undefined;
+    const escapedPackage = pkg.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    const match = lock.match(new RegExp(`"${escapedPackage}"\\s*:\\s*\\[\\s*"${escapedPackage}@(\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?)"`));
+    return match?.[1];
+}
+function getExactVersion(specifier) {
+    return specifier.match(/(?:^|@)(\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?)$/)?.[1];
+}
+function readJsonFile(path) {
+    if (!(0, node_fs_1.existsSync)(path))
+        return undefined;
+    try {
+        return asObject(JSON.parse((0, node_fs_1.readFileSync)(path, "utf-8")));
+    }
+    catch {
+        return undefined;
+    }
+}
+function asObject(value) {
+    return value !== null && typeof value === "object" && !Array.isArray(value)
+        ? value
+        : undefined;
+}

package/script/helpers/installPackages.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"installPackages.d.ts","sourceRoot":"","sources":["../../src/helpers/installPackages.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa;;CAEzB,CAAC;AASF,wBAAsB,eAAe,CACnC,gBAAgB,EAAE,MAAM,EAAE,EAC1B,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,OAAO,CAAC,IAAI,CAAC,CAmDf"}

package/script/helpers/installPackages.js

@@ -0,0 +1,96 @@
+"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.installPackages = installPackages;
+const prompts_1 = require("@clack/prompts");
+const childProcess = __importStar(require("node:child_process"));
+const getRuntime_js_1 = require("./getRuntime.js");
+exports.commandRunner = {
+    exec: childProcess.exec,
+};
+// Temporary: remove this bypass after the 2.0 release window.
+// https://github.com/nshiab/setup-data-project/issues/15
+const PACKAGES_WITH_FRESH_DENO_RELEASES = new Set([
+    "@nshiab/simple-data-analysis-core",
+    "@nshiab/simple-data-analysis",
+]);
+async function installPackages(selectedPackages, options = {}) {
+    const runtime = (0, getRuntime_js_1.getRuntime)();
+    for (const selectedPackage of selectedPackages) {
+        const packagesToInstall = [selectedPackage];
+        if (selectedPackage === "@nshiab/simple-data-analysis" ||
+            selectedPackage === "@nshiab/journalism-dataviz") {
+            packagesToInstall.push("@observablehq/plot");
+        }
+        for (const pkg of packagesToInstall) {
+            const s = (0, prompts_1.spinner)();
+            const isObservablePlot = pkg === "@observablehq/plot";
+            const minimumDependencyAgeOption = PACKAGES_WITH_FRESH_DENO_RELEASES.has(pkg) ? " --min-dep-age=0" : "";
+            const installCmd = runtime === "deno"
+                ? (isObservablePlot
+                    ? "deno add npm:" + pkg
+                    : "deno add" + minimumDependencyAgeOption + " jsr:" +
+                        pkg)
+                : runtime === "bun"
+                    ? "bun add " + pkg
+                    : "npm install " + pkg;
+            if (!options.silent) {
+                s.start("Installing " + pkg + " via " + runtime + "...");
+            }
+            try {
+                await new Promise((resolve, reject) => {
+                    exports.commandRunner.exec(installCmd, (error) => {
+                        if (error) {
+                            reject(error);
+                        }
+                        else {
+                            resolve();
+                        }
+                    });
+                });
+                if (!options.silent) {
+                    s.stop("✅ " + pkg + " installed!");
+                }
+            }
+            catch (error) {
+                if (!options.silent) {
+                    s.stop("❌ Failed to install " + pkg + ".");
+                }
+                throw error;
+            }
+        }
+    }
+}

package/script/helpers/projectManifest.d.ts

@@ -5,6 +5,7 @@ export declare class ProjectManifest {
     static open(runtime: Runtime): ProjectManifest;
     reload(): void;
     getInstalledPackages(): string[];
+    getInstalledPackageSpecifiers(): Record<string, string>;
     updateTasks(tasks: Record<string, string>): void;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"projectManifest.d.ts","sourceRoot":"","sources":["../../src/helpers/projectManifest.ts"],"names":[],"mappings":"AAEA,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAGvC,qBAAa,eAAe;;IAM1B,OAAO;IAYP,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IA6B9C,MAAM,IAAI,IAAI;IAId,oBAAoB,IAAI,MAAM,EAAE;IAgBhC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;CAcjD"}
+{"version":3,"file":"projectManifest.d.ts","sourceRoot":"","sources":["../../src/helpers/projectManifest.ts"],"names":[],"mappings":"AAEA,KAAK,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAGvC,qBAAa,eAAe;;IAM1B,OAAO;IAYP,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe;IA6B9C,MAAM,IAAI,IAAI;IAId,oBAAoB,IAAI,MAAM,EAAE;IAIhC,6BAA6B,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAoBvD,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;CAcjD"}

package/script/helpers/projectManifest.js

@@ -40,12 +40,19 @@ class ProjectManifest {
         __classPrivateFieldSet(this, _ProjectManifest_config, readManifest(__classPrivateFieldGet(this, _ProjectManifest_path, "f")), "f");
     }
     getInstalledPackages() {
-        const installed = [];
+        return Object.keys(this.getInstalledPackageSpecifiers());
+    }
+    getInstalledPackageSpecifiers() {
+        const installed = {};
         for (const key of __classPrivateFieldGet(this, _ProjectManifest_dependencyKeys, "f")) {
             const dependencies = __classPrivateFieldGet(this, _ProjectManifest_config, "f")[key];
             if (dependencies && typeof dependencies === "object" &&
                 !Array.isArray(dependencies)) {
-                installed.push(...Object.keys(dependencies));
+                for (const [name, specifier] of Object.entries(dependencies)) {
+                    if (typeof specifier === "string") {
+                        installed[name] = specifier;
+                    }
+                }
             }
         }
         return installed;

package/script/helpers/syncPackageDocs.d.ts

@@ -1,2 +1,3 @@
-export declare function syncPackageDocs(installedPackages: string[], docsAlreadyRefreshed?: string[]): Promise<Record<string, string>>;
+import { type PackageDocs } from "./fetchPackageDocs.js";
+export declare function syncPackageDocs(installedPackages: string[], installedVersions: Record<string, string>): Promise<Record<string, PackageDocs>>;
 //# sourceMappingURL=syncPackageDocs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"syncPackageDocs.d.ts","sourceRoot":"","sources":["../../src/helpers/syncPackageDocs.ts"],"names":[],"mappings":"AAMA,wBAAsB,eAAe,CACnC,iBAAiB,EAAE,MAAM,EAAE,EAC3B,oBAAoB,GAAE,MAAM,EAAO,GAClC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CA0BjC"}
+{"version":3,"file":"syncPackageDocs.d.ts","sourceRoot":"","sources":["../../src/helpers/syncPackageDocs.ts"],"names":[],"mappings":"AAGA,OAAO,EAAoB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAG3E,wBAAsB,eAAe,CACnC,iBAAiB,EAAE,MAAM,EAAE,EAC3B,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACxC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CA+CtC"}

package/script/helpers/syncPackageDocs.js

@@ -4,26 +4,45 @@ exports.syncPackageDocs = syncPackageDocs;
 const prompts_1 = require("@clack/prompts");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
-const installPackagesAndFetchDocs_js_1 = require("./installPackagesAndFetchDocs.js");
+const fetchPackageDocs_js_1 = require("./fetchPackageDocs.js");
 const packageRegistry_js_1 = require("./packageRegistry.js");
-async function syncPackageDocs(installedPackages, docsAlreadyRefreshed = []) {
+async function syncPackageDocs(installedPackages, installedVersions) {
     const installedSet = new Set(installedPackages);
-    const refreshedSet = new Set(docsAlreadyRefreshed);
     const docsMapping = {};
     for (const pkg of packageRegistry_js_1.SUPPORTED_PACKAGES) {
-        const docPath = (0, node_path_1.join)("docs", pkg.value.split("/")[1] + ".md");
+        const repoName = pkg.value.split("/")[1];
+        const docsDirectory = (0, node_path_1.join)("docs", repoName);
+        const llmDocsPath = (0, node_path_1.join)(docsDirectory, "llm.md");
+        const legacyDocsPath = (0, node_path_1.join)("docs", repoName + ".md");
         if (!installedSet.has(pkg.value)) {
-            if ((0, node_fs_1.existsSync)(docPath)) {
-                (0, node_fs_1.rmSync)(docPath);
-                prompts_1.log.info(`Removed stale documentation at ${docPath}.`);
+            for (const path of [docsDirectory, legacyDocsPath]) {
+                if ((0, node_fs_1.existsSync)(path)) {
+                    (0, node_fs_1.rmSync)(path, { recursive: true });
+                    prompts_1.log.info(`Removed stale documentation at ${path}.`);
+                }
             }
             continue;
         }
-        if (!(0, node_fs_1.existsSync)(docPath) && !refreshedSet.has(pkg.value)) {
-            await (0, installPackagesAndFetchDocs_js_1.fetchPackageDocs)(pkg.value, { silent: true });
+        if ((0, node_fs_1.existsSync)(legacyDocsPath)) {
+            if (!(0, node_fs_1.existsSync)(llmDocsPath)) {
+                (0, node_fs_1.mkdirSync)(docsDirectory, { recursive: true });
+                (0, node_fs_1.renameSync)(legacyDocsPath, llmDocsPath);
+                prompts_1.log.info(`Moved documentation to ${llmDocsPath}.`);
+            }
+            else {
+                (0, node_fs_1.rmSync)(legacyDocsPath);
+            }
+        }
+        const version = installedVersions[pkg.value];
+        if (version === undefined) {
+            prompts_1.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;
         }
-        if ((0, node_fs_1.existsSync)(docPath)) {
-            docsMapping[pkg.value] = (0, node_fs_1.readFileSync)(docPath, "utf-8");
+        const docs = await (0, fetchPackageDocs_js_1.fetchPackageDocs)(pkg.value, version, { silent: true });
+        if (docs.readme !== undefined || docs.llm !== undefined) {
+            docsMapping[pkg.value] = docs;
         }
     }
     return docsMapping;

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;AASF,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,CAgExB"}

package/esm/helpers/installPackagesAndFetchDocs.js

@@ -1,109 +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,
-};
-// Temporary: remove this bypass after the 2.0 release window.
-// https://github.com/nshiab/setup-data-project/issues/15
-const PACKAGES_WITH_FRESH_DENO_RELEASES = new Set([
-    "@nshiab/simple-data-analysis-core",
-    "@nshiab/simple-data-analysis",
-]);
-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 minimumDependencyAgeOption = PACKAGES_WITH_FRESH_DENO_RELEASES.has(p) ? " --min-dep-age=0" : "";
-                const installCmd = runtime === "deno"
-                    ? (isObservablePlot
-                        ? "deno add npm:" + p
-                        : "deno add" + minimumDependencyAgeOption + " 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;AASF,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,CAgExB"}