@kosdev-code/kos-ui-cli 2.0.8 → 2.0.9

package/src/lib/plopfile.mjs

@@ -1,586 +1,51 @@
-import { spawn } from "child_process";
-import { createWorkspace } from "create-nx-workspace";
-import fs from "fs";
-import directoryPrompt from "inquirer-directory";
-import path from "path";
-import {
-  detectWorkspace,
-  execute,
-  getAllProjects,
-  getLibraryProjects,
-  getPluginProjects,
-  getProjectDetails,
-  required,
-} from "./utils/utils.mjs";
+// plopfile.mjs
+import { detectWorkspace } from "./utils/nx-context.mjs";
+
+// Generator registration
+import registerCompanion from "./generators/model/companion.mjs";
+import registerContainer from "./generators/model/container.mjs";
+import registerContext from "./generators/model/context.mjs";
+import registerHook from "./generators/model/hook.mjs";
+import registerKosModel from "./generators/model/model.mjs";
+
+import registerComponent from "./generators/component/index.mjs";
+import registerPluginComponent from "./generators/plugin/index.mjs";
+
+import registerCacheGenerators from "./generators/cache/index.mjs";
+import registerEnv from "./generators/env/index.mjs";
+import registerI18nNamespace from "./generators/i18n/namespace.mjs";
+import registerUiProject from "./generators/project/app.mjs";
+import registerI18n from "./generators/project/i18n.mjs";
+import registerPluginProject from "./generators/project/plugin.mjs";
+import registerSplashProject from "./generators/project/splash.mjs";
+import registerTheme from "./generators/project/theme.mjs";
+import registerWorkspace from "./generators/workspace/index.mjs";
 
