@strapi/generators 4.10.1-experimental.0 → 4.10.2-alpha.0

package/lib/files/ts/plugin/admin/src/index.tsx

@@ -1,67 +0,0 @@
-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 name = pluginPkg.strapi.name;
-
-export default {
-  register(app: any) {
-    app.addMenuLink({
-      to: `/plugins/${pluginId}`,
-      icon: PluginIcon,
-      intlLabel: {
-        id: `${pluginId}.plugin.name`,
-        defaultMessage: name,
-      },
-      Component: async () => {
-        const component = await import(/* webpackChunkName: "[request]" */ './pages/App');
-
-        return component;
-      },
-      permissions: [
-        // Uncomment to set the permissions of the plugin here
-        // {
-        //   action: '', // the action name should be plugin::plugin-name.actionType
-        //   subject: null,
-        // },
-      ],
-    });
-    const plugin = {
-      id: pluginId,
-      initializer: Initializer,
-      isReady: false,
-      name,
-    };
-
-    app.registerPlugin(plugin);
-  },
-
-  bootstrap(app: any) {},
-
-  async registerTrads(app: any) {
-    const { locales } = app;
-
-    const importedTrads = await Promise.all(
-      (locales as any[]).map((locale) => {
-        return import(`./translations/${locale}.json`)
-          .then(({ default: data }) => {
-            return {
-              data: prefixPluginTranslations(data, pluginId),
-              locale,
-            };
-          })
-          .catch(() => {
-            return {
-              data: {},
-              locale,
-            };
-          });
-      })
-    );
-
-    return Promise.resolve(importedTrads);
-  },
-};

package/lib/files/ts/plugin/admin/src/pages/App/index.tsx

@@ -1,25 +0,0 @@
-/**
- *
- * This component is the skeleton around the actual pages, and should only
- * contain code that should be seen on all pages. (e.g. navigation bar)
- *
- */
-
-import React from 'react';
-import { Switch, Route } from 'react-router-dom';
-import { AnErrorOccurred } from '@strapi/helper-plugin';
-import pluginId from '../../pluginId';
-import HomePage from '../HomePage';
-
-const App = () => {
-  return (
-    <div>
-      <Switch>
-        <Route path={`/plugins/${pluginId}`} component={HomePage} exact />
-        <Route component={AnErrorOccurred} />
-      </Switch>
-    </div>
-  );
-};
-
-export default App;

package/lib/files/ts/plugin/admin/src/pages/HomePage/index.tsx

@@ -1,19 +0,0 @@
-/*
- *
- * HomePage
- *
- */
-
-import React from 'react';
-import pluginId from '../../pluginId';
-
-const HomePage = () => {
-  return (
-    <div>
-      <h1>{pluginId}&apos;s HomePage</h1>
-      <p>Happy coding</p>
-    </div>
-  );
-};
-
-export default HomePage;

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

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

package/lib/files/ts/plugin/admin/src/translations/en.json

@@ -1 +0,0 @@
-{}

package/lib/files/ts/plugin/admin/src/translations/fr.json

@@ -1 +0,0 @@
-{}

package/lib/files/ts/plugin/admin/src/utils/getTrad.ts

@@ -1,5 +0,0 @@
-import pluginId from '../pluginId';
-
-const getTrad = (id: string) => `${pluginId}.${id}`;
-
-export default getTrad;

package/lib/files/ts/plugin/custom.d.ts

@@ -1,5 +0,0 @@
-declare module '@strapi/design-system/*';
-declare module '@strapi/design-system';
-declare module '@strapi/icons';
-declare module '@strapi/icons/*';
-declare module '@strapi/helper-plugin';

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

@@ -1,5 +0,0 @@
-import { Strapi } from '@strapi/strapi';
-
-export default ({ strapi }: { strapi: Strapi }) => {
-  // bootstrap phase
-};

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

@@ -1,4 +0,0 @@
-export default {
-  default: {},
-  validator() {},
-};

package/lib/files/ts/plugin/server/content-types/index.ts

@@ -1 +0,0 @@
-export default {};

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

@@ -1,5 +0,0 @@
-import myController from './my-controller';
-
-export default {
-  myController,
-};

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

@@ -1,10 +0,0 @@
-import { Strapi } from '@strapi/strapi';
-
-export default ({ strapi }: { strapi: Strapi }) => ({
-  index(ctx) {
-    ctx.body = strapi
-      .plugin('{{ pluginName }}')
-      .service('myService')
-      .getWelcomeMessage();
-  },
-});

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

@@ -1,5 +0,0 @@
-import { Strapi } from '@strapi/strapi';
-
-export default ({ strapi }: { strapi: Strapi }) => {
-  // destroy phase
-};

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

@@ -1,23 +0,0 @@
-import register from './register';
-import bootstrap from './bootstrap';
-import destroy from './destroy';
-import config from './config';
-import contentTypes from './content-types';
-import controllers from './controllers';
-import routes from './routes';
-import middlewares from './middlewares';
-import policies from './policies';
-import services from './services';
-
-export default {
-  register,
-  bootstrap,
-  destroy,
-  config,
-  controllers,
-  routes,
-  services,
-  contentTypes,
-  policies,
-  middlewares,
-};

