flowershow 0.0.4 → 0.0.6

package/bin/flowershow.js

@@ -1,13 +1,19 @@
-#! /usr/bin/env node
+#!/usr/bin/env node
 import { createRequire } from 'node:module';
 const require = createRequire(import.meta.url);
+import { warn, log } from '../lib/utils/index.js';
 
-import { Command } from "commander";
+import os from 'os';
 
+if (os.platform() === 'win32') {
+  warn("This may not work as expected. You're trying to run Flowreshow CLI on Windows, which is not supported yet...");
+}
 
 // TODO check current vs required node version (package.json engines)
 // const requiredNodeVersion = require("../package.json").engines.node;
 
+import { Command } from "commander";
+
 const program = new Command();
 
 program
@@ -35,6 +41,16 @@ program
     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')

package/lib/Installer.js

@@ -8,90 +8,133 @@ import degit from 'degit';
 import { execa } from 'execa';
 import inquirer from 'inquirer';
 
-import { exit, error, log, logWithSpinner, stopSpinner, pauseSpinner, resumeSpinner } from './utils/index.js';
+import { exit, error, log, success, logWithSpinner, stopSpinner, pauseSpinner, resumeSpinner } from './utils/index.js';
 
+import { FLOWERSHOW_FOLDER_NAME } from './const.js';
 
