flowershow 0.1.9 → 0.1.10

package/{src → dist}/lib/Installer.js

@@ -10,7 +10,7 @@ import { exit, error, log, info, success, logWithSpinner, stopSpinner, isSubdir,
 import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
 export default class Installer {
     constructor(context, targetDir) {
-        this.templateRepo = "https://github.com/datopian/flowershow-template";
+        this.templateRepo = "https://github.com/datopian/flowershow";
         this.context = context;
         this.targetDir = targetDir;
     }

package/dist/src/bin/cli.js

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+import { warn, exit, sendEvent } from "../lib/utils/index.js";
+import { Command } from "commander";
+// TODO check current vs required node version (package.json engines)
+// const requiredNodeVersion = require("../package.json").engines.node;
+const { version: cli } = require("../../package.json");
+// simplify importing data from package.json with this line after we no longer want to support node 16
+// import packageJson from "#package.json" assert { type: "json" };
+const { version: node, platform, argv } = process;
+if (platform === "win32") {
+    warn("This may not work as expected. You're trying to run Flowershow CLI on Windows, which is not thoroughly tested. Please submit an issue if you encounter any problems: https://github.com/flowershow/flowershow/issues");
+}
+const [, , cmd, ...args] = argv;
+sendEvent({
+    event: "cli-usage",
+    action: cmd,
+    meta: {
+        args,
+        cli,
+        node,
+        platform,
+    },
+});
+process.on("uncaughtException", () => {
+    sendEvent({
+        event: "cli-error",
+        action: cmd,
+        meta: {
+            args,
+            cli,
+            node,
+            platform,
+        },
+    });
+    exit(1);
+});
+// CLI commands
+const program = new Command();
+program
+    .description("CLI tool for creating, publishing and upgrading Flowershow apps")
+    .version(require("../../package.json").version)
+    .usage("<command> [options]");
+// choose template
+program
+    .command("install")
+    .description("install Flowershow template in target directory")
+    .argument("[target-dir]", "Path to the folder where you want Flowershow template to be installed", ".")
+    // .option('-t, --template [template-name]', 'Flowershow template name to use', 'default')
+    .action(async (targetDir) => {
+    const { default: install } = await import("../lib/install.js");
+    install(targetDir);
+});
+program
+    .command("build")
+    .description("build Flowershow website")
+    .argument("[project-dir]", "Path to the folder where Flowershow template is installed (root folder of .flowershow)", ".")
+    .action(async (projectPath) => {
+    const { default: build } = await import("../lib/build.js");
+    build(projectPath);
+});
+program
+    .command("export")
+    .description("build a static Flowershow website")
+    .argument("[project-dir]", "Path to the folder where Flowershow template is installed (root folder of .flowershow)", ".")
+    .action(async (projectPath) => {
+    const { default: buildExport } = await import("../lib/buildExport.js");
+    buildExport(projectPath);
+});
+program
+    .command("preview")
+    .description("preview your Flowershow site")
+    .argument("[project-dir]", "Path to the folder where Flowershow template is installed (root folder of .flowershow)", ".")
+    .action(async (projectPath) => {
+    const { default: preview } = await import("../lib/preview.js");
+    preview(projectPath);
+});
+// TBD
+program
+    .command("publish")
+    .description("publish files or directories")
+    .argument("[path]", "path to a file or a directory", ".")
+    .option("-g, --glob <pattern>", "glob pattern")
+    .action(async () => {
+    const { default: publish } = await import("../lib/publish.js");
+    publish();
+});
+// TBD
+program
+    .command("upgrade")
+    .description("upgrade your Flowershow template to the latest version")
+    .action(async () => {
+    const { default: upgrade } = await import("../lib/upgrade.js");
+    upgrade();
+});
+program.parse();

package/dist/src/index.js

@@ -0,0 +1 @@
+// export * from './lib/cli';

package/dist/src/lib/Installer.js

@@ -0,0 +1,185 @@
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+import * as fs from "fs";
+import * as path from "path";
+import chalk from "chalk";
+import degit from "degit";
+import { execa } from "execa";
+import inquirer from "inquirer";
+import { exit, error, log, info, success, logWithSpinner, stopSpinner, isSubdir, } from "./utils/index.js";
+import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
+export default class Installer {
+    constructor(context, targetDir) {
+        this.templateRepo = "https://github.com/datopian/flowershow";
+        this.context = context;
+        this.targetDir = targetDir;
+    }
+    async install() {
+        const { context, targetDir, templateRepo } = this;
+        const flowershowDir = path.resolve(targetDir, FLOWERSHOW_FOLDER_NAME);
+        let existsAction;
+        if (fs.existsSync(flowershowDir)) {
+            const { action } = await inquirer.prompt([
+                {
+                    name: "action",
+                    type: "list",
+                    message: `Flowershow template is already installed in directory ${chalk.magenta(targetDir)}. What do you want to do?:`,
+                    choices: [
+                        { name: "Overwrite", value: "overwrite" },
+                        // { name: 'Merge', value: 'merge' },
+                        { name: "Cancel", value: null },
+                    ],
+                },
+            ]);
+            if (!action) {
+                exit(0);
+            }
+            existsAction = action;
+        }
+        const { contentPath } = await inquirer.prompt([
+            {
+                name: "contentPath",
+                type: "input",
+                message: "Path to the folder with your markdown files",
+                validate(input) {
+                    const contentDir = path.resolve(context, input);
+                    if (!fs.existsSync(contentDir)) {
+                        error(`Directory ${contentDir} does not exist.`);
+                        exit(1);
+                    }
+                    return true;
+                },
+            },
+        ]);
+        const contentDir = path.resolve(context, contentPath);
+        // don't allow for installing the template anywhere within the content folder
+        // as it will break esbuild
+        if (isSubdir(flowershowDir, contentDir)) {
+            log(`Provided content directory: ${contentDir}`);
+            log(`Provided Flowershow template installation directory: ${flowershowDir}`);
+            error(`You can't install the Flowershow template inside your content folder.`);
+            exit(1);
+        }
+        const assetFolderChoices = fs
+            .readdirSync(contentDir, { withFileTypes: true })
+            .filter((d) => d.isDirectory())
+            .map((d) => ({ name: d.name, value: d.name }));
+        let assetsFolder;
+        if (!assetFolderChoices.length) {
+            const { foldersAction } = await inquirer.prompt([
+                {
+                    name: "foldersAction",
+                    type: "list",
+                    message: "There are no subfolders in your content folder, that could be used as assets folder",
+                    choices: [
+                        { name: "I don't need assets folder", value: "none" },
+                        { name: "Cancel", value: null },
+                    ],
+                },
+            ]);
+            assetsFolder = foldersAction;
+        }
+        else {
+            const { assets } = await inquirer.prompt([
+                {
+                    name: "assets",
+                    type: "list",
+                    message: "Select a folder with your assets (attachments)",
+                    choices: [
+                        ...assetFolderChoices,
+                        new inquirer.Separator(),
+                        { name: "I don't need assets folder", value: "none" },
+                        { name: "Cancel", value: null },
+                    ],
+                },
+            ]);
+            assetsFolder = assets;
+        }
+        if (!assetsFolder) {
+            exit(0);
+        }
+        // install flowershow template
+        // // if there is no index.md file, create one
+        if (!fs.existsSync(`${contentPath}/index.md`)) {
+            info(`No index.md file found in ${contentDir}. Flowershow will create one for you.`);
+            const homePageContent = "# Welcome to my Flowershow site!";
+            // eslint-disable-next-line no-unused-vars
+            fs.writeFile(`${contentPath}/index.md`, homePageContent, { flag: "a" }, (err) => { } // eslint-disable-line @typescript-eslint/no-empty-function
+            );
+        }
+        // if there is a config.js file from older flowershow, change its extension.
+        if (fs.existsSync(`${contentPath}/config.js`)) {
+            fs.rename(`${contentPath}/config.js`, `${contentPath}/config.mjs`, (err) => {
+                if (err)
+                    info(`Failed to rename ${contentPath}/config.js file`);
+                info(`Renamed config.js file in ${contentDir} to config.mjs`);
+            });
+        }
+        // // if there is no config.mjs file, create one
+        if (!fs.existsSync(`${contentPath}/config.mjs`)) {
+            info(`No config.mjs file found in ${contentDir}. Flowershow will create one for you.`);
+            fs.writeFile(`${contentPath}/config.mjs`, "const config = {};\nexport default config;", { flag: "a" }, (err) => { } // eslint-disable-line @typescript-eslint/no-empty-function
+            );
+        }
+        // create flowershow template
+        logWithSpinner({
+            symbol: "🌷",
+            msg: `Creating Flowershow template in ${chalk.magenta(flowershowDir)}`,
+        });
+        try {
+            if (existsAction === "overwrite") {
+                fs.rmSync(flowershowDir, { recursive: true, force: true });
+            }
+            const emitter = degit(templateRepo);
+            await emitter.clone(flowershowDir);
+        }
+        catch (err) {
+            error(`Failed to clone Flowershow template into ${flowershowDir}. This may be a problem with Flowershow. Please let us know about it by submitting an issue: https://github.com/flowershow/flowershow/issues.`);
+            log(err);
+            exit(1);
+        }
+        // update content and assets symlinks
+        try {
+            // flowershow template includes starter content folder, so we need
+            // to remove it before creating symlinks
+            if (fs.existsSync(`${flowershowDir}/content`)) {
+                fs.rmSync(`${flowershowDir}/content`, { recursive: true, force: true });
+            }
+            const contentSymlinkPath = path.relative(`${flowershowDir}`, contentDir);
+            fs.symlinkSync(contentSymlinkPath, `${flowershowDir}/content`, "junction");
+            if (assetsFolder !== "none") {
+                const assetsSymlinkPath = path.relative(`${flowershowDir}/public`, `${contentDir}/${assetsFolder}`);
+                fs.symlinkSync(assetsSymlinkPath, `${flowershowDir}/public/${assetsFolder}`, "junction");
+            }
+            stopSpinner();
+            log("Created symlinks:");
+            log(`${chalk.cyan(`${flowershowDir}/content`)} -> ${chalk.magenta(contentDir)}`);
+            if (assetsFolder !== "none") {
+                log(`${chalk.cyan(`${flowershowDir}/public/${assetsFolder}`)} -> ${chalk.magenta(`${contentDir}/${assetsFolder}`)}`);
+            }
+        }
+        catch (err) {
+            error(`Failed to create symlinks to content and assets folders: ${err.message}`);
+            exit(err.exitCode);
+        }
+        // install flowershow dependencies
+        logWithSpinner({ symbol: "🌸", msg: `Installing Flowershow dependencies` });
+        try {
+            const subprocess = execa("npm", ["install"], {
+                cwd: flowershowDir,
+            });
+            process.on("SIGINT", () => {
+                subprocess.kill("SIGINT");
+            });
+            const { stdout, stderr } = await subprocess;
+            log(stdout);
+            log(stderr);
+            stopSpinner();
+            success("Successfully installed Flowershow!");
+        }
+        catch (err) {
+            error(`Failed to install Flowershow dependencies: ${err.message}`);
+            exit(err.exitCode);
+        }
+    }
+}

package/dist/src/lib/build.js

@@ -0,0 +1,18 @@
+import fs from "fs";
+import path from "path";
+import { execa } from "execa";
+import { exit, error } from "./utils/index.js";
+import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
+export default async function build(dir) {
+    const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
+    // check if flowershow is installed
+    if (!fs.existsSync(flowershowDir)) {
+        error(`Directory ${flowershowDir} does not exist.`);
+        exit(1);
+    }
+    const subprocess = execa("npm", ["run", "build"], { cwd: flowershowDir });
+    subprocess.stdout.pipe(process.stdout);
+    process.on("SIGINT", () => {
+        subprocess.kill("SIGINT");
+    });
+}

package/dist/src/lib/buildExport.js

@@ -0,0 +1,11 @@
+import path from "path";
+import { execa } from "execa";
+import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
+export default async function buildExport(dir) {
+    const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
+    const subprocess = execa("npm", ["run", "export"], { cwd: flowershowDir });
+    subprocess.stdout.pipe(process.stdout);
+    process.on("SIGINT", () => {
+        subprocess.kill("SIGINT");
+    });
+}

package/dist/src/lib/const.js

@@ -0,0 +1 @@
+export const FLOWERSHOW_FOLDER_NAME = ".flowershow";

package/dist/src/lib/install.js

@@ -0,0 +1,28 @@
+import fs from "fs";
+import path from "path";
+import inquirer from "inquirer";
+import Installer from "./Installer.js";
+import { error, exit } from "./utils/index.js";
+export default async function install(dir) {
+    const currentDir = process.cwd();
+    const inCurrentDir = dir === ".";
+    if (inCurrentDir) {
+        const { ok } = await inquirer.prompt([
+            {
+                name: "ok",
+                type: "confirm",
+                message: "Create Flowershow project in current directory?",
+            },
+        ]);
+        if (!ok) {
+            return;
+        }
+    }
+    const targetDir = path.resolve(dir);
+    if (!fs.existsSync(targetDir)) {
+        error(`Directory ${targetDir} does not exist.`);
+        exit(1);
+    }
+    const installer = new Installer(currentDir, targetDir);
+    await installer.install();
+}

package/dist/src/lib/preview.js

@@ -0,0 +1,18 @@
+import fs from "fs";
+import path from "path";
+import { execa } from "execa";
+import { exit, error } from "./utils/index.js";
+import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
+export default async function preview(dir) {
+    const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
+    // check if flowershow is installed
+    if (!fs.existsSync(flowershowDir)) {
+        error(`Directory ${flowershowDir} does not exist.`);
+        exit(1);
+    }
+    const subprocess = execa("npm", ["run", "dev"], { cwd: flowershowDir });
+    subprocess.stdout.pipe(process.stdout);
+    process.on("SIGINT", () => {
+        subprocess.kill("SIGINT");
+    });
+}

package/dist/src/lib/publish.js

@@ -0,0 +1,8 @@
+import chalk from "chalk";
+const log = console.log;
+export default function publish() {
+    log(chalk.redBright.bold("Command under construction...\n"));
+    log(chalk.blue("Check " +
+        chalk.green.underline("https://flowershow.app") +
+        " to learn more about Flowershow development stage and subscribe to get notified when it's ready!"));
+}

package/dist/src/lib/upgrade.js

@@ -0,0 +1,8 @@
+import chalk from "chalk";
+const log = console.log;
+export default function upgrade() {
+    log(chalk.redBright.bold("Command under construction...\n"));
+    log(chalk.blue("Check " +
+        chalk.green.underline("https://flowershow.app") +
+        " to learn more about Flowershow development stage and subscribe to get notified when it's ready!"));
+}

package/dist/src/lib/utils/exit.js

@@ -0,0 +1,3 @@
+export const exit = (code) => {
+    process.exit(code);
+};

package/dist/src/lib/utils/index.js

@@ -0,0 +1,5 @@
+export { error, info, log, success, warn } from "./logger.js";
+export { exit } from "./exit.js";
+export { isSubdir } from "./isSubdir.js";
+export { sendEvent } from "./sendEvent.js";
+export { logWithSpinner, stopSpinner, pauseSpinner, resumeSpinner, } from "./spinner.js";

package/dist/src/lib/utils/isSubdir.js

@@ -0,0 +1,6 @@
+import path from "path";
+// test if dir is a subdirectory of or same as ofDir
+export function isSubdir(dir, ofDir) {
+    const relative = path.relative(ofDir, dir);
+    return relative && !relative.startsWith("..") && !path.isAbsolute(relative);
+}

package/dist/src/lib/utils/logger.js

@@ -0,0 +1,19 @@
+import chalk from "chalk";
+export const log = (msg = "") => {
+    console.log(msg);
+};
+export const info = (msg) => {
+    console.log(`${chalk.bgBlueBright.black(" INFO ")} ${msg}`);
+};
+export const error = (msg) => {
+    console.error(`\n${chalk.bgRed(" ERROR ")} ${chalk.red(msg)}`);
+    if (msg instanceof Error) {
+        console.error(msg.stack);
+    }
+};
+export const success = (msg) => {
+    console.log(`${chalk.blue("🎊")} ${msg}`);
+};
+export const warn = (msg) => {
+    console.log(`${chalk.red("⚠")} ${msg}`);
+};

package/dist/src/lib/utils/sendEvent.js

@@ -0,0 +1,5 @@
+import ua from "universal-analytics";
+const visitor = ua("UA-235099461-1");
+export function sendEvent({ event, action, meta, }) {
+    visitor.event(event, action, JSON.stringify(meta)).send();
+}

package/dist/src/lib/utils/spinner.js

@@ -0,0 +1,49 @@
+import ora from "ora";
+import chalk from "chalk";
+const spinner = ora({ color: "magenta" });
+let lastMsg = null;
+let isPaused = false;
+export const logWithSpinner = ({ msg, symbol }) => {
+    if (!symbol) {
+        symbol = chalk.green("✔");
+    }
+    if (lastMsg) {
+        spinner.stopAndPersist({
+            symbol: lastMsg.symbol,
+            text: lastMsg.text,
+        });
+    }
+    spinner.text = " " + msg;
+    lastMsg = {
+        symbol: symbol + " ",
+        text: msg,
+    };
+    spinner.start();
+};
+export const stopSpinner = () => {
+    if (!spinner.isSpinning) {
+        return;
+    }
+    if (lastMsg) {
+        spinner.stopAndPersist({
+            symbol: lastMsg.symbol,
+            text: lastMsg.text,
+        });
+    }
+    else {
+        spinner.stop();
+    }
+    lastMsg = null;
+};
+export const pauseSpinner = () => {
+    if (spinner.isSpinning) {
+        spinner.stop();
+        isPaused = true;
+    }
+};
+export const resumeSpinner = () => {
+    if (isPaused) {
+        spinner.start();
+        isPaused = false;
+    }
+};

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "flowershow",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Publish your digital garden",
   "bin": {
-    "flowershow": "src/bin/cli.js"
+    "flowershow": "dist/bin/cli.js"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.lib.json",
+    "lint": "eslint --fix .",
+    "e2e": "mkdir -p coverage/cli-e2e && e2e/bats-core/bin/bats e2e/test.bats -p --report-formatter pretty -o coverage/cli-e2e --verbose-run"
   },
   "repository": {
     "type": "git",
@@ -11,7 +16,7 @@
     "directory": "packages/cli"
   },
   "files": [
-    "**/*"
+    "./dist"
   ],
   "keywords": [
     "flowershow",
@@ -39,6 +44,12 @@
   "engines": {
     "node": ">=16.3.0"
   },
-  "main": "./src/bin/cli.js",
-  "types": "./src/bin/cli.d.ts"
+  "devDependencies": {
+    "@types/degit": "^2.8.3",
+    "@types/inquirer": "^9.0.3",
+    "@types/node": "^20.3.1",
+    "@types/universal-analytics": "^0.4.5",
+    "tsc": "^2.0.4",
+    "typescript": "^5.1.3"
+  }
 }

package/CHANGELOG.md

@@ -1,74 +0,0 @@
-# flowershow
-
-## 0.1.9
-
-### Patch Changes
-
-- Kill subprocesses when parent process is terminated.
-
-## 0.1.8
-
-### Patch Changes
-
-- Adjust the CLI Installer after migrating Flowershow template to datopian/flowershow-template.
-
-## 0.1.7
-
-### Patch Changes
-
-- Rename [...slug].tsx to [[...slug]].tsx at installation, so that user can still define their own home pages using MD files.
-
-## 0.1.6
-
-### Patch Changes
-
-- f136048: Remove `pages/index.tsx` file from the copied Flowershow template, to allow users to set their own home page with MD file.
-
-## 0.1.5
-
-### Patch Changes
-
-- Replace config.js with config.mjs
-
-## 0.1.4
-
-### Patch Changes
-
-- Fix: incorrect `config.js` file created by the CLI
-
-## 0.1.3
-
-### Patch Changes
-
-- Remove unneeded dev files from cloned template.
-
-## 0.1.0
-
-### Minor Changes
-
-- 93b7911: Switch from JS to TS.
-
-## 0.0.11
-
-### Patch Changes
-
-- Basic anonymous telemetry (OS, Flowershow version and command being run).
-
-## 0.0.10
-
-### Patch Changes
-
-- Rename `flowershow build-static` to `flowershow export`.
-
-## 0.0.9
-
-### Patch Changes
-
-- CLI support for Windows. Symlink files removed from the template.
-- Add information about missing index.md and/or config.js files that the CLI will automatically create for the user.
-
-## 0.0.8
-
-### Patch Changes
-
-- Disallow installing the template inside the content folder.