package/lib/files/ts/plugin/server/middlewares/index.ts

@@ -1 +0,0 @@
-export default {};

package/lib/files/ts/plugin/server/policies/index.ts

@@ -1 +0,0 @@
-export default {};

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

@@ -1,5 +0,0 @@
-import { Strapi } from '@strapi/strapi';
-
-export default ({ strapi }: { strapi: Strapi }) => {
-  // registeration phase
-};

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

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

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

@@ -1,5 +0,0 @@
-import myService from './my-service';
-
-export default {
-  myService,
-};

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

@@ -1,7 +0,0 @@
-import { Strapi } from '@strapi/strapi';
-
-export default ({ strapi }: { strapi: Strapi }) => ({
-  getWelcomeMessage() {
-    return 'Welcome to Strapi 🚀';
-  },
-});

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

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

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

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

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

@@ -1,20 +0,0 @@
-{
-  "extends": "@strapi/typescript-utils/tsconfigs/admin",
-
-  "compilerOptions": {
-    "target": "ESNext",
-    "strict": true
-  },
-
-  "include": ["admin", "custom.d.ts"],
-
-  "exclude": [
-    "node_modules/",
-    "dist/",
-
-    // Do not include server files in the server compilation
-    "server/",
-    // Do not include test files
-    "**/*.test.ts"
-  ]
-}

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

@@ -1,25 +0,0 @@
-{
-  "extends": "@strapi/typescript-utils/tsconfigs/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/index.js

@@ -1,37 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const { Plop, run } = require('plop');
-const nodePlop = require('node-plop');
-
-/**
- * Starts the Plop CLI programmatically
- */
-const runCLI = () => {
-  Plop.launch({ configPath: join(__dirname, 'plopfile.js') }, (env) =>
-    run({ ...env, dest: join(process.cwd(), 'src') }, undefined, true)
-  );
-};
-
-/**
- * Runs a generator programmatically without prompts
- * @param {string} generatorName
- * @param {Object} options generator options replacing the prompts answers
- * @param {Object} plopOptions
- * @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: join(dir, 'src') });
-
-  const generator = plop.getGenerator(generatorName);
-  await generator.runActions(options, {
-    onSuccess() {},
-    onFailure() {},
-    onComment() {},
-  });
-};
-
-module.exports = {
-  generate,
-  runCLI,
-};

package/lib/plopfile.js

@@ -1,28 +0,0 @@
-'use strict';
-
-const pluralize = require('pluralize');
-
-const generateApi = require('./plops/api');
-const generateController = require('./plops/controller');
-const generateContentType = require('./plops/content-type');
-const generatePlugin = require('./plops/plugin');
-const generatePolicy = require('./plops/policy');
-const generateMiddleware = require('./plops/middleware');
-const generateMigration = require('./plops/migration');
-const generateService = require('./plops/service');
-
-module.exports = (plop) => {
-  // Plop config
-  plop.setWelcomeMessage('Strapi Generators');
-  plop.addHelper('pluralize', (text) => pluralize(text));
-
-  // Generators
-  generateApi(plop);
-  generateController(plop);
-  generateContentType(plop);
-  generatePlugin(plop);
-  generatePolicy(plop);
-  generateMiddleware(plop);
-  generateMigration(plop);
-  generateService(plop);
-};

package/lib/plops/__tests__/content-type.test.js

@@ -1,179 +0,0 @@
-'use strict';
-
-const path = require('path');
-const { readFile, remove, stat } = require('fs-extra');
-const strapiGenerators = require('../../index');
-
-describe('Content Type Generator', () => {
-  const outputDirectory = path.join(__dirname, 'output');
-
-  afterEach(async () => {
-    await remove(outputDirectory);
-  });
-
-  test('it generates the schema', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: false,
-        attributes: [],
-      },
-      { dir: outputDirectory }
-    );
-
-    const generatedSchemaPath = path.join(
-      outputDirectory,
-      'src/api/testContentType',
-      'content-types/testContentType/schema.json'
-    );
-
-    expect((await stat(generatedSchemaPath)).isFile()).toBeTruthy();
-
-    const fileContent = await readFile(generatedSchemaPath, 'utf-8');
-
-    expect(fileContent).not.toBeNull();
-
-    const schema = JSON.parse(fileContent.toString());
-
-    expect(schema).toStrictEqual({
-      kind: 'singleType',
-      collectionName: 'test_content_types',
-      info: {
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        displayName: 'testContentType',
-      },
-      options: {
-        draftAndPublish: false,
-        comment: '',
-      },
-      attributes: {},
-    });
-  });
-
-  test('it scaffolds a new API', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: true,
-        attributes: [],
-      },
-      { dir: outputDirectory }
-    );
-    const generatedApiPath = path.join(outputDirectory, 'src/api/testContentType');
-
-    expect((await stat(generatedApiPath)).isDirectory()).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'controllers/testContentType.js'))).isFile()
-    ).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'services/testContentType.js'))).isFile()
-    ).toBeTruthy();
-    expect(
-      (await stat(path.join(generatedApiPath, 'routes/testContentType.js'))).isFile()
-    ).toBeTruthy();
-
-    const controller = await readFile(
-      path.join(generatedApiPath, 'controllers/testContentType.js')
-    );
-    const router = await readFile(path.join(generatedApiPath, 'routes/testContentType.js'));
-    const service = await readFile(path.join(generatedApiPath, 'services/testContentType.js'));
-
-    expect(controller.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       *  testContentType controller
-       */
-
-      const { createCoreController } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreController('api::testContentType.testContentType');
-      "
-    `);
-    expect(router.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       * testContentType router.
-       */
-
-      const { createCoreRouter } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreRouter('api::testContentType.testContentType');
-      "
-    `);
-    expect(service.toString()).toMatchInlineSnapshot(`
-      "'use strict';
-
-      /**
-       * testContentType service.
-       */
-
-      const { createCoreService } = require('@strapi/strapi').factories;
-
-      module.exports = createCoreService('api::testContentType.testContentType');
-      "
-    `);
-  });
-
-  test('it generates the schema, then adds the attributes', async () => {
-    await strapiGenerators.generate(
-      'content-type',
-      {
-        displayName: 'testContentType',
-        singularName: 'testContentType',
-        pluralName: 'testContentTypes',
-        kind: 'singleType',
-        id: 'testContentType',
-        useDraftAndPublish: false,
-        destination: 'new',
-        bootstrapApi: false,
-        attributes: [
-          {
-            attributeName: 'name',
-            attributeType: 'string',
-          },
-          {
-            attributeName: 'email',
-            attributeType: 'string',
-          },
-        ],
-      },
-      { dir: outputDirectory }
-    );
-
-    const generatedSchemaPath = path.join(
-      outputDirectory,
-      'src/api/testContentType',
-      'content-types/testContentType/schema.json'
-    );
-
-    expect((await stat(generatedSchemaPath)).isFile()).toBeTruthy();
-
-    const fileContent = await readFile(generatedSchemaPath, 'utf-8');
-
-    expect(fileContent).not.toBeNull();
-
-    const schema = JSON.parse(fileContent.toString());
-
-    expect(schema.attributes).toStrictEqual({
-      email: { type: 'string' },
-      name: { type: 'string' },
-    });
-  });
-});

