@strapi/generators 4.0.0-next.20 → 4.0.2

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');
 
@@ -23,7 +23,7 @@ module.exports = plop => {
       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,7 +12,7 @@ module.exports = plop => {
         name: 'id',
         message: 'Policy name',
       },
-      ...getDestinationPrompts('policy', plop.getDestBasePath()),
+      ...getDestinationPrompts('policy', plop.getDestBasePath(), { rootFolder: true }),
     ],
     actions(answers) {
       let filePath;

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?',
+  },
+];

package/lib/plops/prompts/get-attributes-prompts.js

@@ -0,0 +1,102 @@
+'use strict';
+
+const validateInput = require('../utils/validate-input');
+
+const DEFAULT_TYPES = [
+  // advanced types
+  'media',
+
+  // scalar types
+  'string',
+  'text',
+  'richtext',
+  'json',
+  'enumeration',
+  'password',
+  'email',
+  'integer',
+  'biginteger',
+  'float',
+  'decimal',
+  'date',
+  'time',
+  'datetime',
+  'timestamp',
+  'boolean',
+];
+
+/**
+ * @param {import('inquirer').Inquirer} inquirer
+ * @returns {Promise<Record<string, string>[]>}
+ */
+module.exports = async inquirer => {
+  const { addAttributes } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'addAttributes',
+      message: 'Do you want to add attributes?',
+    },
+  ]);
+
+  const attributes = [];
+
+  /**
+   * @param {import('inquirer').Inquirer} inquirer
+   * @returns {Promise<void>}
+   */
+  const createNewAttributes = async inquirer => {
+    const answers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'attributeName',
+        message: 'Name of attribute',
+        validate: input => validateInput(input),
+      },
+      {
+        type: 'list',
+        name: 'attributeType',
+        message: 'What type of attribute',
+        pageSize: DEFAULT_TYPES.length,
+        choices: DEFAULT_TYPES.map(type => {
+          return { name: type, value: type };
+        }),
+      },
+      {
+        when: answers => answers.attributeType === 'enumeration',
+        type: 'input',
+        name: 'enum',
+        message: 'Add values separated by a comma',
+      },
+      {
+        when: answers => answers.attributeType === 'media',
+        type: 'list',
+        name: 'multiple',
+        message: 'Choose media type',
+        choices: [{ name: 'Multiple', value: true }, { name: 'Single', value: false }],
+      },
+      {
+        type: 'confirm',
+        name: 'addAttributes',
+        message: 'Do you want to add another attribute?',
+      },
+    ]);
+
+    attributes.push(answers);
+
+    if (!answers.addAttributes) {
+      return;
+    }
+
+    await createNewAttributes(inquirer);
+  };
+
+  if (addAttributes) {
+    await createNewAttributes(inquirer);
+  } else {
+    console.warn(
+      `You won't be able to manage entries from the admin, you can still add attributes later from the content type builder.`
+    );
+  }
+
+  return attributes;
+};

package/lib/plops/{utils → prompts}/get-destination-prompts.js

@@ -2,7 +2,7 @@
 const { join } = require('path');
 const fs = require('fs-extra');
 