-import { FLOWERSHOW_RELATIVE_PATH } from './const.js';
 
 export default class Creator {
-  constructor(context, template = 'default') {
+  constructor(context, targetDir, template = 'default') {
     this.context = context;
+    this.targetDir = targetDir;
     this.template = template; // tb configurable via command option in the future
   }
 
-  get flowershowDir() {
-    return path.resolve(this.context, FLOWERSHOW_RELATIVE_PATH);
-  }
-
   get templateRepo() {
     const flowershowRepo = require('../package.json').repository.url.replace("git+", "");
     return `${flowershowRepo}/templates/${this.template}`
   }
 
   async install(options) {
-    const { context, flowershowDir, templateRepo } = this;
-
-    logWithSpinner({ symbol: '🌷', msg: `Installing Flowershow template in ${chalk.magenta(flowershowDir)}...` });
+    const { context, targetDir, templateRepo } = this;
+    const flowershowDir = path.resolve(targetDir, FLOWERSHOW_FOLDER_NAME)
 
+    let existsAction;
     if (fs.existsSync(flowershowDir)) {
-      pauseSpinner();
-
-      const { action } = await inquirer.prompt([
+      let { action } = await inquirer.prompt([
         {
           name: 'action',
           type: 'list',
-          message: `Flowershow template is already installed in directory ${chalk.magenta(context)}. What do you want to do?:`,
+          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: false }
+            { name: 'Cancel', value: null }
           ]
         }
       ])
 
       if (!action) {
-        return
-      } else {
-        fs.rmSync(flowershowDir, { recursive: true, force: true });
+        exit(0)
       }
-      resumeSpinner();
-    }
-
-    // clone flowershow template
-    try {
-      const emitter = degit(templateRepo);
-      await emitter.clone(flowershowDir);
-    } catch {
-      // TODO better error message
-      error(`Failed to clone Flowershow template.`)
-      exit(1);
+      existsAction = action;
     }
 
-    // symlink content folder
-    pauseSpinner();
-
     let { contentPath } = await inquirer.prompt([
       {
         name: 'contentPath',
         type: 'input',
-        message: 'Path to the folder with your content files',
+        message: 'Path to the folder with your markdown files',
         validate(input) {
-          const contentPathAbsolute = path.resolve(context, input);
-          if (!fs.existsSync(contentPathAbsolute)) {
-            error(`Directory ${contentPathAbsolute} does not exist.`);
+          const contentDir = path.resolve(context, input);
+          if (!fs.existsSync(contentDir)) {
+            error(`Directory ${contentDir} does not exist.`);
             exit(1);
           }
-          resumeSpinner();
           return true;
         }
       }
     ])
 
-    contentPath = path.resolve(context, contentPath);
 
+    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(contentPath, `${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`)) {
@@ -104,44 +147,21 @@ export default class Creator {
       fs.writeFile(`${contentPath}/config.js`, '{}', { flag: 'a' }, err => {});
     }
 
-    // symlink assets folder
-    pauseSpinner();
-
-    const { assetsFolder } = await inquirer.prompt([
-      {
-        name: 'assetsFolder',
-        type: 'input',
-        message: 'Name of your assets (attachements) folder',
-        validate(input) {
-          const assetsPathAbsolute = path.resolve(contentPath, input);
-          if (!fs.existsSync(assetsPathAbsolute)) {
-            error(`Directory ${assetsPathAbsolute} does not exist.`);
-            exit(1);
-          }
-          resumeSpinner();
-          return true;
-        }
-      }
-    ])
-
-    fs.unlinkSync(`${flowershowDir}/public/assets`);
-    fs.symlinkSync(path.resolve(contentPath, assetsFolder), `${flowershowDir}/public/assets`);
-
-
-    // // install flowershow dependencies
+    // install flowershow dependencies
     logWithSpinner({ symbol: '🌸', msg: `Installing Flowershow dependencies...` });
 
     try {
-      const { stdout, stderr } = await execa('npm', [ 'install' ], { cwd: flowershowDir });
+      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);
     }
-
-    stopSpinner();
   }
 }

package/lib/build.js

@@ -3,12 +3,11 @@ import path from 'path';
 import { execa } from 'execa';
 
 import { exit, error, log } from './utils/index.js';
+import { FLOWERSHOW_FOLDER_NAME } from './const.js';
 
 
-import { FLOWERSHOW_RELATIVE_PATH } from './const.js';
-
 export default async function build(dir) {
-  const flowershowDir = path.resolve(dir, FLOWERSHOW_RELATIVE_PATH);
+  const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
 
   // check if flowershow is installed
   if (!fs.existsSync(flowershowDir)) {

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

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

package/lib/install.js

@@ -7,28 +7,30 @@ import Installer from './Installer.js';
 import { error, log, exit } from './utils/index.js';
 
 
-export default async function install(targetDir, options) {
+export default async function install(dir, options) {
   const currentDir = process.cwd();
-  const inCurrentDir = targetDir === '.';
-  const targetDirAbsolute = path.resolve(currentDir, targetDir);
+  const inCurrentDir = dir === '.';
 
-  if (fs.existsSync(targetDirAbsolute)) {
-    if (inCurrentDir) {
-      const { ok } = await inquirer.prompt([
-        {
-          name: "ok",
-          type: "confirm",
-          message: "Create Flowershow project in current directory?"
-        }
-      ])
-      if (!ok) {
-        return
+  if (inCurrentDir) {
+    const { ok } = await inquirer.prompt([
+      {
+        name: "ok",
+        type: "confirm",
+        message: "Create Flowershow project in current directory?"
       }
+    ])
+    if (!ok) {
+      return
     }
-  } else {
-    fs.mkdirSync(targetDirAbsolute);
   }
 
-  const installer = new Installer(targetDirAbsolute);
+  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

@@ -5,10 +5,10 @@ import { execa } from 'execa';
 import { exit, error, log } from './utils/index.js';
 
 
-import { FLOWERSHOW_RELATIVE_PATH } from './const.js';
+import { FLOWERSHOW_FOLDER_NAME } from './const.js';
 
 export default async function preview(dir) {
-  const flowershowDir = path.resolve(dir, FLOWERSHOW_RELATIVE_PATH);
+  const flowershowDir = path.resolve(dir, FLOWERSHOW_FOLDER_NAME);
 
   // check if flowershow is installed
   if (!fs.existsSync(flowershowDir)) {

package/lib/utils/index.js

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

package/lib/utils/logger.js

@@ -14,3 +14,11 @@ export const error = (msg) => {
     console.error(msg.stack)
   }
 }
+
+export const success = (msg) => {
+  console.log(`${chalk.blue('🎊')} ${msg}`);
+}
+
+export const warn = (msg) => {
+  console.log(`${chalk.red('⚠')} ${msg}`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowershow",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Publish your digital garden",
   "bin": {
     "flowershow": "bin/flowershow.js"
@@ -14,6 +14,9 @@
     "flowershow",
     "cli"
   ],
+  "scripts": {
+    "test": "./e2e/bats/bin/bats ./e2e/test.bats --verbose-run"
+  },
   "author": "Rufus Pollock",
   "license": "MIT",
   "bugs": {
@@ -34,6 +37,6 @@
   },
   "type": "module",
   "engines": {
-    "node": ">=12.2.0"
+    "node": ">=12.2.0 || >=14.13.0"
   }
 }

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"