feat: add a command for generating boilerplate based on @strapi/generators

Author: boazpoolman

README.md

@@ -77,3 +77,7 @@ Verifies the output of your plugin before publishing it
 ```sh
 yarn run verify
 ```
+
+### `generate`
+
+Starts an interactive CLI to generate boilerplate code for your plugin

package.json

@@ -58,6 +58,7 @@
     "watch": "pack-up watch"
   },
   "dependencies": {
+    "@strapi/generators": "5.27.0",
     "@strapi/pack-up": "^5.0.1",
     "@types/prompts": "2.4.9",
     "boxen": "5.1.2",
@@ -67,6 +68,7 @@
     "execa": "^9.3.1",
     "get-latest-version": "5.1.0",
     "git-url-parse": "13.1.1",
+    "inquirer": "^12.9.6",
     "nodemon": "^3.1.0",
     "ora": "5.4.1",
     "outdent": "0.8.0",

pnpm-lock.yaml

@@ -1,4 +1,5 @@
 import { command as buildPluginCommand } from './plugin/build';
+import { command as generateCommand } from './plugin/generate';
 import { command as initPluginCommand } from './plugin/init';
 import { command as linkWatchPluginCommand } from './plugin/link-watch';
 import { command as verifyPluginCommand } from './plugin/verify';
@@ -8,6 +9,7 @@ import type { StrapiCommand } from '../../types';
 
 export const commands: StrapiCommand[] = [
   buildPluginCommand,
+  generateCommand,
   initPluginCommand,
   linkWatchPluginCommand,
   watchPluginCommand,

src/cli/commands/index.ts

@@ -0,0 +1,37 @@
+import { generate } from '@strapi/generators';
+import validateInput from '@strapi/generators/dist/plops/utils/validate-input';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * api generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const config = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'id',
+      message: 'API name',
+      validate: (input) => validateInput(input),
+    },
+  ]);
+
+  generate(
+    'api',
+    {
+      id: config.id,
+      isPluginApi: true,
+      destination: 'root',
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;

src/cli/commands/plugin/generate/actions/api.ts

@@ -0,0 +1,40 @@
+import { generate } from '@strapi/generators';
+import bootstrapApiPrompts from '@strapi/generators/dist/plops/prompts/bootstrap-api-prompts';
+import ctNamesPrompts from '@strapi/generators/dist/plops/prompts/ct-names-prompts';
+import getAttributesPrompts from '@strapi/generators/dist/plops/prompts/get-attributes-prompts';
+import kindPrompts from '@strapi/generators/dist/plops/prompts/kind-prompts';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * content-type generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const nameInfo = await inquirer.prompt([...ctNamesPrompts, ...kindPrompts] as any);
+  const attributes = await getAttributesPrompts(inquirer);
+  const bootstrapInfo = await inquirer.prompt([...bootstrapApiPrompts] as any);
+
+  generate(
+    'content-type',
+    {
+      kind: nameInfo.kind,
+      singularName: nameInfo.singularName,
+      id: nameInfo.id,
+      pluralName: nameInfo.pluralName,
+      displayName: nameInfo.displayName,
+      destination: 'root',
+      bootstrapApi: bootstrapInfo.bootstrapApi,
+      attributes,
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;

src/cli/commands/plugin/generate/actions/content-type.ts

@@ -0,0 +1,36 @@
+import { generate } from '@strapi/generators';
+import validateInput from '@strapi/generators/dist/plops/utils/validate-input';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * controller generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const config = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'id',
+      message: 'Controller name',
+      validate: (input) => validateInput(input),
+    },
+  ]);
+
+  generate(
+    'controller',
+    {
+      id: config.id,
+      destination: 'root',
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;

src/cli/commands/plugin/generate/actions/controller.ts

@@ -0,0 +1,36 @@
+import { generate } from '@strapi/generators';
+import validateInput from '@strapi/generators/dist/plops/utils/validate-input';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * middleware generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const config = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Middleware name',
+      validate: (input) => validateInput(input),
+    },
+  ]);
+
+  generate(
+    'middleware',
+    {
+      name: config.name,
+      destination: 'root',
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;

src/cli/commands/plugin/generate/actions/middleware.ts

@@ -0,0 +1,36 @@
+import { generate } from '@strapi/generators';
+import validateInput from '@strapi/generators/dist/plops/utils/validate-input';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * policy generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const config = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'id',
+      message: 'Policy name',
+      validate: (input) => validateInput(input),
+    },
+  ]);
+
+  generate(
+    'policy',
+    {
+      id: config.id,
+      destination: 'root',
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;

src/cli/commands/plugin/generate/actions/policy.ts

@@ -0,0 +1,36 @@
+import { generate } from '@strapi/generators';
+import validateInput from '@strapi/generators/dist/plops/utils/validate-input';
+import inquirer from 'inquirer';
+
+import { loadPkg, validatePkg } from '../../../utils/pkg';
+
+import type { CLIContext } from '../../../../../types';
+
+/**
+ * service generator for Strapi plugins
+ */
+const action = async ({ ctx: { cwd, logger } }: { ctx: CLIContext }) => {
+  const pkg = await loadPkg({ cwd, logger });
+  const validatedPkg = await validatePkg({ pkg });
+
+  const config = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'id',
+      message: 'Service name',
+      validate: (input) => validateInput(input),
+    },
+  ]);
+
+  generate(
+    'service',
+    {
+      id: config.id,
+      destination: 'root',
+      plugin: validatedPkg.strapi.name,
+    },
+    { dir: 'server' }
+  );
+};
+
+export default action;