-module.exports = (action, basePath) => {
+module.exports = (action, basePath, { rootFolder = false } = {}) => {
   return [
     {
       type: 'list',
@@ -10,7 +10,7 @@ module.exports = (action, basePath) => {
       message: `Where do you want to add this ${action}?`,
       choices: [
         {
-          name: `Add ${action} to ${action === 'policy' ? 'root of project' : 'new API'}`,
+          name: `Add ${action} to ${rootFolder ? 'root of project' : 'new API'}`,
           value: 'new',
         },
         { name: `Add ${action} to an existing API`, value: 'api' },

package/lib/plops/prompts/kind-prompts.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const validateInput = require('../utils/validate-input');
+
+module.exports = [
+  {
+    type: 'list',
+    name: 'kind',
+    message: 'Please choose the model type',
+    default: 'collectionType',
+    choices: [
+      { name: 'Collection Type', value: 'collectionType' },
+      { name: 'Single Type', value: 'singleType' },
+    ],
+    validate: input => validateInput(input),
+  },
+];

package/lib/plops/service.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');
 
 module.exports = plop => {
@@ -20,7 +20,7 @@ module.exports = plop => {
       return [
         {
           type: 'add',
-          path: `${filePath}/services/{{id}}.js`,
+          path: `${filePath}/services/{{ id }}.js`,
           templateFile: 'templates/service.js.hbs',
         },
       ];

package/lib/plops/utils/get-file-path.js

@@ -2,12 +2,12 @@
 
 module.exports = destination => {
   if (destination === 'api') {
-    return `api/{{api}}`;
+    return `api/{{ api }}`;
   }
 
   if (destination === 'plugin') {
-    return `plugins/{{plugin}}`;
+    return `plugins/{{ plugin }}`;
   }
 
-  return `api/{{id}}`;
+  return `api/{{ id }}`;
 };

package/lib/plops/utils/validate-input.js

@@ -7,5 +7,5 @@ module.exports = input => {
     return 'You must provide an input';
   }
 
-  return regex.test(input) || 'Please use only letters and no spaces';
+  return regex.test(input) || "Please use only letters, '-' and no spaces";
 };

package/lib/templates/README.md.hbs

@@ -1,3 +1,3 @@
-# Strapi plugin {{id}}
+# Strapi plugin {{ pluginName }}
 
-A quick description of {{id}}.
+A quick description of {{ pluginName }}.

package/lib/templates/collection-type-routes.js.hbs

@@ -6,6 +6,7 @@ module.exports = {
       handler: '{{id}}.find',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -14,6 +15,7 @@ module.exports = {
       handler: '{{id}}.findOne',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -22,6 +24,7 @@ module.exports = {
       handler: '{{id}}.create',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -30,6 +33,7 @@ module.exports = {
       handler: '{{id}}.update',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -38,6 +42,7 @@ module.exports = {
       handler: '{{id}}.delete',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
   ],

package/lib/templates/content-type.schema.json.hbs

@@ -0,0 +1,15 @@
+
+{
+  "kind": "{{kind}}",
+  "collectionName": "{{ collectionName }}",
+  "info": {
+    "singularName": "{{ singularName }}",
+    "pluralName": "{{ pluralName }}",
+    "displayName": "{{ displayName }}"
+  },
+  "options": {
+    "draftAndPublish": {{ useDraftAndPublish }},
+    "comment": ""
+  },
+  "attributes": {}
+}

package/lib/templates/core-controller.js.hbs

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ *  {{ id }} controller
+ */
+
+const { createCoreController } = require('@strapi/strapi').factories;
+
+module.exports = createCoreController('{{ uid }}');

package/lib/templates/core-router.js.hbs

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * {{ id }} router.
+ */
+
+const { createCoreRouter } = require('@strapi/strapi').factories;
+
+module.exports = createCoreRouter('{{ uid }}');

package/lib/templates/core-service.js.hbs

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * {{ id }} service.
+ */
+
+const { createCoreService } = require('@strapi/strapi').factories;
+
+module.exports = createCoreService('{{ uid }}');

package/lib/templates/middleware.js.hbs

@@ -0,0 +1,14 @@
+'use strict';
+
+/**
+ * `{{ name }}` middleware.
+ */
+
+module.exports = (config, { strapi }) => {
+  // Add your own logic here.
+  return async (ctx, next) => {
+    strapi.log.info('In {{ name }} middleware.');
+
+    await next();
+  };
+};

package/lib/templates/plugin-package.json.hbs

@@ -1,23 +1,19 @@
 {
-  "name": "strapi-plugin-{{id}}",
+  "name": "{{ pluginName }}",
   "version": "0.0.0",
   "description": "This is the description of the plugin.",
   "strapi": {
-    "name": "{{id}}",
-    "icon": "plug",
-    "description": "Description of {{id}} plugin."
+    "name": "{{ pluginName }}",
+    "description": "Description of {{ pluginName }} plugin",
+    "kind": "plugin"
   },
   "dependencies": {},
   "author": {
-    "name": "A Strapi developer",
-    "email": "",
-    "url": ""
+    "name": "A Strapi developer"
   },
   "maintainers": [
     {
-      "name": "A Strapi developer",
-      "email": "",
-      "url": ""
+      "name": "A Strapi developer"
     }
   ],
   "engines": {

package/lib/templates/policy.js.hbs

@@ -4,15 +4,15 @@
  * `{{id}}` policy.
  */
 
-module.exports = async (ctx) => {
-  // Add your own logic here.
-  console.log('In {{id}} policy.');
+module.exports = (policyContext, config, { strapi }) => {
+    // Add your own logic here.
+    strapi.log.info('In {{id}} policy.');
 
-  const canDoSomething = true;
+    const canDoSomething = true;
 
-  if (canDoSomething) {
-    return true;
-  }
+    if (canDoSomething) {
+      return true;
+    }
 
-  return false;
+    return false;
 };

package/lib/templates/single-route.js.hbs

@@ -0,0 +1,13 @@
+module.exports = {
+  routes: [
+    // {
+    //  method: 'GET',
+    //  path: '/{{id}}',
+    //  handler: '{{id}}.exampleAction',
+    //  config: {
+    //    policies: [],
+    //    middlewares: [],
+    //  },
+    // },
+  ],
+};

package/lib/templates/single-type-routes.js.hbs

@@ -6,6 +6,7 @@ module.exports = {
       handler: '{{id}}.find',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -14,6 +15,7 @@ module.exports = {
       handler: '{{id}}.update',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
     {
@@ -22,6 +24,7 @@ module.exports = {
       handler: '{{id}}.delete',
       config: {
         policies: [],
+        middlewares: [],
       },
     },
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/generators",
-  "version": "4.0.0-next.20",
+  "version": "4.0.2",
   "description": "Interactive API generator.",
   "keywords": [
     "strapi",
@@ -16,27 +16,30 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "author": {
-    "name": "Strapi team",
+    "name": "Strapi Solutions SAS",
     "email": "hi@strapi.io",
     "url": "https://strapi.io"
   },
   "maintainers": [
     {
-      "name": "Strapi team",
+      "name": "Strapi Solutions SAS",
       "email": "hi@strapi.io",
       "url": "https://strapi.io"
     }
   ],
   "main": "lib/index.js",
   "dependencies": {
+    "@sindresorhus/slugify": "1.1.0",
+    "@strapi/utils": "4.0.2",
+    "chalk": "4.1.2",
     "fs-extra": "10.0.0",
-    "node-plop": "0.26.2",
-    "plop": "2.7.4",
+    "node-plop": "0.26.3",
+    "plop": "2.7.6",
     "pluralize": "8.0.0"
   },
   "engines": {
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "9807c78cb7ab6373b7abb46da5ecc4980a9ea56c"
+  "gitHead": "fd656a47698e0a33aae42abd4330410c8cba1d08"
 }

package/lib/templates/model.schema.json.hbs

@@ -1,16 +0,0 @@
-
-{
-  "kind": "{{kind}}",
-  "collectionName": "{{id}}",
-  "info": {
-    "singularName": "{{id}}",
-    "pluralName": "{{pluralize id}}",
-    "displayName": "{{id}}",
-    "name": "{{id}}"
-  },
-  "options": {
-    "draftAndPublish": {{ useDraftAndPublish }},
-    "comment": ""
-  },
-  "attributes": {}
-}