IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

grafana/toolkit: Do not suggest Angular panel anymore, add note about Grafana tutorials (#23902)

Browse Source
This commit is contained in:
Dominik Prokop 2020-04-26 13:16:04 +02:00 committed by GitHub
parent 20286dac53
commit 6dfad3b352
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/grafana-toolkit/src/cli/tasks/plugin.create.ts
View File

@ -6,6 +6,7 @@ import {
formatPluginDetails, formatPluginDetails,
getPluginIdFromName, getPluginIdFromName,
prepareJsonFiles, prepareJsonFiles,
printGrafanaTutorialsDetails,
promptPluginDetails, promptPluginDetails,
promptPluginType, promptPluginType,
removeGitFiles, removeGitFiles,
@ -41,6 +42,9 @@ const pluginCreateRunner: TaskRunner<PluginCreateOptions> = async ({ name }) =>
// 6. Remove cloned repository .git dir // 6. Remove cloned repository .git dir
await removeGitFiles(destPath); await removeGitFiles(destPath);
// 7. Promote Grafana Tutorials :)
printGrafanaTutorialsDetails(type);
}; };
export const pluginCreateTask = new Task<PluginCreateOptions>('plugin:create task', pluginCreateRunner); export const pluginCreateTask = new Task<PluginCreateOptions>('plugin:create task', pluginCreateRunner);

39
packages/grafana-toolkit/src/cli/tasks/plugin/create.ts
View File

@ -20,14 +20,23 @@ interface PluginDetails {
keywords: string; keywords: string;
} }
type PluginType = 'angular-panel' | 'react-panel' | 'datasource-plugin' | 'backend-datasource-plugin'; type PluginType = 'panel-plugin' | 'datasource-plugin' | 'backend-datasource-plugin';
const RepositoriesPaths = { const PluginNames: Record<PluginType, string> = {
'angular-panel': 'https://github.com/grafana/simple-angular-panel.git', 'panel-plugin': 'Grafana Panel Plugin',
'react-panel': 'https://github.com/grafana/simple-react-panel.git', 'datasource-plugin': 'Grafana Data Source Plugin',
'backend-datasource-plugin': 'Grafana Backend Datasource Plugin',
};
const RepositoriesPaths: Record<PluginType, string> = {
'panel-plugin': 'https://github.com/grafana/simple-react-panel.git',
'datasource-plugin': 'https://github.com/grafana/simple-datasource.git', 'datasource-plugin': 'https://github.com/grafana/simple-datasource.git',
'backend-datasource-plugin': 'https://github.com/grafana/simple-datasource-backend.git', 'backend-datasource-plugin': 'https://github.com/grafana/simple-datasource-backend.git',
}; };
const TutorialPaths: Record<PluginType, string> = {
'panel-plugin': 'https://grafana.com/tutorials/build-a-panel-plugin',
'datasource-plugin': 'https://grafana.com/tutorials/build-a-data-source-plugin',
'backend-datasource-plugin': 'TODO',
};
export const getGitUsername = async () => { export const getGitUsername = async () => {
const name = await simpleGit.raw(['config', '--global', 'user.name']); const name = await simpleGit.raw(['config', '--global', 'user.name']);
@ -61,10 +70,9 @@ export const promptPluginType = async () =>
message: 'Select plugin type', message: 'Select plugin type',
name: 'type', name: 'type',
choices: [ choices: [
{ name: 'Angular panel', value: 'angular-panel' }, { name: 'Panel Plugin', value: 'panel-plugin' },
{ name: 'React panel', value: 'react-panel' }, { name: 'Datasource Plugin', value: 'datasource-plugin' },
{ name: 'Datasource plugin', value: 'datasource-plugin' }, { name: 'Backend Datasource Plugin', value: 'backend-datasource-plugin' },
{ name: 'Backend datasource plugin', value: 'backend-datasource-plugin' },
], ],
}, },
]); ]);
@ -159,4 +167,19 @@ export const formatPluginDetails = (details: PluginDetails) => {
console.log(); console.log();
console.groupEnd(); console.groupEnd();
}; };
export const printGrafanaTutorialsDetails = (type: PluginType) => {
console.group();
console.log();
console.log(chalk.bold.yellow(`Congrats! You have just created ${PluginNames[type]}.`));
console.log();
if (type !== 'backend-datasource-plugin') {
console.log(`${PluginNames[type]} tutorial: ${TutorialPaths[type]}`);
}
console.log(
'Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/'
);
console.log();
console.groupEnd();
};
/* eslint-enable no-console */ /* eslint-enable no-console */