flowershow 0.0.3 → 0.0.5

package/README.md

@@ -1,7 +1,5 @@
 # Flowershow CLI
 
-CLI tool for creating, publishing and upgrading Flowershow apps.
-
-🚧 Under development...
-💻 See how you can contribute [here](https://github.com/flowershow/flowershow#contributing).
-
+```bash
+npx flowershow --help
+```

package/bin/flowershow.js

@@ -0,0 +1,77 @@
+#!/usr/bin/env node
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+
+import { Command } from "commander";
+
+
+// TODO check current vs required node version (package.json engines)
+// const requiredNodeVersion = require("../package.json").engines.node;
+
+const program = new Command();
+
+program
+  .description('(Package under development)\nCLI 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, options) => {
+    const { default: install } = await import ('../lib/install.js');
+    install(targetDir, options);
+  })
+
+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('build-static')
+  .description('build static Flowershow website')
+  .argument('[project-dir]', 'Path to the folder where Flowershow template is installed (root folder of .flowershow)', '.')
+  .action(async (projectPath) => {
+    const { default: buildStatic } = await import ('../lib/buildStatic.js');
+    buildStatic(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/lib/Installer.js

@@ -0,0 +1,167 @@
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import degit from 'degit';
+import { execa } from 'execa';
+import inquirer from 'inquirer';
+
+import { exit, error, log, success, logWithSpinner, stopSpinner, pauseSpinner, resumeSpinner } from './utils/index.js';
+
+import { FLOWERSHOW_FOLDER_NAME } from './const.js';
+
+
+export default class Creator {
+  constructor(context, targetDir, template = 'default') {
+    this.context = context;
+    this.targetDir = targetDir;
+    this.template = template; // tb configurable via command option in the future
+  }
+
+  get templateRepo() {
+    const flowershowRepo = require('../package.json').repository.url.replace("git+", "");
+    return `${flowershowRepo}/templates/${this.template}`
+  }
+
+  async install(options) {
+    const { context, targetDir, templateRepo } = this;
+    const flowershowDir = path.resolve(targetDir, FLOWERSHOW_FOLDER_NAME)
+
+    let existsAction;
+    if (fs.existsSync(flowershowDir)) {
+      let { 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;
+    }
+
+    let { 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);
+    const assetFolderChoices = fs.readdirSync(contentDir, { withFileTypes: true })
+                                 .filter(d => d.isDirectory())
+                                 .map(d => ({ name: d.name, value: d.name }))
+
+    let assetsFolder = 'none';
+
+    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
+    logWithSpinner({ symbol: '🌷', msg: `Installing Flowershow template in ${chalk.magenta(flowershowDir)}...` });
+
+    if (existsAction === 'overwrite') {
+      fs.rmSync(flowershowDir, { recursive: true, force: true });
+    }
+
+    try {
+      const emitter = degit(templateRepo);
+      await emitter.clone(flowershowDir);
+    } catch {
+      error(`Failed to install Flowershow template in ${flowershowDir}.`)
+      exit(1);
+    }
+
+    // update content and assets symlinks
+    fs.unlinkSync(`${flowershowDir}/content`);
+    fs.symlinkSync(contentDir, `${flowershowDir}/content`);
+
+    fs.unlinkSync(`${flowershowDir}/public/assets`);
+    if (assetsFolder !== 'none') {
+      fs.symlinkSync(path.resolve(contentDir, assetsFolder), `${flowershowDir}/public/${assetsFolder}`);
+    }
+
+    // // if there is no index.md file, create one
+    if (!fs.existsSync(`${contentPath}/index.md`)) {
+      const homePageContent = '# Welcome to my Flowershow site!';
+      fs.writeFile(`${contentPath}/index.md`, homePageContent, { flag: 'a' }, err => {});
+    }
+
+    // // if there is no config.js file, create one
+    if (!fs.existsSync(`${contentPath}/config.js`)) {
+      fs.writeFile(`${contentPath}/config.js`, '{}', { flag: 'a' }, err => {});
+    }
+
+    // install flowershow dependencies
+    logWithSpinner({ symbol: '🌸', msg: `Installing Flowershow dependencies...` });
+
+    try {
+      await execa('npm', [ 'set-script', 'prepare', '' ], { cwd: flowershowDir });
+      const { stdout, stderr } = await execa('npm', [ 'install'], { cwd: flowershowDir });
+      log(stdout);
+      log(stderr);
+      stopSpinner();
+      success("Successfuly installed Flowershow!")
+    } catch (err) {
+      error(
+        `Installing dependencies failed: ${err.message}`
+      );
+      exit(err.exitCode);
+    }
+  }
+}

package/lib/build.js

@@ -0,0 +1,20 @@
+import fs from 'fs';
+import path from 'path';
+import { execa } from 'execa';
+
+import { exit, error, log } 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);
+}

package/lib/buildStatic.js

@@ -0,0 +1,15 @@
+import fs from 'fs';
+import path from 'path';
+import { execa } from 'execa';
+
+import { exit, error, log } from './utils/index.js';
+import { FLOWERSHOW_FOLDER_NAME } from './const.js';
+
+
+export default async function buildStatic(dir) {
+  const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
+
+  const subprocess = execa('npm', [ 'run', 'export' ], { cwd: flowershowDir });
+
+  subprocess.stdout.pipe(process.stdout);
+}

package/lib/const.js

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

package/lib/install.js

@@ -0,0 +1,36 @@
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+
+import Installer from './Installer.js';
+import { error, log, exit } from './utils/index.js';
+
+
+export default async function install(dir, options) {
+  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(options);
+}

package/lib/preview.js

@@ -0,0 +1,21 @@
+import fs from 'fs';
+import path from 'path';
+import { execa } from 'execa';
+
+import { exit, error, log } 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);
+}

