@strapi/generators 4.10.1 → 4.10.2-alpha.0

package/lib/plops/plugin.js

@@ -1,91 +0,0 @@
-'use strict';
-
-const chalk = require('chalk');
-const { isUsingTypeScriptSync } = require('@strapi/typescript-utils');
-const { isKebabCase, toKebabCase } = require('@strapi/utils');
-
-const validateInput = require('./utils/validate-input');
-
-const LANGUAGES = {
-  javascript: 'JavaScript',
-  typescript: 'TypeScript',
-};
-
-const logInstructions = (pluginName, { language }) => {
-  const maxLength = `    resolve: './src/plugins/${pluginName}'`.length;
-  const separator = Array(maxLength).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}
-${exportInstruction} {
-  ${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', {
-    description: 'Generate a basic plugin',
-    prompts: [
-      {
-        type: 'input',
-        name: 'pluginName',
-        message: 'Plugin name',
-        validate: (input) => validateInput(input),
-      },
-      {
-        type: 'list',
-        name: 'language',
-        message: 'Choose your preferred language',
-        choices: Object.values(LANGUAGES),
-        default: LANGUAGES.javascript,
-      },
-    ],
-    actions(answers) {
-      const isTypescript = answers.language === LANGUAGES.typescript;
-      const language = isTypescript ? 'ts' : 'js';
-      const projectLanguage = isUsingTypeScriptSync(process.cwd()) ? 'ts' : 'js';
-
-      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 [
-        {
-          type: 'addMany',
-          destination: 'plugins/{{ pluginName }}',
-          base: `files/${language}/plugin`,
-          templateFiles: `files/${language}/plugin/**`,
-        },
-        {
-          type: 'add',
-          path: 'plugins/{{ pluginName }}/README.md',
-          templateFile: `templates/${language}/README.md.hbs`,
-        },
-        {
-          type: 'add',
-          path: 'plugins/{{ pluginName }}/package.json',
-          templateFile: `templates/${language}/plugin-package.json.hbs`,
-        },
-        () => plop.renderString(logInstructions(answers.pluginName, { language: projectLanguage })),
-      ];
-    },
-  });
-};

package/lib/plops/policy.js

@@ -1,36 +0,0 @@
-'use strict';
-
-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) => {
-  // Policy generator
-  plop.setGenerator('policy', {
-    description: 'Generate a policy for an API',
-    prompts: [
-      {
-        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.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/policies/{{ id }}.${language}`,
-          templateFile: `templates/${language}/policy.${language}.hbs`,
-        },
-      ];
-    },
-  });
-};

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

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

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

@@ -1,44 +0,0 @@
-'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

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

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

@@ -1,105 +0,0 @@
-'use strict';
-
-const validateAttributeInput = require('../utils/validate-attribute-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) => validateAttributeInput(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/prompts/get-destination-prompts.js

@@ -1,79 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const fs = require('fs-extra');
-
-module.exports = (action, basePath, { rootFolder = false } = {}) => {
-  return [
-    {
-      type: 'list',
-      name: 'destination',
-      message: `Where do you want to add this ${action}?`,
-      choices: [
-        ...(rootFolder
-          ? [
-              {
-                name: `Add ${action} to root of project`,
-                value: 'root',
-              },
-            ]
-          : [
-              {
-                name: `Add ${action} to new API`,
-                value: 'new',
-              },
-            ]),
-        { name: `Add ${action} to an existing API`, value: 'api' },
-        { name: `Add ${action} to an existing plugin`, value: 'plugin' },
-      ],
-    },
-    {
-      when: (answers) => answers.destination === 'api',
-      type: 'list',
-      message: 'Which API is this for?',
-      name: 'api',
-      async choices() {
-        const apiPath = join(basePath, 'api');
-        const exists = await fs.pathExists(apiPath);
-
-        if (!exists) {
-          throw Error('Couldn\'t find an "api" directory');
-        }
-
-        const apiDir = await fs.readdir(apiPath, { withFileTypes: true });
-        const apiDirContent = apiDir.filter((fd) => fd.isDirectory());
-
-        if (apiDirContent.length === 0) {
-          throw Error('The "api" directory is empty');
-        }
-
-        return apiDirContent;
-      },
-    },
-    {
-      when: (answers) => answers.destination === 'plugin',
-      type: 'list',
-      message: 'Which plugin is this for?',
-      name: 'plugin',
-      async choices() {
-        const pluginsPath = join(basePath, 'plugins');
-        const exists = await fs.pathExists(pluginsPath);
-
-        if (!exists) {
-          throw Error('Couldn\'t find a "plugins" directory');
-        }
-
-        const pluginsDir = await fs.readdir(pluginsPath);
-        const pluginsDirContent = pluginsDir.filter((api) =>
-          fs.lstatSync(join(pluginsPath, api)).isDirectory()
-        );
-
-        if (pluginsDirContent.length === 0) {
-          throw Error('The "plugins" directory is empty');
-        }
-
-        return pluginsDirContent;
-      },
-    },
-  ];
-};

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

@@ -1,17 +0,0 @@
-'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,34 +0,0 @@
-'use strict';
-
-const tsUtils = require('@strapi/typescript-utils');
-
-const getDestinationPrompts = require('./prompts/get-destination-prompts');
-const getFilePath = require('./utils/get-file-path');
-
-module.exports = (plop) => {
-  // Service generator
-  plop.setGenerator('service', {
-    description: 'Generate a service for an API',
-    prompts: [
-      {
-        type: 'input',
-        name: 'id',
-        message: 'Service name',
-      },
-      ...getDestinationPrompts('service', plop.getDestBasePath()),
-    ],
-    actions(answers) {
-      const filePath = getFilePath(answers.destination);
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/services/{{ id }}.${language}`,
-          templateFile: `templates/${language}/service.${language}.hbs`,
-        },
-      ];
-    },
-  });
-};

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

@@ -1,25 +0,0 @@
-'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/plops/utils/get-file-path.js

@@ -1,17 +0,0 @@
-'use strict';
-
-module.exports = (destination) => {
-  if (destination === 'api') {
-    return `api/{{ api }}`;
-  }
-
-  if (destination === 'plugin') {
-    return `plugins/{{ plugin }}/server`;
-  }
-
-  if (destination === 'root') {
-    return './';
-  }
-
-  return `api/{{ id }}`;
-};

package/lib/plops/utils/get-formatted-date.js

@@ -1,8 +0,0 @@
-'use strict';
-
-module.exports = (date = new Date()) => {
-  return new Date(date.getTime() - date.getTimezoneOffset() * 60000)
-    .toJSON()
-    .replace(/[-:]/g, '.')
-    .replace(/\....Z/, '');
-};

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

@@ -1,11 +0,0 @@
-'use strict';
-
-module.exports = (input) => {
-  const regex = /^[A-Za-z-|_]+$/g;
-
-  if (!input) {
-    return 'You must provide an input';
-  }
-
-  return regex.test(input) || "Please use only letters, '-', '_',  and no spaces";
-};

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

@@ -1,11 +0,0 @@
-'use strict';
-
-module.exports = (input) => {
-  const regex = /^[A-Za-z-_0-9]+$/g;
-
-  if (!input) {
-    return 'You must provide an input';
-  }
-
-  return regex.test(input) || "Please use only letters and number, '-' or '_' and no spaces";
-};

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

@@ -1,11 +0,0 @@
-'use strict';
-
-module.exports = (input) => {
-  const regex = /^[A-Za-z-]+$/g;
-
-  if (!input) {
-    return 'You must provide an input';
-  }
-
-  return regex.test(input) || "Please use only letters, '-' and no spaces";
-};