@strapi/generators 4.0.0-next.9 → 4.0.0

package/lib/files/plugin/admin/src/components/PluginIcon/index.js

@@ -0,0 +1,12 @@
+/**
+ *
+ * PluginIcon
+ *
+ */
+
+import React from 'react';
+import Puzzle from '@strapi/icons/Puzzle';
+
+const PluginIcon = () => <Puzzle />;
+
+export default PluginIcon;

package/lib/files/plugin/admin/src/index.js

@@ -2,16 +2,15 @@ import { prefixPluginTranslations } from '@strapi/helper-plugin';
 import pluginPkg from '../../package.json';
 import pluginId from './pluginId';
 import Initializer from './components/Initializer';
+import PluginIcon from './components/PluginIcon';
 
-const pluginDescription = pluginPkg.strapi.description || pluginPkg.description;
-const icon = pluginPkg.strapi.icon;
 const name = pluginPkg.strapi.name;
 
 export default {
   register(app) {
     app.addMenuLink({
       to: `/plugins/${pluginId}`,
-      icon,
+      icon: PluginIcon,
       intlLabel: {
         id: `${pluginId}.plugin.name`,
         defaultMessage: name,
@@ -30,12 +29,9 @@ export default {
       ],
     });
     app.registerPlugin({
-      description: pluginDescription,
-      icon,
       id: pluginId,
       initializer: Initializer,
       isReady: false,
-      isRequired: pluginPkg.strapi.required || false,
       name,
     });
   },

package/lib/files/plugin/server/bootstrap.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = ({ strapi }) => {
+  // bootstrap phase
+};

package/lib/files/plugin/server/config/index.js

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports = {
+  default: {},
+  validator() {},
+};

package/lib/files/plugin/server/controllers/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const myController = require('./my-controller');
+
+module.exports = {
+  myController,
+};

package/lib/files/plugin/server/controllers/my-controller.js.hbs

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = {
+  index(ctx) {
+    ctx.body = strapi
+      .plugin('{{ pluginName }}')
+      .service('myService')
+      .getWelcomeMessage();
+  },
+};

package/lib/files/plugin/server/destroy.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = ({ strapi }) => {
+  // destroy phase
+};

package/lib/files/plugin/server/index.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const register = require('./register');
+const bootstrap = require('./bootstrap');
+const destroy = require('./destroy');
+const config = require('./config');
+const controllers = require('./controllers');
+const routes = require('./routes');
+const services = require('./services');
+
+module.exports = {
+  register,
+  bootstrap,
+  destroy,
+  config,
+  controllers,
+  routes,
+  services,
+  contentTypes: {},
+  policies: {},
+  middlewares: {},
+};

package/lib/files/plugin/server/register.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = ({ strapi }) => {
+  // registeration phase
+};

package/lib/files/plugin/server/routes/index.js

@@ -0,0 +1,10 @@
+module.exports = [
+  {
+    method: 'GET',
+    path: '/',
+    handler: 'myController.index',
+    config: {
+      policies: [],
+    },
+  },
+];

package/lib/files/plugin/server/services/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const myService = require('./my-service');
+
+module.exports = {
+  myService,
+};

package/lib/files/plugin/server/services/my-service.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = ({ strapi }) => ({
+  getWelcomeMessage() {
+    return 'Welcome to Strapi 🚀';
+  },
+});

package/lib/files/plugin/strapi-admin.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./admin/src').default;

package/lib/files/plugin/strapi-server.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./server');

package/lib/index.js

@@ -9,7 +9,7 @@ const nodePlop = require('node-plop');
  */
 const runCLI = () => {
   Plop.launch({ configPath: join(__dirname, 'plopfile.js') }, env =>
-    run({ ...env, dest: process.cwd() }, undefined, true)
+    run({ ...env, dest: join(process.cwd(), 'src') }, undefined, true)
   );
 };
 
@@ -21,13 +21,13 @@ const runCLI = () => {
  * @param {string} plopOptions.dir base path for plop to generate the files from
  */
 const generate = async (generatorName, options, { dir = process.cwd() } = {}) => {
-  const plop = nodePlop(join(__dirname, 'plopfile.js'), { destBasePath: dir });
+  const plop = nodePlop(join(__dirname, 'plopfile.js'), { destBasePath: join(dir, 'src') });
 
   const generator = plop.getGenerator(generatorName);
   await generator.runActions(options, {
-    onSuccess: () => {},
-    onFailure: () => {},
-    onComment: () => {},
+    onSuccess() {},
+    onFailure() {},
+    onComment() {},
   });
 };
 

package/lib/plopfile.js

@@ -4,9 +4,10 @@ const pluralize = require('pluralize');
 
 const generateApi = require('./plops/api');
 const generateController = require('./plops/controller');
-const generateModel = require('./plops/model');
+const generateContentType = require('./plops/content-type');
 const generatePlugin = require('./plops/plugin');
 const generatePolicy = require('./plops/policy');
+const generateMiddleware = require('./plops/middleware');
 const generateService = require('./plops/service');
 
 module.exports = plop => {
@@ -17,8 +18,9 @@ module.exports = plop => {
   // Generators
   generateApi(plop);
   generateController(plop);
-  generateModel(plop);
+  generateContentType(plop);
   generatePlugin(plop);
   generatePolicy(plop);
+  generateMiddleware(plop);
   generateService(plop);
 };

package/lib/plops/api.js

@@ -25,7 +25,7 @@ module.exports = plop => {
         type: 'list',
         name: 'plugin',
         message: 'Plugin name',
-        choices: async () => {
+        async choices() {
           const pluginsPath = join(plop.getDestBasePath(), 'plugins');
           const exists = await fs.pathExists(pluginsPath);
 
@@ -43,30 +43,9 @@ module.exports = plop => {
           return pluginsDirContent;
         },
       },
-      {
-        type: 'list',
-        name: 'kind',
-        message: 'Please choose the model type',
-        default: 'collectionType',
-        choices: [
-          { name: 'Collection Type', value: 'collectionType' },
-          { name: 'Singe Type', value: 'singleType' },
-        ],
-      },
-      {
-        type: 'confirm',
-        name: 'useDraftAndPublish',
-        default: false,
-        message: 'Use draft and publish?',
-      },
     ],
-    actions: answers => {
-      let filePath;
-      if (answers.isPluginApi && answers.plugin) {
-        filePath = `plugins/{{plugin}}`;
-      } else {
-        filePath = `api/{{id}}`;
-      }
+    actions(answers) {
+      const filePath = answers.isPluginApi && answers.plugin ? 'plugins/{{plugin}}' : 'api/{{id}}';
 
       const baseActions = [
         {
@@ -74,11 +53,6 @@ module.exports = plop => {
           path: `${filePath}/controllers/{{id}}.js`,
           templateFile: 'templates/controller.js.hbs',
         },
-        {
-          type: 'add',
-          path: `${filePath}/content-types/{{id}}/schema.json`,
-          templateFile: 'templates/model.schema.json.hbs',
-        },
         {
           type: 'add',
           path: `${filePath}/services/{{id}}.js`,
@@ -90,16 +64,11 @@ module.exports = plop => {
         return baseActions;
       }
 
-      const routeType =
-        answers.kind === 'singleType'
-          ? 'single-type-routes.js.hbs'
-          : 'collection-type-routes.js.hbs';
-
       return [
         {
           type: 'add',
           path: `${filePath}/routes/{{id}}.js`,
-          templateFile: `templates/${routeType}`,
+          templateFile: `templates/single-route.js.hbs`,
         },
         ...baseActions,
       ];

package/lib/plops/content-type.js

@@ -0,0 +1,145 @@
+'use strict';
+
+const { join } = require('path');
+const slugify = require('@sindresorhus/slugify');
+const fs = require('fs-extra');
+const { isKebabCase } = require('@strapi/utils');
+
+const getDestinationPrompts = require('./prompts/get-destination-prompts');
+const getFilePath = require('./utils/get-file-path');
+const ctNamesPrompts = require('./prompts/ct-names-prompts');
+const kindPrompts = require('./prompts/kind-prompts');
+const draftAndPublishPrompts = require('./prompts/draft-and-publish-prompts');
+const getAttributesPrompts = require('./prompts/get-attributes-prompts');
+const bootstrapApiPrompts = require('./prompts/bootstrap-api-prompts');
+
+module.exports = plop => {
+  // Model generator
+  plop.setGenerator('content-type', {
+    description: 'Generate a content type for an API',
+    async prompts(inquirer) {
+      const config = await inquirer.prompt([
+        ...ctNamesPrompts,
+        ...kindPrompts,
+        ...draftAndPublishPrompts,
+      ]);
+      const attributes = await getAttributesPrompts(inquirer);
+
+      const api = await inquirer.prompt([
+        ...getDestinationPrompts('model', plop.getDestBasePath()),
+        {
+          when: answers => answers.destination === 'new',
+          type: 'input',
+          name: 'id',
+          default: config.singularName,
+          message: 'Name of the new API?',
+          async validate(input) {
+            if (!isKebabCase(input)) {
+              return 'Value must be in kebab-case';
+            }
+
+            const apiPath = join(plop.getDestBasePath(), 'api');
+            const exists = await fs.pathExists(apiPath);
+
+            if (!exists) {
+              return true;
+            }
+
+            const apiDir = await fs.readdir(apiPath, { withFileTypes: true });
+            const apiDirContent = apiDir.filter(fd => fd.isDirectory());
+
+            if (apiDirContent.findIndex(api => api.name === input) !== -1) {
+              throw new Error('This name is already taken.');
+            }
+
+            return true;
+          },
+        },
+        ...bootstrapApiPrompts,
+      ]);
+
+      return {
+        ...config,
+        ...api,
+        attributes,
+      };
+    },
+    actions(answers) {
+      const attributes = answers.attributes.reduce((object, answer) => {
+        const val = { type: answer.attributeType };
+
+        if (answer.attributeType === 'enumeration') {
+          val.enum = answer.enum.split(',').map(item => item.trim());
+        }
+
+        if (answer.attributeType === 'media') {
+          val.allowedTypes = ['images', 'files', 'videos'];
+          val.multiple = answer.multiple;
+        }
+
+        return Object.assign(object, { [answer.attributeName]: val }, {});
+      }, {});
+
+      const filePath = getFilePath(answers.destination);
+
+      const baseActions = [
+        {
+          type: 'add',
+          path: `${filePath}/content-types/{{ singularName }}/schema.json`,
+          templateFile: 'templates/content-type.schema.json.hbs',
+          data: {
+            collectionName: slugify(answers.pluralName, { separator: '_' }),
+          },
+        },
+      ];
+
+      if (attributes.lenght > 0) {
+        baseActions.push({
+          type: 'modify',
+          path: `${filePath}/content-types/{{ singularName }}/schema.json`,
+          transform(template) {
+            const parsedTemplate = JSON.parse(template);
+            parsedTemplate.attributes = attributes;
+            return JSON.stringify(parsedTemplate, null, 2);
+          },
+        });
+      }
+
+      if (answers.bootstrapApi) {
+        const { singularName } = answers;
+
+        let uid;
+        if (answers.destination === 'new') {
+          uid = `api::${answers.id}.${singularName}`;
+        } else if (answers.api) {
+          uid = `api::${answers.api}.${singularName}`;
+        } else if (answers.plugin) {
+          uid = `plugin::${answers.plugin}.${singularName}`;
+        }
+
+        baseActions.push(
+          {
+            type: 'add',
+            path: `${filePath}/controllers/{{singularName}}.js`,
+            templateFile: 'templates/core-controller.js.hbs',
+            data: { uid },
+          },
+          {
+            type: 'add',
+            path: `${filePath}/services/{{singularName}}.js`,
+            templateFile: 'templates/core-service.js.hbs',
+            data: { uid },
+          },
+          {
+            type: 'add',
+            path: `${filePath}/routes/{{singularName}}.js`,
+            templateFile: `templates/core-router.js.hbs`,
+            data: { uid },
+          }
+        );
+      }
+
+      return baseActions;
+    },
+  });
+};

package/lib/plops/controller.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const getDestinationPrompts = require('./utils/get-destination-prompts');
+const getDestinationPrompts = require('./prompts/get-destination-prompts');
 const getFilePath = require('./utils/get-file-path');
 const validateInput = require('./utils/validate-input');
 
@@ -17,13 +17,13 @@ module.exports = plop => {
       },
       ...getDestinationPrompts('controller', plop.getDestBasePath()),
     ],
-    actions: answers => {
+    actions(answers) {
       const filePath = getFilePath(answers.destination);
 
       return [
         {
           type: 'add',
-          path: `${filePath}/controllers/{{id}}.js`,
+          path: `${filePath}/controllers/{{ id }}.js`,
           templateFile: 'templates/controller.js.hbs',
         },
       ];

package/lib/plops/middleware.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const getDestinationPrompts = require('./prompts/get-destination-prompts');
+
+module.exports = plop => {
+  // middleware generator
+  plop.setGenerator('middleware', {
+    description: 'Generate a middleware for an API',
+    prompts: [
+      {
+        type: 'input',
+        name: 'name',
+        message: 'Middleware name',
+      },
+      ...getDestinationPrompts('middleware', plop.getDestBasePath(), { rootFolder: true }),
+    ],
+    actions(answers) {
+      let filePath;
+      if (answers.destination === 'api') {
+        filePath = `api/{{ api }}`;
+      } else if (answers.destination === 'plugin') {
+        filePath = `plugins/{{ plugin }}`;
+      } else {
+        filePath = `./`;
+      }
+
+      return [
+        {
+          type: 'add',
+          path: `${filePath}/middlewares/{{ name }}.js`,
+          templateFile: 'templates/middleware.js.hbs',
+        },
+      ];
+    },
+  });
+};

package/lib/plops/plugin.js

@@ -1,5 +1,28 @@
 'use strict';
 
+const chalk = require('chalk');
+
+const logInstructions = pluginName => {
+  const maxLength = `    resolve: './src/plugins/${pluginName}'`.length;
+  const separator = Array(maxLength)
+    .fill('─')
+    .join('');
+
+  return `
+You can now enable your plugin by adding the following in ${chalk.yellow('./config/plugins.js')}.
+${separator}
+module.exports = {
+  ${chalk.gray('// ...')}
+  ${chalk.green(`'${pluginName}'`)}: {
+    enabled: ${chalk.yellow(true)},
+    resolve: ${chalk.yellow(`'./src/plugins/${pluginName}'`)}
+  },
+  ${chalk.gray('// ...')}
+}
+${separator}
+`;
+};
+
 module.exports = plop => {
   // Plugin generator
   plop.setGenerator('plugin', {
@@ -7,43 +30,29 @@ module.exports = plop => {
     prompts: [
       {
         type: 'input',
-        name: 'id',
+        name: 'pluginName',
         message: 'Plugin name',
       },
     ],
-    actions: () => {
+    actions(answers) {
       return [
         {
           type: 'addMany',
-          destination: 'plugins/{{id}}/admin',
-          base: 'files/plugin/admin',
-          templateFiles: 'files/plugin/admin/**',
-        },
-        {
-          type: 'add',
-          path: 'plugins/{{id}}/services/{{id}}.js',
-          templateFile: 'templates/service.js.hbs',
-        },
-        {
-          type: 'add',
-          path: 'plugins/{{id}}/controllers/{{id}}.js',
-          templateFile: 'templates/controller.js.hbs',
-        },
-        {
-          type: 'add',
-          path: 'plugins/{{id}}/config/routes.json',
-          templateFile: 'templates/plugin-routes.json.hbs',
+          destination: 'plugins/{{ pluginName }}',
+          base: 'files/plugin',
+          templateFiles: 'files/plugin/**',
         },
         {
           type: 'add',
-          path: 'plugins/{{id}}/README.md',
+          path: 'plugins/{{ pluginName }}/README.md',
           templateFile: 'templates/README.md.hbs',
         },
         {
           type: 'add',
-          path: 'plugins/{{id}}/package.json',
+          path: 'plugins/{{ pluginName }}/package.json',
           templateFile: 'templates/plugin-package.json.hbs',
         },
+        () => plop.renderString(logInstructions(answers.pluginName)),
       ];
     },
   });

package/lib/plops/policy.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const getDestinationPrompts = require('./utils/get-destination-prompts');
+const getDestinationPrompts = require('./prompts/get-destination-prompts');
 
 module.exports = plop => {
   // Policy generator
@@ -12,9 +12,9 @@ module.exports = plop => {
         name: 'id',
         message: 'Policy name',
       },
-      ...getDestinationPrompts('policy', plop.getDestBasePath()),
+      ...getDestinationPrompts('policy', plop.getDestBasePath(), { rootFolder: true }),
     ],
-    actions: answers => {
+    actions(answers) {
       let filePath;
       if (answers.destination === 'api') {
         filePath = `api/{{api}}`;
@@ -27,7 +27,7 @@ module.exports = plop => {
       return [
         {
           type: 'add',
-          path: `${filePath}/config/policies/{{id}}.js`,
+          path: `${filePath}/policies/{{id}}.js`,
           templateFile: 'templates/policy.js.hbs',
         },
       ];

package/lib/plops/prompts/bootstrap-api-prompts.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = [
+  {
+    type: 'confirm',
+    name: 'bootstrapApi',
+    default: true,
+    message: 'Bootstrap API related files?',
+  },
+];

package/lib/plops/prompts/ct-names-prompts.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const pluralize = require('pluralize');
+const slugify = require('@sindresorhus/slugify');
+const { isKebabCase } = require('@strapi/utils');
+
+module.exports = [
+  {
+    type: 'input',
+    name: 'displayName',
+    message: 'Content type display name',
+    validate: input => !!input,
+  },
+  {
+    type: 'input',
+    name: 'singularName',
+    message: 'Content type singular name',
+    default: answers => slugify(answers.displayName),
+    validate(input) {
+      if (!isKebabCase(input)) {
+        return 'Value must be in kebab-case';
+      }
+
+      return true;
+    },
+  },
+  {
+    type: 'input',
+    name: 'pluralName',
+    message: 'Content type plural name',
+    default: answers => pluralize(answers.singularName),
+    validate(input, answers) {
+      if (answers.singularName === input) {
+        return 'Singular and plural names cannot be the same';
+      }
+
+      if (!isKebabCase(input)) {
+        return 'Value must be in kebab-case';
+      }
+
+      return true;
+    },
+  },
+];

package/lib/plops/prompts/draft-and-publish-prompts.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = [
+  {
+    type: 'confirm',
+    name: 'useDraftAndPublish',
+    default: false,
+    message: 'Use draft and publish?',
+  },
+];