@strapi/generators 4.2.0-beta.0 → 4.2.0-beta.3

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

@@ -1,5 +1,5 @@
-const pluginPkg = require('../../package.json');
+import pluginPkg from '../../package.json';
 
 const pluginId = pluginPkg.name.replace(/^(@[^-,.][\w,-]+\/|strapi-)plugin-/i, '');
 
-module.exports = pluginId;
+export default pluginId;

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

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

package/lib/files/ts/plugin/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "extends": "@strapi/typescript-utils/lib/configs/server",
+
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "."
+  },
+
+  "include": [
+    // Include the root directory
+    "server",
+    // Force the JSON files in the src folder to be included
+    "server/**/*.json"
+  ],
+
+  "exclude": [
+    "node_modules/",
+    "dist/",
+
+    // Do not include admin files in the server compilation
+    "admin/",
+    // Do not include test files
+    "**/*.test.ts"
+  ]
+}

package/lib/plops/api.js

@@ -49,7 +49,7 @@ module.exports = plop => {
     actions(answers) {
       const filePath = answers.isPluginApi && answers.plugin ? 'plugins/{{plugin}}' : 'api/{{id}}';
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       const baseActions = [
         {

package/lib/plops/content-type.js

@@ -83,7 +83,7 @@ module.exports = plop => {
 
       const filePath = getFilePath(answers.destination);
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       const baseActions = [
         {

package/lib/plops/controller.js

@@ -22,7 +22,7 @@ module.exports = plop => {
     actions(answers) {
       const filePath = getFilePath(answers.destination);
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       return [
         {

package/lib/plops/middleware.js

@@ -3,6 +3,7 @@
 const tsUtils = require('@strapi/typescript-utils');
 
 const getDestinationPrompts = require('./prompts/get-destination-prompts');
+const validateInput = require('./utils/validate-input');
 const getFilePath = require('./utils/get-file-path');
 
 module.exports = plop => {
@@ -14,13 +15,14 @@ module.exports = plop => {
         type: 'input',
         name: 'name',
         message: 'Middleware name',
+        validate: input => validateInput(input),
       },
       ...getDestinationPrompts('middleware', plop.getDestBasePath(), { rootFolder: true }),
     ],
     actions(answers) {
       const filePath = getFilePath(answers.destination);
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       return [
         {

package/lib/plops/plugin.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const chalk = require('chalk');
-const tsUtils = require('@strapi/typescript-utils');
+const { isUsingTypeScriptSync } = require('@strapi/typescript-utils');
+const { isKebabCase, toKebabCase } = require('@strapi/utils');
+
+const validateInput = require('./utils/validate-input');
 
 const logInstructions = (pluginName, { language }) => {
   const maxLength = `    resolve: './src/plugins/${pluginName}'`.length;
@@ -9,12 +12,14 @@ const logInstructions = (pluginName, { language }) => {
     .fill('─')
     .join('');
 
+  const exportInstruction = language === 'js' ? 'module.exports =' : 'export default';
+
   return `
 You can now enable your plugin by adding the following in ${chalk.yellow(
     `./config/plugins.${language}`
   )}
 ${separator}
-module.exports = {
+${exportInstruction} {
   ${chalk.gray('// ...')}
   ${chalk.green(`'${pluginName}'`)}: {
     enabled: ${chalk.yellow(true)},
@@ -35,13 +40,29 @@ module.exports = plop => {
         type: 'input',
         name: 'pluginName',
         message: 'Plugin name',
+        validate: input => validateInput(input),
+      },
+      {
+        type: 'list',
+        name: 'language',
+        message: 'Choose your preferred language',
+        choices: ['Javascript', 'Typescript'],
+        default: 'Javascript',
       },
     ],
     actions(answers) {
-      const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const isTypescript = answers.language === 'Typescript';
+      const language = isTypescript ? 'ts' : 'js';
+      const projectLanguage = isUsingTypeScriptSync(process.cwd()) ? 'ts' : 'js';
 
-      // TODO: Adds tsconfig & build command for TS plugins?
+      if (!isKebabCase(answers.pluginName)) {
+        answers.pluginName = toKebabCase(answers.pluginName);
+        console.log(
+          chalk.yellow(
+            `Strapi only supports kebab-cased names for plugins.\nYour plugin has been automatically renamed to "${answers.pluginName}".`
+          )
+        );
+      }
 
       return [
         {
@@ -60,7 +81,7 @@ module.exports = plop => {
           path: 'plugins/{{ pluginName }}/package.json',
           templateFile: `templates/${language}/plugin-package.json.hbs`,
         },
-        () => plop.renderString(logInstructions(answers.pluginName, { language })),
+        () => plop.renderString(logInstructions(answers.pluginName, { language: projectLanguage })),
       ];
     },
   });

package/lib/plops/policy.js

@@ -3,6 +3,7 @@
 const tsUtils = require('@strapi/typescript-utils');
 
 const getDestinationPrompts = require('./prompts/get-destination-prompts');
+const validateInput = require('./utils/validate-input');
 const getFilePath = require('./utils/get-file-path');
 
 module.exports = plop => {
@@ -14,13 +15,14 @@ module.exports = plop => {
         type: 'input',
         name: 'id',
         message: 'Policy name',
+        validate: input => validateInput(input),
       },
       ...getDestinationPrompts('policy', plop.getDestBasePath(), { rootFolder: true }),
     ],
     actions(answers) {
       const filePath = getFilePath(answers.destination);
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       return [
         {

package/lib/plops/service.js

@@ -20,7 +20,7 @@ module.exports = plop => {
     actions(answers) {
       const filePath = getFilePath(answers.destination);
       const currentDir = process.cwd();
-      const language = tsUtils.isTypeScriptProjectSync(currentDir) ? 'ts' : 'js';
+      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
 
       return [
         {

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

@@ -0,0 +1,25 @@
+'use strict';
+
+const getFilePath = require('../get-file-path');
+
+describe('Get-File-Path util', () => {
+  test('with destination set as api', () => {
+    const filePath = getFilePath('api');
+    expect(filePath).toBe(`api/{{ api }}`);
+  });
+
+  test('with destination set as plugin', () => {
+    const filePath = getFilePath('plugin');
+    expect(filePath).toBe(`plugins/{{ plugin }}/server`);
+  });
+
+  test('with destination set as root', () => {
+    const filePath = getFilePath('root');
+    expect(filePath).toBe(`./`);
+  });
+
+  test('with empty destination string', () => {
+    const filePath = getFilePath('');
+    expect(filePath).toBe(`api/{{ id }}`);
+  });
+});

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

@@ -4,8 +4,9 @@
   "description": "This is the description of the plugin.",
   "strapi": {
     "name": "{{ pluginName }}",
-    "description": "Description of {{ pluginName }} plugin",
-    "kind": "plugin"
+    "description": "Description of {{titleCase pluginName }} plugin",
+    "kind": "plugin",
+    "displayName": "{{titleCase pluginName }}"
   },
   "dependencies": {},
   "author": {

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

@@ -8,6 +8,10 @@
     "kind": "plugin"
   },
   "dependencies": {},
+  "devDependencies": {
+    "typescript": "4.6.3",
+    "@strapi/strapi": "4.1.8"
+  },
   "author": {
     "name": "A Strapi developer"
   },
@@ -20,5 +24,9 @@
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
+  "scripts": {
+    "develop": "tsc -w",
+    "build": "tsc"
+  },
   "license": "MIT"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/generators",
-  "version": "4.2.0-beta.0",
+  "version": "4.2.0-beta.3",
   "description": "Interactive API generator.",
   "keywords": [
     "strapi",
@@ -30,8 +30,8 @@
   "main": "lib/index.js",
   "dependencies": {
     "@sindresorhus/slugify": "1.1.0",
-    "@strapi/typescript-utils": "4.2.0-beta.0",
-    "@strapi/utils": "4.2.0-beta.0",
+    "@strapi/typescript-utils": "4.2.0-beta.3",
+    "@strapi/utils": "4.2.0-beta.3",
     "chalk": "4.1.2",
     "fs-extra": "10.0.0",
     "node-plop": "0.26.3",
@@ -42,5 +42,5 @@
     "node": ">=12.22.0 <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "db70f0de7cc73fb469c8a076b89530729cf14142"
+  "gitHead": "c4addbad6ecbc8ef7633bbba3806f3b0a2ae5f49"
 }