package/lib/utils/exit.js

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

package/lib/utils/index.js

@@ -0,0 +1,3 @@
+export { error, info, log, success } from './logger.js';
+export { exit } from './exit.js';
+export { logWithSpinner, stopSpinner, pauseSpinner, resumeSpinner } from './spinner.js';

package/lib/utils/logger.js

@@ -0,0 +1,20 @@
+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}`);
+}

package/lib/utils/spinner.js

@@ -0,0 +1,54 @@
+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,31 +1,42 @@
 {
   "name": "flowershow",
-  "version": "0.0.3",
-  "engines": {
-    "node": ">=14.16"
-  },
-  "author": "Rufus Pollock",
+  "version": "0.0.5",
   "description": "Publish your digital garden",
-  "keywords": ["markdown", "MDX", "mdx", "publish", "obsidian"],
-  "exports": "./index.js",
-  "bin": "./index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "bin": {
+    "flowershow": "bin/flowershow.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/flowershow/flowershow",
-    "directory": "packages/flowershow"
+    "directory": "packages/cli"
   },
+  "keywords": [
+    "flowershow",
+    "cli"
+  ],
+  "scripts": {
+    "test": "./e2e/bats/bin/bats ./e2e/test.bats --verbose-run"
+  },
+  "author": "Rufus Pollock",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/flowershow/flowershow/issues"
   },
   "homepage": "https://github.com/flowershow/flowershow#readme",
+  "publishConfig": {
+    "access": "public"
+  },
   "dependencies": {
-    "chalk": "^4.1.2",
+    "chalk": "^5.0.1",
     "commander": "^9.4.0",
-    "inquirer": "^9.1.1"
+    "degit": "^2.8.4",
+    "execa": "^6.1.0",
+    "inquirer": "^9.1.1",
+    "ora": "^6.1.2",
+    "validate-npm-package-name": "^4.0.0"
   },
-  "type": "module"
+  "type": "module",
+  "engines": {
+    "node": ">=12.2.0 || >=14.13.0"
+  }
 }

package/commands/build.js

@@ -1,12 +0,0 @@
-import chalk from 'chalk';
-
-
-const log = console.log;
-
-export default function build () {
-  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/commands/create.js

@@ -1,12 +0,0 @@
-import chalk from 'chalk';
-
-
-const log = console.log;
-
-export default function create () {
-  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/index.js

@@ -1,39 +0,0 @@
-#! /usr/bin/env node
-
-import { Command } from "commander";
-
-import publish from './commands/publish.js';
-import create from './commands/create.js';
-import build from './commands/build.js';
-import upgrade from './commands/upgrade.js';
-
-const program = new Command();
-
-program
-  .name('flowershow')
-  .description('(Package under development)\nCLI tool for creating, publishing and upgrading Flowershow apps')
-  .version('0.0.1');
-
-program
-  .command('publish')
-  .description('Publish files or directories')
-  .argument('[path]', 'path to a file or a directory', '.')
-  .option('-g, --glob <pattern>', 'glob pattern')
-  .action(publish);
-
-program
-  .command('create')
-  .description('Create a new app template')
-  .action(create);
-
-program
-  .command('build')
-  .description('Build Flowershow website')
-  .action(build);
-
-program
-  .command('upgrade')
-  .description('Upgrade your Flowershow template to the latest version')
-  .action(upgrade);
-
-program.parse();

package/upgrade.sh

@@ -1,28 +0,0 @@
-# upgrade an existing standard nextjs site
-
-npx degit flowershow/flowershow/templates/default --force
-
-# files that we should keep the original (probably)
-git checkout README.md
-git checkout .gitignore
-
-# stuff that shouldn't be there
-rm .env.example
-rm -Rf tests
-rm netlify.toml
-rm netlify.toml
-# data seems to be exampleData
-rm -Rf data
-rm -Rf components/TempCallout.jsx
-
-# set up custom components
-rm -Rf components/custom
-
-# set up assets
-mkdir -p content/assets
-rm public/assets
-ln -s content/assets public/assets
-
-# notes
-echo "You may need to hand merge the following files:"
-echo "pacakge.json, package-lock.json"