package/lib/plops/api.js

@@ -1,82 +0,0 @@
-'use strict';
-
-const { join } = require('path');
-const fs = require('fs-extra');
-const tsUtils = require('@strapi/typescript-utils');
-
-const validateInput = require('./utils/validate-input');
-
-module.exports = (plop) => {
-  // API generator
-  plop.setGenerator('api', {
-    description: 'Generate a basic API',
-    prompts: [
-      {
-        type: 'input',
-        name: 'id',
-        message: 'API name',
-        validate: (input) => validateInput(input),
-      },
-      {
-        type: 'confirm',
-        name: 'isPluginApi',
-        message: 'Is this API for a plugin?',
-      },
-      {
-        when: (answers) => answers.isPluginApi,
-        type: 'list',
-        name: 'plugin',
-        message: 'Plugin name',
-        async choices() {
-          const pluginsPath = join(plop.getDestBasePath(), 'plugins');
-          const exists = await fs.pathExists(pluginsPath);
-
-          if (!exists) {
-            throw Error('Couldn\'t find a "plugins" directory');
-          }
-
-          const pluginsDir = await fs.readdir(pluginsPath, { withFileTypes: true });
-          const pluginsDirContent = pluginsDir.filter((fd) => fd.isDirectory());
-
-          if (pluginsDirContent.length === 0) {
-            throw Error('The "plugins" directory is empty');
-          }
-
-          return pluginsDirContent;
-        },
-      },
-    ],
-    actions(answers) {
-      const filePath =
-        answers.isPluginApi && answers.plugin ? 'plugins/{{ plugin }}' : 'api/{{ id }}';
-      const currentDir = process.cwd();
-      const language = tsUtils.isUsingTypeScriptSync(currentDir) ? 'ts' : 'js';
-
-      const baseActions = [
-        {
-          type: 'add',
-          path: `${filePath}/controllers/{{ id }}.${language}`,
-          templateFile: `templates/${language}/controller.${language}.hbs`,
-        },
-        {
-          type: 'add',
-          path: `${filePath}/services/{{ id }}.${language}`,
-          templateFile: `templates/${language}/service.${language}.hbs`,
-        },
-      ];
-
-      if (answers.isPluginApi) {
-        return baseActions;
-      }
-
-      return [
-        {
-          type: 'add',
-          path: `${filePath}/routes/{{ id }}.${language}`,
-          templateFile: `templates/${language}/single-route.${language}.hbs`,
-        },
-        ...baseActions,
-      ];
-    },
-  });
-};