-const DEFAULT_PROMPTS = [
-  {
-    type: "confirm",
-    name: "interactive",
-    message: "Do you want to use the interactive mode?",
-    default: false,
-    when: false,
-  },
-  {
-    type: "confirm",
-    name: "dryRun",
-    message: "Show the output of the command without running it?",
-    default: false,
-    when: false,
-  },
-];
-
-const MODEL_PROMPTS = [
-  {
-    type: "confirm",
-    name: "container",
-    default: false,
-    message: "Does this model require a container model?",
-  },
-  {
-    type: "confirm",
-    name: "parentAware",
-    when: (answers) => {
-      return !!answers.container;
-    },
-    default: false,
-    message: "Should the model be aware of it's parent container?",
-  },
-  {
-    type: "confirm",
-    name: "singleton",
-    default: false,
-    message: "Is this model a singleton?",
-  },
-
-  {
-    type: "confirm",
-    name: "dataServices",
-    default: true,
-    message: "Create data services for model?",
-  },
-];
 export default async function (plop) {
-  plop.setPrompt("directory", directoryPrompt);
   const isWorkspace = await detectWorkspace();
-  const libraryProjects = isWorkspace ? await getLibraryProjects() : [];
-  const allProjects = isWorkspace ? await getAllProjects() : [];
-
-  plop.setActionType("createWorkspace", async function (answers, config, plop) {
-    await createWorkspace("@kosdev-code/kos-nx-plugin", {
-      nxCloud: "skip",
-      name: answers.workspaceName,
-    });
-    return `workspace ${answers.workspaceName} created`;
-  });
-
-  plop.setActionType("createModel", async function (answers, config, plop) {
-    const modelProject = await getProjectDetails(answers.modelProject);
-
-    try {
-      await execute(
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-model --name=${
-          answers.modelName
-        } --modelProject=${
-          modelProject.name
-        } --skipRegistration=true --container=${!!answers.container} --dataServices=${!!answers.dataServices} --singleton=${!!answers.singleton} --parentAware=${!!answers.parentAware} --no-interactive ${
-          answers.dryRun ? "--dryRun" : ""
-        } --verbose`
-      );
-    } catch (error) {
-      throw new Error(error);
-    }
-
-    return `*******************************************************
-    model ${answers.modelName} created in ${answers.modelProject}
-    
-    Please register the model in your app registration file
-    *******************************************************`;
-  });
-
-  plop.setActionType("addNamespace", async function (answers, config, plop) {
-    const i18nProject = await getProjectDetails(answers.project);
-    const locale = answers.locale;
-    const src = i18nProject.sourceRoot;
-    const namespaceDirPath = path.join(src, "assets", "locales", locale);
-
-    const namespacePath = path.join(namespaceDirPath, `${answers.name}.json`);
-
-    const defaultData = {
-      name: answers.name,
-    };
-
-    fs.mkdirSync(namespaceDirPath, { recursive: true });
-    fs.writeFileSync(namespacePath, JSON.stringify(defaultData, null, 2));
-  });
-
-  plop.setActionType("createSplashProject", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `nx generate @kosdev-code/kos-nx-plugin:kos-splash-project --name=${answers.name} --no-interactive`.split(
-          " "
-        );
-
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`Splash page project ${answers.name} created`);
-        } else {
-          reject(`Splash page project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-  plop.setActionType("createComponent", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-component --name=${answers.componentName} --appProject=${answers.componentProject} --type=components --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`UI project ${answers.name} created`);
-        } else {
-          reject(`UI project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-  plop.setActionType("createPluginComponent", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const pluginType = answers.extensionPoint;
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-component --name=${answers.componentName} --group=${answers.group} --appProject=${answers.componentProject} --pluginType=${pluginType} --type=components --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`UI project ${answers.name} created`);
-        } else {
-          reject(`UI project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-  plop.setActionType("createUiProject", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-ui-project --name=${answers.name} --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`UI project ${answers.name} created`);
-        } else {
-          reject(`UI project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-
-  plop.setActionType("createI18nProject", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-i18n-project --name=${answers.name} --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`i18n project ${answers.name} created`);
-        } else {
-          reject(`i18n project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-  plop.setActionType("createThemeProject", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-theme-project --name=${answers.name} --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`theme project ${answers.name} created`);
-        } else {
-          reject(`theme project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-
-  plop.setActionType("createPluginProject", function (answers, config, plop) {
-    return new Promise((resolve, reject) => {
-      const command =
-        `npx nx generate @kosdev-code/kos-nx-plugin:kos-plugin-project --name=${answers.name} --no-interactive`.split(
-          " "
-        );
-      const child = spawn("npx", command, { shell: true });
-      child.stdout.on("data", (data) => {
-        console.log(`${data}`);
-      });
-
-      child.stderr.on("data", (data) => {
-        console.error(`ERROR:${data}`);
-      });
-      child.on("exit", function (code, signal) {
-        if (code === 0) {
-          resolve(`plugin project ${answers.name} created`);
-        } else {
-          reject(`plugin project ${answers.name} failed`);
-        }
-      });
-    });
-  });
-
-  plop.setGenerator("component", {
-    description: "Create a new KOS Component",
-    prompts: [
-      {
-        type: "input",
-        name: "componentName",
-        message: "Enter the name of the component",
-        validate: required,
-      },
-      {
-        type: "list",
-        name: "componentProject",
-        message: "Which project should the component be created in?",
-        choices: allProjects,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createComponent",
-      };
-      return [action];
-    },
-  });
-
-  const pluginPrompts = [
-    {
-      type: "input",
-      name: "componentName",
-      message: "Enter the name of the component",
-      validate: required,
-    },
-    {
-      type: "list",
-      name: "componentProject",
-      message: "Which project should the component be created in?",
-      choices: getPluginProjects,
-    },
-  ];
-  plop.setGenerator("pluginComponent", {
-    description: "Create a new KOS Plugin Component",
-    prompts: [
-      ...pluginPrompts,
-      {
-        type: "list",
-        name: "extensionPoint",
-        message: "What type of extension point is the plugin supporting?",
-        choices: ["cui", "setup", "utility", "setting", "troubleAction"],
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createPluginComponent",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("plugin:cui", {
-    description: "Create a new KOS CUI Configuration Plugin Component",
-    prompts: [...pluginPrompts],
-    actions: function (data) {
-      data.extensionPoint = "cui";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "cui",
-      };
-      return [action];
-    },
-  });
-  plop.setGenerator("plugin:utility", {
-    description: "Create a new KOS Utility Plugin Component",
-    prompts: [...pluginPrompts],
-    actions: function (data) {
-      data.extensionPoint = "utility";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "utility",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("plugin:troubleAction", {
-    description: "Create a new KOS Trouble Action Plugin Component",
-    prompts: [...pluginPrompts],
-    actions: function (data) {
-      data.extensionPoint = "troubleAction";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "troubleAction",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("plugin:setup", {
-    description: "Create a new KOS Setup Step Plugin Component",
-    prompts: [...pluginPrompts],
-    actions: function (data) {
-      data.extensionPoint = "setup";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "setup",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("plugin:setting", {
-    description: "Create a new KOS Settings Plugin Component",
-    prompts: [
-      ...pluginPrompts,
-      {
-        type: "input",
-        name: "group",
-        message: "Which settings group should the setting be located?",
-      },
-    ],
-    actions: function (data) {
-      data.extensionPoint = "setting";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "setting",
-      };
-      return [action];
-    },
-  });
-  plop.setGenerator("plugin:nav", {
-    description: "Create a new KOS Navigation View Plugin Component",
-    prompts: [...pluginPrompts],
-    actions: function (data) {
-      data.extensionPoint = "nav";
-      const action = {
-        type: "createPluginComponent",
-        extensionPoint: "nav",
-      };
-      return [action];
-    },
-  });
-  plop.setGenerator("workspace", {
-    description: "KOS UI Workspace Setup",
-    prompts: [
-      {
-        type: "input",
-        name: "workspaceName",
-        message: "KOS UI Workspace Name",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createWorkspace",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("model", {
-    description: "Create a new KOS Model",
-    prompts: [
-      ...DEFAULT_PROMPTS,
-      {
-        type: "input",
-        name: "modelName",
-        message: "Enter the name of the model",
-        validate: required,
-      },
-      {
-        type: "list",
-        name: "modelProject",
-        message: "Which model project to use?",
-        validate: required,
-        choices: libraryProjects,
-      },
-      ...MODEL_PROMPTS,
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createModel",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("theme", {
-    description: "Create a new kos UI Theme project",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the theme project?",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createThemeProject",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("project", {
-    description: "Create a new kos UI App project",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the app project?",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createUiProject",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("plugin", {
-    description: "Create a new kos UI Plugin project",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the plugin project?",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createPluginProject",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("project:splash", {
-    description: "Create a new kos splash page project",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the splash project?",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createSplashProject",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("i18n", {
-    description: "Create a new kos UI i18n project",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the i18n project?",
-        validate: required,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "createI18nProject",
-      };
-      return [action];
-    },
-  });
-
-  plop.setGenerator("i18n:namespace", {
-    description: "Create a new kos UI i18n namespace",
-    prompts: [
-      {
-        type: "input",
-        name: "name",
-        message: "What is the name of the i18n namespace?",
-        validate: required,
-      },
-      {
-        type: "input",
-        name: "locale",
-        message: "What is the locale of the i18n namespace?",
-        validate: required,
-      },
-      {
-        type: "list",
-        name: "project",
-        message: "Which project should the namespace be created in?",
-        choices: getAllProjects,
-      },
-    ],
-    actions: function (data) {
-      const action = {
-        type: "addNamespace",
-      };
-      return [action];
-    },
-  });
+  if (!isWorkspace) {
+    console.warn("[kos-cli] Not inside an Nx workspace. Exiting.");
+    return;
+  }
+
+  // Register all generators
+  await registerKosModel(plop);
+  await registerHook(plop);
+  await registerCompanion(plop);
+  await registerContainer(plop);
+  await registerContext(plop);
+
+  await registerComponent(plop);
+  await registerPluginComponent(plop);
+
+  await registerWorkspace(plop);
+  await registerTheme(plop);
+  await registerUiProject(plop);
+  await registerPluginProject(plop);
+  await registerSplashProject(plop);
+  await registerI18n(plop);
+  await registerI18nNamespace(plop);
+  await registerEnv(plop);
+
+  await registerCacheGenerators(plop);
 }