flowershow 0.0.7 → 0.0.9

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# flowershow
+
+## 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowershow",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Publish your digital garden",
   "bin": {
     "flowershow": "src/bin/cli.js"
@@ -35,4 +35,4 @@
   "engines": {
     "node": ">=12.2.0 || >=14.13.0"
   }
-}
+}

package/project.json

@@ -37,6 +37,5 @@
       "outputs": ["coverage/packages/cli-e2e"]
     }
   },
-  "tags": [],
-  "implicitDependencies": ["template"]
+  "tags": []
 }

package/src/lib/Installer.js

@@ -12,14 +12,16 @@ import {
   exit,
   error,
   log,
+  info,
   success,
   logWithSpinner,
   stopSpinner,
+  isSubdir,
 } from "./utils/index.js";
 
 import { FLOWERSHOW_FOLDER_NAME } from "./const.js";
 
-export default class Creator {
+export default class Installer {
   constructor(context, targetDir) {
     this.context = context;
     this.targetDir = targetDir;
@@ -77,12 +79,26 @@ export default class Creator {
     ]);
 
     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 = "none";
+    let assetsFolder;
 
     if (!assetFolderChoices.length) {
       const { foldersAction } = await inquirer.prompt([
@@ -122,40 +138,13 @@ export default class Creator {
     }
 
     // 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`)) {
+      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,
@@ -166,6 +155,9 @@ export default class Creator {
 
     // // if there is no config.js file, create one
     if (!fs.existsSync(`${contentPath}/config.js`)) {
+      info(
+        `No config.js file found in ${contentDir}. Flowershow will create one for you.`
+      );
       fs.writeFile(
         `${contentPath}/config.js`,
         "{}",
@@ -174,15 +166,42 @@ export default class Creator {
       );
     }
 
-    // install flowershow dependencies
+    // create flowershow template
     logWithSpinner({
-      symbol: "🌸",
-      msg: `Installing Flowershow dependencies...`,
+      symbol: "🌷",
+      msg: `Creating 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 create Flowershow template in ${flowershowDir}.`);
+      exit(1);
+    }
+
+    // update content and assets symlinks
+    const contentSymlinkPath = path.relative(`${flowershowDir}`, contentDir);
+    fs.symlinkSync(contentSymlinkPath, `${flowershowDir}/content`);
+
+    if (assetsFolder !== "none") {
+      const assetsSymlinkPath = path.relative(
+        `${flowershowDir}/public`,
+        `${contentDir}/${assetsFolder}`
+      );
+      fs.symlinkSync(
+        assetsSymlinkPath,
+        `${flowershowDir}/public/${assetsFolder}`
+      );
+    }
+
+    // install flowershow dependencies
+    logWithSpinner({ symbol: "🌸", msg: `Installing Flowershow dependencies` });
     try {
-      // TODO this can be removed after monorepo has been set up correctly
-      await execa("npm", ["set-script", "prepare", ""], { cwd: flowershowDir });
       const { stdout, stderr } = await execa("npm", ["install"], {
         cwd: flowershowDir,
       });
@@ -191,7 +210,7 @@ export default class Creator {
       stopSpinner();
       success("Successfuly installed Flowershow!");
     } catch (err) {
-      error(`Installing dependencies failed: ${err.message}`);
+      error(`Failed to install Flowershow dependencies: ${err.message}`);
       exit(err.exitCode);
     }
   }

package/src/lib/utils/index.js

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

package/src/lib/utils/isSubdir.js

@@ -0,0 +1,7 @@
+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/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Life Itself
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.