@nshiab/setup-data-project 1.0.7

package/script/helpers/installPackagesAndFetchDocs.js

@@ -0,0 +1,98 @@
+"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.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 = {
+    execSync: childProcess.execSync,
+};
+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 installCmd = runtime === "deno"
+                ? `deno add jsr:${pkg}`
+                : runtime === "bun"
+                    ? `bunx jsr add ${pkg}`
+                    : `npx jsr add ${pkg}`;
+            if (!options.silent) {
+                s.start(`Installing ${pkg} via ${runtime}...`);
+            }
+            try {
+                exports.commandRunner.execSync(installCmd, { stdio: "ignore" });
+                if (!options.silent) {
+                    s.stop(`✅ ${pkg} installed!`);
+                }
+                const sFetch = (0, prompts_1.spinner)();
+                if (!options.silent) {
+                    sFetch.start(`Fetching documentation for ${pkg}...`);
+                }
+                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) {
+                    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!`);
+                    }
+                    lastDoc = docContent;
+                }
+                else {
+                    if (!options.silent) {
+                        sFetch.stop(`⚠️  No documentation (llm.md) found for ${pkg}. Skipping doc fetch.`);
+                    }
+                }
+            }
+            catch (error) {
+                if (!options.silent) {
+                    s.stop(`❌ Failed to install ${pkg}.`);
+                }
+                throw error;
+            }
+        }
+        return lastDoc;
+    }
+}

package/script/helpers/packageOptions.d.ts

@@ -0,0 +1,5 @@
+export declare const PACKAGE_OPTIONS: {
+    value: string;
+    label: string;
+}[];
+//# sourceMappingURL=packageOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"packageOptions.d.ts","sourceRoot":"","sources":["../../src/helpers/packageOptions.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;;GAGzB,CAAC"}

package/script/helpers/packageOptions.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PACKAGE_OPTIONS = void 0;
+const packageRegistry_js_1 = require("./packageRegistry.js");
+exports.PACKAGE_OPTIONS = packageRegistry_js_1.SUPPORTED_PACKAGES.map((pkg) => ({
+    value: pkg.value,
+    label: pkg.label,
+}));

package/script/helpers/packageRegistry.d.ts

@@ -0,0 +1,7 @@
+export interface PackageConfig {
+    value: string;
+    label: string;
+    type: "sda" | "journalism" | "other";
+}
+export declare const SUPPORTED_PACKAGES: PackageConfig[];
+//# sourceMappingURL=packageRegistry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"packageRegistry.d.ts","sourceRoot":"","sources":["../../src/helpers/packageRegistry.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,KAAK,GAAG,YAAY,GAAG,OAAO,CAAC;CACtC;AAED,eAAO,MAAM,kBAAkB,EAAE,aAAa,EA6D7C,CAAC"}

package/script/helpers/packageRegistry.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORTED_PACKAGES = void 0;
+exports.SUPPORTED_PACKAGES = [
+    {
+        value: "@nshiab/simple-data-analysis",
+        label: "simple-data-analysis",
+        type: "sda",
+    },
+    {
+        value: "@nshiab/journalism-ai",
+        label: "journalism-ai",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-climate",
+        label: "journalism-climate",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-dataviz",
+        label: "journalism-dataviz",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-finance",
+        label: "journalism-finance",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-format",
+        label: "journalism-format",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-geo",
+        label: "journalism-geo",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-google",
+        label: "journalism-google",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-statistics",
+        label: "journalism-statistics",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-web",
+        label: "journalism-web",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-web-scraping",
+        label: "journalism-web-scraping",
+        type: "journalism",
+    },
+    {
+        value: "@nshiab/journalism-extras",
+        label: "journalism-extras",
+        type: "journalism",
+    },
+];

package/script/helpers/updateProjectConfig.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"updateProjectConfig.d.ts","sourceRoot":"","sources":["../../src/helpers/updateProjectConfig.ts"],"names":[],"mappings":"AAGA,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,QAkChE"}

package/script/helpers/updateProjectConfig.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateProjectConfig = updateProjectConfig;
+const node_fs_1 = require("node:fs");
+const getRuntime_js_1 = require("./getRuntime.js");
+function updateProjectConfig(tasks) {
+    const runtime = (0, getRuntime_js_1.getRuntime)();
+    let configFile = "package.json";
+    let key = "scripts";
+    if ((0, node_fs_1.existsSync)("deno.json")) {
+        configFile = "deno.json";
+        key = "tasks";
+    }
+    else if (!(0, node_fs_1.existsSync)("package.json") && runtime === "deno") {
+        configFile = "deno.json";
+        key = "tasks";
+        (0, node_fs_1.writeFileSync)(configFile, JSON.stringify({ [key]: {} }, null, 2));
+    }
+    else if (!(0, node_fs_1.existsSync)("package.json")) {
+        return;
+    }
+    try {
+        const content = (0, node_fs_1.readFileSync)(configFile, "utf-8");
+        const config = JSON.parse(content);
+        config[key] = { ...(config[key] || {}), ...tasks };
+        (0, node_fs_1.writeFileSync)(configFile, JSON.stringify(config, null, 2), "utf-8");
+    }
+    catch (e) {
+        if (e instanceof SyntaxError) {
+            console.error(`❌ Error: Failed to parse ${configFile} as JSON. Please check its validity.`);
+        }
+        else if (e instanceof Error) {
+            console.error(`❌ Error: Could not update ${configFile}: ${e.message}`);
+        }
+        else {
+            console.error(`❌ Error: An unexpected error occurred while updating ${configFile}.`);
+        }
+    }
+}

package/script/main.d.ts

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

package/script/main.d.ts.map

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

package/script/main.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const prompts_1 = require("@clack/prompts");
+const node_process_1 = __importDefault(require("node:process"));
+const getRuntime_js_1 = require("./helpers/getRuntime.js");
+const getInstalledPackages_js_1 = require("./helpers/getInstalledPackages.js");
+const packageOptions_js_1 = require("./helpers/packageOptions.js");
+const updateProjectConfig_js_1 = require("./helpers/updateProjectConfig.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 getProjectTasks_js_1 = require("./helpers/getProjectTasks.js");
+const createFolderStructure_js_1 = require("./helpers/createFolderStructure.js");
+const ensureEnvFile_js_1 = require("./helpers/ensureEnvFile.js");
+const ensureAgents_js_1 = require("./helpers/ensureAgents.js");
+async function main() {
+    const runtime = (0, getRuntime_js_1.getRuntime)();
+    console.log();
+    (0, prompts_1.intro)(`Hi! 👋 (Running on ${runtime})`);
+    const installedPackages = (0, getInstalledPackages_js_1.getInstalledPackages)();
+    const options = packageOptions_js_1.PACKAGE_OPTIONS.map((opt) => ({
+        ...opt,
+        label: installedPackages.includes(opt.value)
+            ? `${opt.label} \x1b[2m(installed)\x1b[22m`
+            : opt.label,
+    }));
+    const selectedPackages = (await (0, prompts_1.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 ((0, prompts_1.isCancel)(selectedPackages)) {
+        (0, prompts_1.cancel)("Installation cancelled.");
+        node_process_1.default.exit(0);
+    }
+    const alreadyInstalled = selectedPackages.filter((pkg) => installedPackages.includes(pkg));
+    const packagesToInstall = [];
+    for (const pkg of selectedPackages) {
+        if (alreadyInstalled.includes(pkg)) {
+            const action = await (0, prompts_1.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 ((0, prompts_1.isCancel)(action)) {
+                (0, prompts_1.cancel)("Installation cancelled.");
+                node_process_1.default.exit(0);
+            }
+            if (action === "update") {
+                packagesToInstall.push(pkg);
+            }
+        }
+        else {
+            packagesToInstall.push(pkg);
+        }
+    }
+    const docsMapping = {};
+    const sInstall = (0, prompts_1.spinner)();
+    sInstall.start("Installing packages and fetching documentation...");
+    for (const pkg of packagesToInstall) {
+        try {
+            const doc = await (0, installPackagesAndFetchDocs_js_1.installPackagesAndFetchDocs)([pkg]);
+            if (typeof doc === "string") {
+                docsMapping[pkg] = doc;
+            }
+        }
+        catch (error) {
+            sInstall.stop(`❌ Failed to install ${pkg}.`);
+            console.error(error);
+            node_process_1.default.exit(1);
+        }
+    }
+    sInstall.stop("✅ Packages installed and documentation fetched.");
+    const s = (0, prompts_1.spinner)();
+    s.start("Creating folder structure...");
+    try {
+        const sdaFolder = await (0, createFolderStructure_js_1.createFolderStructure)(packagesToInstall);
+        (0, ensureGitignore_js_1.ensureGitignore)();
+        await (0, ensureEnvFile_js_1.ensureEnvFile)();
+        (0, updateProjectConfig_js_1.updateProjectConfig)((0, getProjectTasks_js_1.getProjectTasks)());
+        await (0, ensureReadme_js_1.ensureReadme)(runtime);
+        await (0, ensureAgents_js_1.ensureAgents)(docsMapping, runtime);
+        s.stop(`✅ Folder structure created in ${sdaFolder}/`);
+    }
+    catch (error) {
+        s.stop("❌ Failed to create folder structure.");
+        console.error(error);
+        node_process_1.default.exit(1);
+    }
+    (0, prompts_1.outro)("You are all set! 🙌");
+}
+main().catch(console.error);

package/script/package.json

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