yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-12-25 14:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate plugin generator and fix some internal issues to make everything compatible

Browse Source
This commit is contained in:
Alexandre Bodin 2021-09-30 11:40:54 +02:00
parent 4dcdd9a488
commit 6ef3e1deb6
48 changed files with 455 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
examples/getstarted/src/plugins/super-plugin/README.md Normal file
View File

@ -0,0 +1,3 @@
# Strapi plugin super-plugin
A quick description of super-plugin.

26
examples/getstarted/src/plugins/super-plugin/admin/src/components/Initializer/index.js Normal file
View File

@ -0,0 +1,26 @@
/**
*
* Initializer
*
*/
import { useEffect, useRef } from 'react';
import PropTypes from 'prop-types';
import pluginId from '../../pluginId';
const Initializer = ({ setPlugin }) => {
const ref = useRef();
ref.current = setPlugin;
useEffect(() => {
ref.current(pluginId);
}, []);
return null;
};
Initializer.propTypes = {
setPlugin: PropTypes.func.isRequired,
};
export default Initializer;

25
examples/getstarted/src/plugins/super-plugin/admin/src/containers/App/index.js Normal file
View File

@ -0,0 +1,25 @@
/**
*
* 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 { NotFound } 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={NotFound} />
</Switch>
</div>
);
};
export default App;

20
examples/getstarted/src/plugins/super-plugin/admin/src/containers/HomePage/index.js Normal file
View File

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

26
examples/getstarted/src/plugins/super-plugin/admin/src/containers/Initializer/index.js Normal file
View File

@ -0,0 +1,26 @@
/**
*
* Initializer
*
*/
import { useEffect, useRef } from 'react';
import PropTypes from 'prop-types';
import pluginId from '../../pluginId';
const Initializer = ({ setPlugin }) => {
const ref = useRef();
ref.current = setPlugin;
useEffect(() => {
ref.current(pluginId);
}, []);
return null;
};
Initializer.propTypes = {
setPlugin: PropTypes.func.isRequired,
};
export default Initializer;

65
examples/getstarted/src/plugins/super-plugin/admin/src/index.js Normal file
View File

@ -0,0 +1,65 @@
import { prefixPluginTranslations } from '@strapi/helper-plugin';
import pluginPkg from '../../package.json';
import pluginId from './pluginId';
import Initializer from './components/Initializer';
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,
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,
// },
],
});
app.registerPlugin({
description: pluginDescription,
icon,
id: pluginId,
initializer: Initializer,
isReady: false,
isRequired: pluginPkg.strapi.required || false,
name,
});
},
bootstrap(app) {},
async registerTrads({ locales }) {
const importedTrads = await Promise.all(
locales.map(locale => {
return import(`./translations/${locale}.json`)
.then(({ default: data }) => {
return {
data: prefixPluginTranslations(data, pluginId),
locale,
};
})
.catch(() => {
return {
data: {},
locale,
};
});
})
);
return Promise.resolve(importedTrads);
},
};

25
examples/getstarted/src/plugins/super-plugin/admin/src/pages/App/index.js Normal file
View File

