@nzz/q-cli 1.7.0 → 1.8.0

package/README.md

@@ -164,6 +164,24 @@ Q new-custom-code my-project-name
 Q new-custom-code my-project-name -d my-project-directory
 ```
 
+### Creating new ed-tech utility package project
+
+Once `Q` cli is installed one can create the skeleton of a new ed-tech utility package project by executing
+
+```bash
+Q new-et-utils-package package-name package-author package-description
+```
+
+- The directory name where the new ed-tech utility package project is being created defaults to the project name and can be overwritten by using option `-d` or `--dir`
+
+```bash
+Q new-et-utils-package package-name -d my-project-directory
+```
+
+#### Notes
+
+New utility package projects should only be created inside the [ed-tech-utilities](https://github.com/nzzdev/ed-tech-utilities) repository.
+
 ### Q item actions
 
 The `Q` cli can copy and/or update existing Q items.

package/bin/commands/bootstrap.js

@@ -2,11 +2,19 @@ const fs = require("fs-extra");
 const path = require("path");
 const replaceInFile = require("replace-in-file");
 const chalk = require("chalk");
+const { replace } = require("nunjucks/src/filters");
 const errorColor = chalk.red;
 const successColor = chalk.green;
 const warningColor = chalk.yellow;
 
-module.exports = async function (type, name, basedir) {
+/**
+ *
+ * @param {string} type - Skeleton type
+ * @param {string} name - Name of the project
+ * @param {string} basedir - Base directory name to be created
+ * @param {Array.<{regex: RegExp, replaceWith: string}>} textReplacements
+ */
+module.exports = async function (type, basedir, textReplacements) {
   if (fs.existsSync(basedir)) {
     console.error(
       errorColor(`directory ${basedir} already exists or is not writable`)
@@ -16,34 +24,46 @@ module.exports = async function (type, name, basedir) {
     fs.mkdirSync(basedir);
   }
 
-  const replaceOptions = {
-    files: `${basedir}/**`,
-    from: new RegExp(`${type}-skeleton`, "g"),
-    to: name,
-    glob: {
-      dot: true, // Include file names starting with a dot
-    },
-  };
-
   try {
     await fs.copySync(
       path.join(__dirname, `../../skeletons/${type}-skeleton`),
       basedir
     );
-    await replaceInFile(replaceOptions);
+
+    if (textReplacements) {
+      for (const txtRe of textReplacements) {
+        await replaceText(txtRe.regex, txtRe.replaceWith, basedir);
+      }
+    }
+
     console.log(successColor(`Q ${type} is now bootstrapped in ${basedir}`));
 
-    if (type === "tool")
+    if (type === "tool" || type === "et-utils-package")
       console.log(
-        warningColor("Search for 'TODO:' inside the new tool to get started!")
+        warningColor(
+          "Search for 'TODO' inside the new tool/package to get started!"
+        )
       );
   } catch (error) {
     console.error(
       errorColor(
-        `An unexpected error occured. Please check the entered information and try again. ${JSON.stringify(
+        `An unexpected error occurred. Please check the entered information and try again. ${JSON.stringify(
           error
         )}`
       )
     );
   }
 };
+
+async function replaceText(regex, replaceWith, basedir) {
+  const replaceOptions = {
+    files: `${basedir}/**`, // Replace in all files
+    from: regex,
+    to: replaceWith,
+    glob: {
+      dot: true, // Include file names starting with a dot
+    },
+  };
+
+  return await replaceInFile(replaceOptions);
+}

package/bin/q.js

@@ -46,7 +46,11 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("server", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-skeleton`, "g"), replaceWith: name },
+      ];
+
+      await bootstrap("server", baseDir, textReplacements);
     });
 
   program
@@ -63,7 +67,11 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("tool", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-skeleton`, "g"), replaceWith: name },
+      ];
+
+      await bootstrap("tool", baseDir, textReplacements);
     });
 
   program
@@ -80,7 +88,42 @@ async function main() {
         process.exit(1);
       }
       const baseDir = program.dir || name;
-      await bootstrap("custom-code", name, baseDir);
+      const textReplacements = [
+        { regex: new RegExp(`${type}-skeleton`, "g"), replaceWith: name },
+      ];
+
+      await bootstrap("custom-code", baseDir, textReplacements);
+    });
+
+  program
+    .command("new-et-utils-package")
+    .option(
+      "-d, --dir <path>",
+      "the base directory to bootstrap the new tool in, defaults to the tools name"
+    )
+    .description("bootstrap a new ed-tech utility package")
+    .action(async () => {
+      const name = program.args[1];
+      const author = program.args[2] || "TODO: Set package author name";
+      const description =
+        program.args[3] || "TODO: Write a package description";
+
+      if (!name) {
+        console.error(errorColor("no package name given"));
+        process.exit(1);
+      }
+
+      const baseDir = program.dir || name;
+      const textReplacements = [
+        { regex: new RegExp("<package-name>", "g"), replaceWith: name },
+        { regex: new RegExp("<author-name>", "g"), replaceWith: author },
+        {
+          regex: new RegExp("<package-description>", "g"),
+          replaceWith: description,
+        },
+      ];
+
+      await bootstrap("et-utils-package", baseDir, textReplacements);
     });
 
   program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nzz/q-cli",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Cli tool to setup new Q tools, new Q server implementations and start Q dev server to test developing Q tools",
   "main": "index.js",
   "scripts": {

package/skeletons/custom-code-skeleton/tsconfig.json

@@ -1,15 +1,15 @@
 {
-    "extends": "@tsconfig/svelte/tsconfig.json",
-    "include": ["src/**/*"],
-    "exclude": ["node_modules/*", "__sapper__/*", "public/*"],
-    "compilerOptions": {
-        "lib": ["es2015", "DOM"],
-        "types": ["svelte"],
-        "outDir": "public",
-        "declaration": false,
-        "paths": {
-            "@src": ["./src/"],
-            "@interfaces": ["./src/interfaces.ts"]
-        }
+  "extends": "@tsconfig/svelte/tsconfig.json",
+  "include": ["src/**/*"],
+  "exclude": ["node_modules/*", "__sapper__/*", "public/*"],
+  "compilerOptions": {
+    "lib": ["es2015", "DOM"],
+    "types": ["svelte"],
+    "outDir": "public",
+    "declaration": false,
+    "paths": {
+      "@src": ["./src/"],
+      "@interfaces": ["./src/interfaces.ts"]
     }
+  }
 }

package/skeletons/et-utils-package-skeleton/.nvmrc

@@ -0,0 +1 @@
+16

package/skeletons/et-utils-package-skeleton/README.md

@@ -0,0 +1,7 @@
+# @nzz/et-utils-<package-name>
+
+<package-description>
+
+## Content
+
+TODO: Package documentation