@grafana/create-plugin 0.2.0 → 0.3.0

package/CONTRIBUTING.md

@@ -12,8 +12,8 @@ You need to have `npm` or `yarn` installed.
 ### Installing
 
 ```bash
-git clone git@github.com:grafana/create-plugin.git
-cd create-plugin
+git clone git@github.com:grafana/plugin-tools.git
+cd plugin-tools
 yarn install
 ```
 
@@ -25,18 +25,55 @@ yarn install
 
 ### Folder structure
 
-_Work in progress._
+`@grafana/create-plugin` consists of the following folder structure:
+
+```js
+├── src // Executable code
+│   ├── bin // the entrypoint file
+│   ├── commands // Code that runs commands
+│   └── utils // Utilities used by commands
+└── templates // Plop templates
+    ├── _partials // Composable parts of a template
+    ├── app // Templates specific to scaffolding an app plugin
+    ├── backend // Templates specific to scaffolding backend plugin code
+    ├── common // Common templates used by all plugin types (e.g. tooling config files)
+    ├── datasource // Templates specific to scaffolding a datasource plugin
+    ├── github // Templates for github workflows
+    └── panel // Templates specific to scaffolding a panel plugin
+```
 
 ## Development
 
-### Conventions
+There are a collection of [commands](#commmands) to assist with developing `create-plugin`. Please read the main [contributing guide](../../CONTRIBUTING.md) before contributing any code changes to the project.
 
-_Work in progress._
+### Commmands
 
-### Developing the templates
+Below are the main commands used for developing `create-plugin`. They can be run by either `yarn workspace @grafana/create-plugin run <name_of_command>` or navigating to `packages/create-plugin` and running the command directly as detailed below.
 
-_Work in progress._
+```shell
+yarn build # used to build @grafana/create-plugin
+```
 
-### Submitting a Pull Request
+```shell
+yarn dev # watches for changes to files and rebuilds @grafana/create-plugin automatically
+```
+
+```shell
+yarn dev-app # watches for changes and scaffolds an app plugin (in ./generated) for developing app configs
+```
+
+```shell
+yarn dev-panel # watches for changes and scaffolds an app plugin (in ./generated) for developing panel configs
+```
+
+```shell
+yarn dev-datasource # watches for changes and scaffolds an app plugin (in ./generated) for developing datasource configs
+```
+
+### Conventions
 
 _Work in progress._
+
+### Developing the templates
+
+The templates are used by Plop to scaffold Grafana plugins. Whilst they appear to be the intended filetype they are infact treated as markdown by Plop when it runs. As such we need to be mindful of syntax and to [escape particular characters](https://handlebarsjs.com/guide/expressions.html#whitespace-control) where necessary. The [github/ci.yml](./templates/github/ci/.github/workflows/ci.yml) file is a good example of this.

package/README.md

@@ -4,11 +4,18 @@ Create Grafana plugins with ease.
 
 **ToC**
 
-- [Create a new plugin](#create-a-new-plugin)
-- [Migrate your existing plugin](#migrate-your-existing-plugin)
-- [Update your plugin build config](#update-your-plugin-build-config)
-- [Start developing your plugin](#start-developing-your-plugin)
-- [Contributing](#contributing)
+- [Grafana / Create Plugin](#grafana--create-plugin)
+  - [Create a new plugin](#create-a-new-plugin)
+    - [Quick overview](#quick-overview)
+      - [`yarn` (1.x)](#yarn-1x)
+      - [`yarn` (> 2.x)](#yarn--2x)
+      - [`npx`](#npx)
+      - [`npm`](#npm)
+  - [Migrate your existing plugin](#migrate-your-existing-plugin)
+    - [Things to check after migration](#things-to-check-after-migration)
+  - [Update your plugin build config](#update-your-plugin-build-config)
+  - [Customizing or extending the basic configs](#customizing-or-extending-the-basic-configs)
+  - [Contributing](#contributing)
 
 **Links**
 
@@ -16,46 +23,39 @@ Create Grafana plugins with ease.
 - [Plugin migration guide](https://grafana.com/docs/grafana/latest/developers/plugins/migration-guide/)
 
 **`@grafana/create-plugin`** works on macOS, Windows and Linux.<br />
-If something doesn’t work, please [file an issue](https://github.com/grafana/create-plugin/issues/new).<br />
-If you have questions or need help, please ask in [GitHub Discussions](https://github.com/grafana/create-plugin/discussions).
+If something doesn't work, please [file an issue](https://github.com/grafana/plugin-tools/issues/new).<br />
+If you have questions or need help, please ask in [GitHub Discussions](https://github.com/grafana/plugin-tools/discussions).
 
 ## Create a new plugin
 
 ### Quick overview
 
-The following commands scaffold a Grafana plugin inside the `./my-plugin` folder:
+Run the command in the folder where you want to store your plugins. The new plugin will be scaffolded in a sub-directory of the folder where you run the command.
 
-```bash
-mkdir my-plugin && cd my-plugin
-yarn create @grafana/plugin
-yarn install
-yarn dev
-```
+You can run the command with the package manager of your choice:
 
-Alterntives:
-
-#### [`npx`](https://github.com/npm/npx)
+#### [`yarn`](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) (1.x)
 
 ```bash
-npx @grafana/create-plugin
+yarn create @grafana/plugin
 ```
 
-#### [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-init)
+#### [`yarn`](https://yarnpkg.com/cli/dlx) (> 2.x)
 
 ```bash
-npm init @grafana/plugin
+yarn dlx @grafana/create-plugin
 ```
 
-#### [`yarn`](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) (1.x)
+#### [`npx`](https://github.com/npm/npx)
 
 ```bash
-yarn create @grafana/plugin
+npx @grafana/create-plugin
 ```
 
-#### [`yarn`](https://yarnpkg.com/cli/dlx) (> 2.x)
+#### [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-init)
 
 ```bash
-yarn dlx @grafana/create-plugin
+npm init @grafana/plugin
 ```
 
 ---
@@ -97,47 +97,10 @@ npx @grafana/create-plugin update
 
 ---
 
-## Start developing your plugin
-
-We have put together the following dev scripts for you, so you can start coding right away:
-
-#### `yarn dev`
-
-Starts the build in watch mode.
-The build output (plugin bundle) is going to be exported to `./dist`.
-
-#### `yarn build`
-
-Creates a production build for your plugin.
-The build output is going to be exported to `./dist`.
-
-#### `yarn test`
-
-Runs the tests under `./src` directory in watch mode.
-Give your test files a `.test.tsx` or `.test.ts` extension.
-
-#### `yarn test:ci`
-
-Runs the tests and returns with either a zero or a non-zero exit status.
-
-#### `yarn typecheck`
-
-Runs the Typescript compiler against the codebase in a dry-run mode to highlight any type errors or warnings.
-
-#### `yarn lint`
-
-Runs ESLint against the codebase.
-
-#### `yarn lint:fix`
-
-Runs ESLint against the codebase and attempts to fix the simpler errors.
-
----
-
 ## Customizing or extending the basic configs
 
 You can read more about customizing or extending the basic configuration [here](templates/common/.config/README.md)
 
 ## Contributing
 
-We are always grateful for contribution! See the [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
+We are always grateful for contributions! See the [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.

package/dist/commands/generate.plopfile.js

@@ -61,7 +61,8 @@ function default_1(plop) {
                 name: 'hasBackend',
                 type: 'confirm',
                 message: 'Do you want a backend part of your plugin?',
-                "default": false
+                "default": false,
+                when: function (answers) { return answers.pluginType !== constants_1.PLUGIN_TYPES.panel; }
             },
             {
                 name: 'hasGithubWorkflows',

package/dist/commands/update.command.js

@@ -48,7 +48,7 @@ var update = function () { return __awaiter(void 0, void 0, void 0, function ()
             case 0:
                 _a.trys.push([0, 5, , 6]);
                 (0, utils_console_1.printMessage)(constants_1.TEXT.updateCommandWarning);
-                return [4, (0, utils_console_1.confirmPrompt)(constants_1.TEXT.overrideFilesPrompt)];
+                return [4, (0, utils_console_1.confirmPrompt)(constants_1.TEXT.updateConfigPrompt)];
             case 1:
                 if (_a.sent()) {
                     (0, utils_templates_1.compileTemplateFiles)(constants_1.UDPATE_CONFIG.filesToOverride, (0, utils_templates_1.getTemplateData)());

package/dist/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.TEXT = exports.UDPATE_CONFIG = exports.MIGRATION_CONFIG = exports.EXTRA_TEMPLATE_VARIABLES = exports.PLUGIN_TYPES = exports.TEMPLATE_PATHS = exports.PARTIALS_DIR = exports.TEMPLATES_DIR = exports.DIST_DIR = exports.EXPORT_PATH_PREFIX = exports.DEV_EXPORT_DIR = exports.IS_DEV = void 0;
+exports.TEXT = exports.UDPATE_CONFIG = exports.MIGRATION_CONFIG = exports.EXTRA_TEMPLATE_VARIABLES = exports.PLUGIN_TYPES = exports.TEMPLATE_PATHS = exports.FIXTURES_PATH = exports.PARTIALS_DIR = exports.TEMPLATES_DIR = exports.DIST_DIR = exports.EXPORT_PATH_PREFIX = exports.DEV_EXPORT_DIR = exports.IS_DEV = void 0;
 var path_1 = __importDefault(require("path"));
 exports.IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
 exports.DEV_EXPORT_DIR = path_1["default"].join(__dirname, '..', 'generated');
@@ -11,6 +11,7 @@ exports.EXPORT_PATH_PREFIX = exports.IS_DEV ? exports.DEV_EXPORT_DIR : process.c
 exports.DIST_DIR = path_1["default"].join(__dirname, 'dist');
 exports.TEMPLATES_DIR = path_1["default"].join(__dirname, '..', 'templates');
 exports.PARTIALS_DIR = path_1["default"].join(exports.TEMPLATES_DIR, '_partials');
+exports.FIXTURES_PATH = path_1["default"].join(__dirname, '..', 'fixtures');
 exports.TEMPLATE_PATHS = {
     app: path_1["default"].join(exports.TEMPLATES_DIR, 'app'),
     backend: path_1["default"].join(exports.TEMPLATES_DIR, 'backend'),
@@ -25,6 +26,7 @@ var PLUGIN_TYPES;
     PLUGIN_TYPES["app"] = "app";
     PLUGIN_TYPES["panel"] = "panel";
     PLUGIN_TYPES["datasource"] = "datasource";
+    PLUGIN_TYPES["secretsmanager"] = "secretsmanager";
 })(PLUGIN_TYPES = exports.PLUGIN_TYPES || (exports.PLUGIN_TYPES = {}));
 exports.EXTRA_TEMPLATE_VARIABLES = {
     grafanaVersion: '9.1.2'
@@ -64,11 +66,12 @@ exports.TEXT = {
     removeNpmDependenciesPrompt: '**Would you like to remove the following possibly unnecessary NPM dependencies?**',
     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`?**',
     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/create-plugin.',
+    migrationCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',
     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/create-plugin.'
+    updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.'
 };

package/dist/utils/tests/utils.handlebars.test.js

@@ -8,19 +8,19 @@ describe('Handlebars helpers', function () {
             var pluginName = 'my-plugin';
             var orgName = 'my-org';
             var actual = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, type);
-            expect(actual).toEqual("my-org-my-plugin-".concat(type));
+            expect(actual).toEqual("myorg-myplugin-".concat(type));
         });
         test.each([constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel])('should not duplicate the type if it is already present', function (type) {
             var pluginName = "my-plugin-".concat(type);
             var orgName = 'my-org';
             var actual = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, type);
-            expect(actual).toEqual("my-org-my-plugin-".concat(type));
+            expect(actual).toEqual("myorg-myplugin-".concat(type));
         });
         test.each([constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel])('should not duplicate the type if it is already present (no dash before type)', function (type) {
             var pluginName = "my-plugin".concat(type);
             var orgName = 'my-org';
             var actual = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, type);
-            expect(actual).toEqual("my-org-my-plugin-".concat(type));
+            expect(actual).toEqual("myorg-myplugin-".concat(type));
         });
     });
 });

package/dist/utils/tests/utils.plugin.test.js

@@ -5,7 +5,7 @@ var utils_plugin_1 = require("../utils.plugin");
 describe('Utils / Plugins', function () {
     describe('getPluginJson()', function () {
         test('should return the parsed plugin JSON if the file exits', function () {
-            var srcDir = "".concat(constants_1.TEMPLATE_PATHS.app, "/src");
+            var srcDir = "".concat(constants_1.FIXTURES_PATH, "/test-template/src");
             var pluginJson = (0, utils_plugin_1.getPluginJson)(srcDir);
             expect(pluginJson).toBeDefined();
             expect(pluginJson.type).toBe('app');

package/dist/utils/utils.handlebars.js

@@ -39,8 +39,10 @@ var ifEq = function (a, b, options) {
 exports.ifEq = ifEq;
 var normalizeId = function (pluginName, orgName, type) {
     var re = new RegExp("-?".concat(type, "$"), 'i');
-    var newPluginName = pluginName.replace(re, '');
-    return changeCase.paramCase(orgName) + '-' + changeCase.paramCase(newPluginName) + "-".concat(type);
+    var nameRegex = new RegExp('[^0-9a-z]', 'g');
+    var newPluginName = pluginName.replace(re, '').replace(nameRegex, '');
+    var newOrgName = orgName.replace(nameRegex, '');
+    return changeCase.lowerCase(newOrgName) + '-' + changeCase.lowerCase(newPluginName) + "-".concat(type);
 };
 exports.normalizeId = normalizeId;
 function registerHandlebarsHelpers() {

package/fixtures/test-template/src/plugin.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json",
+  "type": "app",
+  "name": "{{ titleCase pluginName }}",
+  "id": "{{ normalize_id pluginName orgName 'app' }}",
+  "backend": true,
+  "executable": "gpx_{{ snakeCase pluginName }}",
+  "info": {
+    "description": "{{ sentenceCase pluginDescription }}",
+    "author": {
+      "name": "{{ sentenceCase orgName }}"
+    },
+    "logos": {
+      "small": "img/logo.svg",
+      "large": "img/logo.svg"
+    },
+    "screenshots": [],
+    "version": "%VERSION%",
+    "updated": "%TODAY%"
+  },
+  "includes": [
+    {
+      "type": "page",
+      "name": "Default",
+      "path": "/a/%PLUGIN_ID%",
+      "role": "Admin",
+      "addToNav": true,
+      "defaultNav": true
+    }
+  ],
+  "dependencies": {
+    "grafanaDependency": ">={{ grafanaVersion }}",
+    "plugins": []
+  }
+}

package/jest.config.js

@@ -1,20 +1,5 @@
+const sharedConfig = require('../../jest.config.base');
 module.exports = {
-  testMatch: ['<rootDir>/src/**/*.{spec,test,jest}.{js,jsx,ts,tsx}'],
-  transform: {
-    '^.+\\.(t|j)sx?$': [
-      '@swc/jest',
-      {
-        sourceMaps: true,
-        jsc: {
-          parser: {
-            syntax: 'typescript',
-            tsx: true,
-            decorators: false,
-            dynamicImport: true,
-          },
-        },
-      },
-    ],
-  },
+  ...sharedConfig,
   modulePathIgnorePatterns: ['<rootDir>/templates/'],
 };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "main": "index.js",
-  "repository": "git@github.com:grafana/create-plugin.git",
+  "repository": {
+    "directory": "packages/create-plugin",
+    "url": "git@github.com:grafana/plugin-tools.git"
+  },
   "author": "Grafana",
   "license": "Apache-2.0",
   "bin": "./dist/bin/run.js",
@@ -14,45 +17,30 @@
     "dev-app": "CREATE_PLUGIN_DEV=true nodemon --exec 'yarn generate-app'",
     "dev-panel": "CREATE_PLUGIN_DEV=true nodemon --exec 'yarn generate-panel'",
     "dev-datasource": "CREATE_PLUGIN_DEV=true nodemon --exec 'yarn generate-datasource'",
-    "generate-app": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js -- create-plugin 'Sample app' 'sample-org' 'This is a sample app.' 'app' 't' 't' 't'",
-    "generate-panel": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js -- create-plugin 'Sample panel' 'sample-org' 'This is a sample panel.' 'panel' 't' 't' 't'",
-    "generate-datasource": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js -- create-plugin 'Sample datasource' 'sample-org' 'This is a sample datasource.' 'datasource' 't' 't' 't'",
-    "lint": "eslint --cache --ignore-path ./.gitignore --ext .js,.jsx,.ts,.tsx ./src",
+    "generate-app": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-app.js",
+    "generate-panel": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-panel.js",
+    "generate-datasource": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-datasource.js",
+    "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
     "lint:fix": "yarn lint --fix",
-    "test": "jest --watch",
+    "test": "jest",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@grafana/tsconfig": "^1.2.0-rc1",
-    "@swc/core": "^1.2.162",
     "@types/minimist": "^1.2.2",
     "@types/mkdirp": "^1.0.2",
     "@types/semver": "^7.3.9",
     "enquirer": "^2.3.6",
     "glob": "^7.1.7",
-    "jest": "^27.5.1",
-    "marked-terminal": "^5.1.1",
     "marked": "^4.0.12",
+    "marked-terminal": "^5.1.1",
     "mkdirp": "^1.0.4",
     "plop": "^2.7.4",
     "semver": "^7.3.5"
   },
   "devDependencies": {
-    "@grafana/eslint-config": "^2.5.0",
-    "@swc/jest": "^0.2.20",
     "@types/glob": "^7.0.0",
-    "@types/jest": "^27.4.1",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-jsdoc": "^36.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "nodemon": "^2.0.13",
-    "tsc-watch": "^4.5.0",
-    "typescript": "^4.4.3"
+    "eslint-plugin-react-hooks": "^4.2.0"
   },
   "nodemonConfig": {
     "watch": [

package/scripts/generate-app.js

@@ -0,0 +1,24 @@
+const nodePlop = require('node-plop');
+const path = require('path');
+const fs = require('fs');
+
+async function generatePanel() {
+  const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
+  if (!fs.existsSync(plopFile)) {
+    console.error('Run build first');
+    process.exit(1);
+  }
+  const plop = await nodePlop(plopFile);
+  const generator = plop.getGenerator('create-plugin');
+  await generator.runActions({
+    pluginName: 'my-plugin',
+    orgName: 'my-org',
+    pluginDescription: 'Auto-generated app',
+    pluginType: 'app',
+    hasBackend: false,
+    hasGithubWorkflows: true,
+    hasGithubLevitateWorkflow: true,
+  });
+}
+
+generatePanel();

package/scripts/generate-datasource.js

@@ -0,0 +1,24 @@
+const nodePlop = require('node-plop');
+const path = require('path');
+const fs = require('fs');
+
+async function generatePanel() {
+  const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
+  if (!fs.existsSync(plopFile)) {
+    console.error('Run build first');
+    process.exit(1);
+  }
+  const plop = await nodePlop(plopFile);
+  const generator = plop.getGenerator('create-plugin');
+  await generator.runActions({
+    pluginName: 'my-plugin',
+    orgName: 'my-org',
+    pluginDescription: 'Auto-generated datasource',
+    pluginType: 'datasource',
+    hasBackend: true,
+    hasGithubWorkflows: true,
+    hasGithubLevitateWorkflow: true,
+  });
+}
+
+generatePanel();

package/scripts/generate-panel.js

@@ -0,0 +1,23 @@
+const nodePlop = require('node-plop');
+const path = require('path');
+const fs = require('fs');
+
+async function generatePanel() {
+  const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
+  if (!fs.existsSync(plopFile)) {
+    console.error('Run build first');
+    process.exit(1);
+  }
+  const plop = await nodePlop(plopFile);
+  const generator = plop.getGenerator('create-plugin');
+  await generator.runActions({
+    pluginName: 'my-plugin',
+    orgName: 'my-org',
+    pluginDescription: 'Auto-generated panel',
+    pluginType: 'panel',
+    hasGithubWorkflows: true,
+    hasGithubLevitateWorkflow: true,
+  });
+}
+
+generatePanel();

package/src/commands/generate.plopfile.ts

@@ -69,6 +69,7 @@ export default function (plop: NodePlopAPI) {
         type: 'confirm',
         message: 'Do you want a backend part of your plugin?',
         default: false,
+        when: (answers: CliArgs) => answers.pluginType !== PLUGIN_TYPES.panel,
       },
       {
         name: 'hasGithubWorkflows',

package/src/commands/update.command.ts

@@ -16,7 +16,7 @@ export const update = async () => {
 
     // 1. Add / update configuration files
     // -----------------------------------
-    if (await confirmPrompt(TEXT.overrideFilesPrompt)) {
+    if (await confirmPrompt(TEXT.updateConfigPrompt)) {
       compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
       printSuccessMessage(TEXT.overrideFilesSuccess);
     } else {

package/src/constants.ts

@@ -14,6 +14,8 @@ export const TEMPLATES_DIR = path.join(__dirname, '..', 'templates');
 // (they won't be copied over to the generated folder as they are)
 export const PARTIALS_DIR = path.join(TEMPLATES_DIR, '_partials');
 
+export const FIXTURES_PATH = path.join(__dirname, '..', 'fixtures');
+
 export const TEMPLATE_PATHS: Record<string, string> = {
   app: path.join(TEMPLATES_DIR, 'app'),
   backend: path.join(TEMPLATES_DIR, 'backend'),
@@ -28,6 +30,7 @@ export enum PLUGIN_TYPES {
   app = 'app',
   panel = 'panel',
   datasource = 'datasource',
+  secretsmanager = 'secretsmanager',
 }
 
 // This gets merged into variables coming from user prompts (when using Plop) or any other dynamic variables,
@@ -87,13 +90,15 @@ export const 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`?**',
   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/create-plugin.',
+  migrationCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',
 
   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/create-plugin.',
+  updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.',
 }

package/src/utils/tests/utils.handlebars.test.ts

@@ -9,7 +9,7 @@ describe('Handlebars helpers', () => {
         const pluginName = 'my-plugin';
         const orgName = 'my-org';
         const actual = normalizeId(pluginName, orgName, type);
-        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+        expect(actual).toEqual(`myorg-myplugin-${type}`);
       }
     );
     test.each([PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel])(
@@ -18,7 +18,7 @@ describe('Handlebars helpers', () => {
         const pluginName = `my-plugin-${type}`;
         const orgName = 'my-org';
         const actual = normalizeId(pluginName, orgName, type);
-        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+        expect(actual).toEqual(`myorg-myplugin-${type}`);
       }
     );
 
@@ -28,7 +28,7 @@ describe('Handlebars helpers', () => {
         const pluginName = `my-plugin${type}`;
         const orgName = 'my-org';
         const actual = normalizeId(pluginName, orgName, type);
-        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+        expect(actual).toEqual(`myorg-myplugin-${type}`);
       }
     );
   });

package/src/utils/tests/utils.plugin.test.ts

@@ -1,10 +1,10 @@
-import { TEMPLATE_PATHS } from '../../constants';
+import { FIXTURES_PATH, TEMPLATE_PATHS } from '../../constants';
 import { getPluginJson } from '../utils.plugin';
 
 describe('Utils / Plugins', () => {
   describe('getPluginJson()', () => {
     test('should return the parsed plugin JSON if the file exits', () => {
-      const srcDir = `${TEMPLATE_PATHS.app}/src`;
+      const srcDir = `${FIXTURES_PATH}/test-template/src`;
       const pluginJson = getPluginJson(srcDir);
 
       expect(pluginJson).toBeDefined();

package/src/utils/utils.handlebars.ts

@@ -12,8 +12,11 @@ export const ifEq = (a: any, b: any, options: HelperOptions) => {
 
 export const normalizeId = (pluginName: string, orgName: string, type: PLUGIN_TYPES) => {
   const re = new RegExp(`-?${type}$`, 'i');
-  const newPluginName = pluginName.replace(re, '');
-  return changeCase.paramCase(orgName) + '-' + changeCase.paramCase(newPluginName) + `-${type}`;
+  const nameRegex = new RegExp('[^0-9a-z]', 'g');
+
+  const newPluginName = pluginName.replace(re, '').replace(nameRegex, '');
+  const newOrgName = orgName.replace(nameRegex, '');
+  return changeCase.lowerCase(newOrgName) + '-' + changeCase.lowerCase(newPluginName) + `-${type}`;
 };
 
 // Needed when we are rendering the templates outside of the context of Plop but still would like to support the same helpers

package/templates/app/src/plugin.json

@@ -2,8 +2,11 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json",
   "type": "app",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'app' }}",
+  "id": "{{ normalize_id pluginName orgName 'app' }}",{{#if hasBackend}}
+  "backend": true,
+  "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}
   "info": {
+    "keywords": ["app"],
     "description": "{{ sentenceCase pluginDescription }}",
     "author": {
       "name": "{{ sentenceCase orgName }}"