@grafana/create-plugin 0.3.0 → 0.3.2

package/dist/constants.js

@@ -67,11 +67,11 @@ exports.TEXT = {
     removeNpmDependenciesSuccess: 'Unnecessary NPM dependencies removed successfully.',
     removeNpmDependenciesAborted: 'No NPM dependencies have been removed.',
     updateConfigPrompt: "**Would you like to update the project's configuration?**",
-    updateNpmScriptsPrompt: '**Would you like to update the `{ scripts }` in your `package.json`?**',
+    updateNpmScriptsPrompt: '**Would you like to update the `{ scripts }` in your `package.json`?**\nAll scripts using grafana-toolkit will be replaced.',
     updateNpmScriptsSuccess: 'NPM scripts updated successfully.',
     updateNpmScriptsAborted: 'No NPM scripts have been added or updated.',
     migrationCommandWarning: '**⚠️  Warning!**\nThis is going to change files in your current project to make it up-to-date with the latest plugin configuration.\nPlease make sure that you have backed up your changes.',
-    migrationCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',
+    migrationCommandSuccess: "\n## What's next?\n * Run `yarn install` to install the latest dependencies.\n * Check your tsconfig.json. You might need to update if you had a custom configuration.\n * If you have a custom webpack configuration you might need to update it too.\n * Run `yarn build` and observe the output for any errors.\n * Test your plugin in grafana and make sure everything works as expected.\n\nSee instructions on how to customize your configuration here https://github.com/grafana/plugin-tools/blob/main/packages/create-plugin/templates/common/.config/README.md\n  ",
     updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',
     updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.'
 };

package/dist/utils/utils.handlebars.js

@@ -61,7 +61,8 @@ function registerHandlebarsHelpers() {
         kebabCase: changeCase.paramCase,
         properCase: changeCase.pascalCase,
         pascalCase: changeCase.pascalCase,
-        if_eq: exports.ifEq
+        if_eq: exports.ifEq,
+        normalize_id: exports.normalizeId
     };
     Object.keys(helpers).forEach(function (helperName) {
         return handlebars_1["default"].registerHelper(helperName, helpers[helperName]);

package/dist/utils/utils.npm.js

@@ -154,9 +154,17 @@ function removeNpmDependencies(packageNames, _a) {
 }
 exports.removeNpmDependencies = removeNpmDependencies;
 function updateNpmScripts() {
+    var toolkitScriptRe = /grafana-toolkit plugin:.*/;
     var packageJson = getPackageJson();
     var latestPackageJson = getLatestPackageJson();
-    packageJson.scripts = __assign(__assign({}, packageJson.scripts), latestPackageJson.scripts);
+    var scripts = __assign(__assign({}, packageJson.scripts), latestPackageJson.scripts);
+    for (var _i = 0, _a = Object.keys(scripts); _i < _a.length; _i++) {
+        var key = _a[_i];
+        if (toolkitScriptRe.test(scripts[key])) {
+            delete scripts[key];
+        }
+    }
+    packageJson.scripts = scripts;
     writePackageJson(packageJson);
 }
 exports.updateNpmScripts = updateNpmScripts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",

package/src/constants.ts

@@ -92,12 +92,21 @@ export const TEXT = {
 
   updateConfigPrompt: "**Would you like to update the project's configuration?**",
 
-  updateNpmScriptsPrompt: '**Would you like to update the `{ scripts }` in your `package.json`?**',
+  updateNpmScriptsPrompt: '**Would you like to update the `{ scripts }` in your `package.json`?**\nAll scripts using grafana-toolkit will be replaced.',
   updateNpmScriptsSuccess: 'NPM scripts updated successfully.',
   updateNpmScriptsAborted: 'No NPM scripts have been added or updated.',
 
   migrationCommandWarning:  '**⚠️  Warning!**\nThis is going to change files in your current project to make it up-to-date with the latest plugin configuration.\nPlease make sure that you have backed up your changes.',
-  migrationCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',
+  migrationCommandSuccess: `
+## What's next?
+ * Run \`yarn install\` to install the latest dependencies.
+ * Check your tsconfig.json. You might need to update if you had a custom configuration.
+ * If you have a custom webpack configuration you might need to update it too.
+ * Run \`yarn build\` and observe the output for any errors.
+ * Test your plugin in grafana and make sure everything works as expected.
+
+See instructions on how to customize your configuration here https://github.com/grafana/plugin-tools/blob/main/packages/create-plugin/templates/common/.config/README.md
+  `,
 
   updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',
   updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',

package/src/utils/utils.handlebars.ts

@@ -37,6 +37,7 @@ export function registerHandlebarsHelpers() {
     properCase: changeCase.pascalCase,
     pascalCase: changeCase.pascalCase,
     if_eq: ifEq,
+    normalize_id: normalizeId,
   };
 
   Object.keys(helpers).forEach((helperName) =>

package/src/utils/utils.npm.ts

@@ -177,14 +177,25 @@ export function removeNpmDependencies(packageNames: string[], { devOnly = false
 }
 
 export function updateNpmScripts() {
+  const toolkitScriptRe = /grafana-toolkit plugin:.*/;
+
   const packageJson = getPackageJson();
   const latestPackageJson = getLatestPackageJson();
 
-  packageJson.scripts = {
+  const scripts = {
     ...packageJson.scripts,
     ...latestPackageJson.scripts,
   };
 
+  // loop script keys and remove toolkit scripts
+  for (const key of Object.keys(scripts)) {
+    if (toolkitScriptRe.test(scripts[key])) {
+      delete scripts[key];
+    }
+  }
+
+  packageJson.scripts = scripts;
+
   writePackageJson(packageJson);
 }
 

package/templates/app/src/module.ts

@@ -4,7 +4,7 @@ import { AppConfig } from './components/AppConfig';
 
 export const plugin = new AppPlugin<{}>().setRootPage(App).addConfigPage({
   title: 'Configuration',
-  icon: 'fa fa-cog',
+  icon: 'cog',
   // @ts-ignore - Would expect a Class component, however works absolutely fine with a functional one
   // Implementation: https://github.com/grafana/grafana/blob/fd44c01675e54973370969dfb9e78f173aff7910/public/app/features/plugins/PluginPage.tsx#L157
   body: AppConfig,

package/templates/common/.config/jest.config.js

@@ -32,4 +32,5 @@ module.exports = {
       },
     ],
   },
+  transformIgnorePatterns: [],
 };

package/templates/common/docker-compose.yaml

@@ -2,7 +2,7 @@ version: '3.0'
 
 services:
   grafana:
-    container_name: '{{ kebabCase pluginName }}'
+    container_name: '{{ normalize_id pluginName orgName pluginType }}'
     build:
       context: ./.config
       args:
@@ -10,5 +10,5 @@ services:
     ports:
       - 3000:3000/tcp
     volumes:
-      - ./dist:/var/lib/grafana/plugins/{{ kebabCase pluginName }}
+      - ./dist:/var/lib/grafana/plugins/{{ normalize_id pluginName orgName pluginType }}
       - ./provisioning:/etc/grafana/provisioning