@ -0,0 +1,25 @@
/**
*
* 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 { NotFound } 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={NotFound} />
</Switch>
</div>
);
};
export default App;

20
examples/getstarted/src/plugins/super-plugin/admin/src/pages/HomePage/index.js Normal file
View File

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

5
examples/getstarted/src/plugins/super-plugin/admin/src/pluginId.js Normal file
View File

@ -0,0 +1,5 @@
const pluginPkg = require('../../package.json');
const pluginId = pluginPkg.name.replace(/^@strapi\/plugin-/i, '');
module.exports = pluginId;

1
examples/getstarted/src/plugins/super-plugin/admin/src/translations/en.json Normal file
View File

@ -0,0 +1 @@
{}

1
examples/getstarted/src/plugins/super-plugin/admin/src/translations/fr.json Normal file
View File

@ -0,0 +1 @@
{}

5
examples/getstarted/src/plugins/super-plugin/admin/src/utils/getTrad.js Normal file
View File

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

25
examples/getstarted/src/plugins/super-plugin/package.json Normal file
View File

@ -0,0 +1,25 @@
{
"name": "super-plugin",
"version": "0.0.0",
"description": "This is the description of the plugin.",
"strapi": {
"name": "super-plugin",
"icon": "plug",
"description": "Description of super-plugin plugin",
"kind": "plugin"
},
"dependencies": {},
"author": {
"name": "A Strapi developer"
},
"maintainers": [
{
"name": "A Strapi developer"
}
],
"engines": {
"node": ">=12.x. <=16.x.x",
"npm": ">=6.0.0"
},
"license": "MIT"
}

5
examples/getstarted/src/plugins/super-plugin/server/bootstrap.js vendored Normal file
View File

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

6
examples/getstarted/src/plugins/super-plugin/server/config/index.js Normal file
View File

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

7
examples/getstarted/src/plugins/super-plugin/server/controllers/index.js Normal file
View File

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

10
examples/getstarted/src/plugins/super-plugin/server/controllers/my-controller.js Normal file
View File

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

5
examples/getstarted/src/plugins/super-plugin/server/destroy.js Normal file
View File

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

22
examples/getstarted/src/plugins/super-plugin/server/index.js Normal file
View File

@ -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: {},
};

5
examples/getstarted/src/plugins/super-plugin/server/register.js Normal file
View File

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

10
examples/getstarted/src/plugins/super-plugin/server/routes/index.js Normal file
View File

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

7
examples/getstarted/src/plugins/super-plugin/server/services/index.js Normal file
View File

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

7
examples/getstarted/src/plugins/super-plugin/server/services/my-service.js Normal file
View File

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

3
examples/getstarted/src/plugins/super-plugin/strapi-admin.js Normal file
View File

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

3
examples/getstarted/src/plugins/super-plugin/strapi-server.js Normal file
View File

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

2
packages/core/admin/server/controllers/index.js
View File

@ -8,5 +8,5 @@ module.exports = {
permission: require('./permission'),
role: require('./role'),
user: require('./user'),
webhooks: require('./Webhooks'),
webhooks: require('./webhooks'),
};

0
packages/core/admin/server/controllers/Webhooks.js → packages/core/admin/server/controllers/webhooks.js
View File

14
packages/core/admin/server/routes/webhooks.js
View File

@ -4,7 +4,7 @@ module.exports = [
{
method: 'GET',
path: '/webhooks',
handler: 'Webhooks.listWebhooks',
handler: 'webhooks.listWebhooks',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -15,7 +15,7 @@ module.exports = [
{
method: 'POST',
path: '/webhooks',
handler: 'Webhooks.createWebhook',
handler: 'webhooks.createWebhook',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -26,7 +26,7 @@ module.exports = [
{
method: 'GET',
path: '/webhooks/:id',
handler: 'Webhooks.getWebhook',
handler: 'webhooks.getWebhook',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -37,7 +37,7 @@ module.exports = [
{
method: 'PUT',
path: '/webhooks/:id',
handler: 'Webhooks.updateWebhook',
handler: 'webhooks.updateWebhook',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -48,7 +48,7 @@ module.exports = [
{
method: 'DELETE',
path: '/webhooks/:id',
handler: 'Webhooks.deleteWebhook',
handler: 'webhooks.deleteWebhook',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -59,7 +59,7 @@ module.exports = [
{
method: 'POST',
path: '/webhooks/batch-delete',
handler: 'Webhooks.deleteWebhooks',
handler: 'webhooks.deleteWebhooks',
config: {
policies: [
'admin::isAuthenticatedAdmin',
@ -70,7 +70,7 @@ module.exports = [
{
method: 'POST',
path: '/webhooks/:id/trigger',
handler: 'Webhooks.triggerWebhook',
handler: 'webhooks.triggerWebhook',
config: {
policies: [],
},

3
packages/core/strapi/lib/services/server/compose-endpoint.js
View File

@ -84,6 +84,7 @@ const getController = (name, { pluginName, apiName }, strapi) => {
if (pluginName === 'admin') {
return strapi.controller(`admin::${name}`);
}
return strapi.plugin(pluginName).controller(name);
} else if (apiName) {
return strapi.controller(`api::${apiName}.${name}`);
@ -102,7 +103,7 @@ const getAction = (route, strapi) => {
const [controllerName, actionName] = trim(handler).split('.');
const controller = getController(toLower(controllerName), { pluginName, apiName }, strapi);
const controller = getController(controllerName, { pluginName, apiName }, strapi);
if (typeof controller[actionName] !== 'function') {
throw new Error(`Handler not found "${handler}"`);

5
packages/generators/generators/lib/files/plugin/server/bootstrap.js vendored Normal file
View File

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

6
packages/generators/generators/lib/files/plugin/server/config/index.js Normal file
View File

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

7
packages/generators/generators/lib/files/plugin/server/controllers/index.js Normal file
View File

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

10
packages/generators/generators/lib/files/plugin/server/controllers/my-controller.js.hbs Normal file
View File

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

5
packages/generators/generators/lib/files/plugin/server/destroy.js Normal file
View File

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

22
packages/generators/generators/lib/files/plugin/server/index.js Normal file
View File

@ -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: {},
};

5
packages/generators/generators/lib/files/plugin/server/register.js Normal file
View File

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

10
packages/generators/generators/lib/files/plugin/server/routes/index.js Normal file
View File

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

7
packages/generators/generators/lib/files/plugin/server/services/index.js Normal file
View File

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

7
packages/generators/generators/lib/files/plugin/server/services/my-service.js Normal file
View File

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

3
packages/generators/generators/lib/files/plugin/strapi-admin.js Normal file
View File

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

3
packages/generators/generators/lib/files/plugin/strapi-server.js Normal file
View File

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

2
packages/generators/generators/lib/plops/api.js
View File

@ -77,7 +77,7 @@ module.exports = plop => {
{
type: 'add',
path: `${filePath}/content-types/{{id}}/schema.json`,
templateFile: 'templates/model.schema.json.hbs',
templateFile: 'templates/content-type.schema.json.hbs',
},
{
type: 'add',

2
packages/generators/generators/lib/plops/content-type.js
View File

@ -157,7 +157,7 @@ module.exports = plop => {
{
type: 'add',
path: `${filePath}/content-types/{{id}}/schema.json`,
templateFile: 'templates/model.schema.json.hbs',
templateFile: 'templates/content-type.schema.json.hbs',
},
{
type: 'modify',

21
packages/generators/generators/lib/plops/plugin.js
View File

@ -15,24 +15,9 @@ module.exports = plop => {
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/{{id}}',
base: 'files/plugin',
templateFiles: 'files/plugin/**',
},
{
type: 'add',

0
packages/generators/generators/lib/templates/model.schema.json.hbs → packages/generators/generators/lib/templates/content-type.schema.json.hbs
View File

13
packages/generators/generators/lib/templates/plugin-package.json.hbs
View File

@ -1,23 +1,20 @@
{
"name": "strapi-plugin-{{id}}",
"name": "{{id}}",
"version": "0.0.0",
"description": "This is the description of the plugin.",
"strapi": {
"name": "{{id}}",
"icon": "plug",
"description": "Description of {{id}} plugin."
"description": "Description of {{id}} 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": {

12
packages/generators/generators/lib/templates/plugin-routes.json.hbs
View File

@ -1,12 +0,0 @@
{
"routes": [
{
"method": "GET",
"path": "/",
"handler": "{{id}}.index",
"config": {
"policies": []
}
}
]
}

16
packages/plugins/documentation/server/routes/index.js
View File

@ -4,7 +4,7 @@ module.exports = [
{
method: 'GET',
path: '/',
handler: 'Documentation.index',
handler: 'documentation.index',
config: {
policies: [
'plugin::documentation.index',
@ -15,7 +15,7 @@ module.exports = [
{
method: 'GET',
path: '/v:major(\\d+).:minor(\\d+).:patch(\\d+)',
handler: 'Documentation.index',
handler: 'documentation.index',
config: {
policies: [
'plugin::documentation.index',
@ -26,7 +26,7 @@ module.exports = [
{
method: 'GET',
path: '/login',
handler: 'Documentation.loginView',
handler: 'documentation.loginView',
config: {
policies: [
{ name: 'admin::hasPermissions', options: { actions: ['plugin::documentation.read'] } },
@ -36,7 +36,7 @@ module.exports = [
{
method: 'POST',
path: '/login',
handler: 'Documentation.login',
handler: 'documentation.login',
config: {
policies: [
{ name: 'admin::hasPermissions', options: { actions: ['plugin::documentation.read'] } },
@ -46,7 +46,7 @@ module.exports = [
{
method: 'GET',
path: '/getInfos',
handler: 'Documentation.getInfos',
handler: 'documentation.getInfos',
config: {
policies: [
{ name: 'admin::hasPermissions', options: { actions: ['plugin::documentation.read'] } },
@ -56,7 +56,7 @@ module.exports = [
{
method: 'POST',
path: '/regenerateDoc',
handler: 'Documentation.regenerateDoc',
handler: 'documentation.regenerateDoc',
config: {
policies: [
{
@ -69,7 +69,7 @@ module.exports = [
{
method: 'PUT',
path: '/updateSettings',
handler: 'Documentation.updateSettings',
handler: 'documentation.updateSettings',
config: {
policies: [
{
@ -82,7 +82,7 @@ module.exports = [
{
method: 'DELETE',
path: '/deleteDoc/:version',
handler: 'Documentation.deleteDoc',
handler: 'documentation.deleteDoc',
config: {
policies: [],
},