@grafana/create-plugin 0.0.1

package/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": ["@grafana/eslint-config"],
+  "rules": {
+    "react/prop-types": "off"
+  }
+}

package/.github/workflows/create-release.yml

@@ -0,0 +1,49 @@
+on:
+  push:
+    tags:
+      - 'v*'
+
+name: Create Release
+
+jobs:
+  publish:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup environment
+        uses: actions/setup-node@v2.5.1
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Build package
+        run: yarn build
+
+      - name: Publish
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  create-github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: publish
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Create Release Notes
+        uses: actions/github-script@v4.0.2
+        with:
+          github-token: ${{secrets.GH_TOKEN}}
+          script: |
+            await github.request(`POST /repos/${{ github.repository }}/releases`, {
+              tag_name: "${{ github.ref }}",
+              generate_release_notes: true
+            });

package/.github/workflows/npm-bump-version.yml

@@ -0,0 +1,51 @@
+name: NPM bump version
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Semver type of new version (major / minor / patch)'
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_BOT_ACCESS_TOKEN }}
+
+      - name: Setup environment
+        uses: actions/setup-node@v3.1.1
+        with:
+          node-version: '16'
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --immutable
+
+      - name: Check types
+        run: yarn typecheck
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Unit tests
+        run: yarn jest
+
+      - name: Setup Git
+        run: |
+          git config user.name 'grafanabot'
+          git config user.email 'bot@grafana.com'
+
+      - name: bump version
+        run: npm version ${{ github.event.inputs.version }}
+
+      - name: Push latest version
+        run: git push origin main --follow-tags

package/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: test
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Run unit tests
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.ref }}
+      - name: Setup .npmrc file for NPM registry
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: yarn
+      - name: Check types
+        run: yarn typecheck
+      - name: Lint
+        run: yarn lint
+      - name: Unit tests
+        run: yarn jest
+      - name: test an app plugin generation
+        run: yarn generate-app && (cd generated && yarn && yarn build && yarn lint)
+      - name: test panel plugin generation
+        run: yarn generate-panel && (cd generated && yarn && yarn build && yarn lint)
+      - name: test datasource plugin generation
+        run: yarn generate-datasource && (cd generated && yarn && yarn build && yarn lint)

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "endOfLine": "auto",
+  "printWidth": 120,
+  "trailingComma": "es5",
+  "semi": true,
+  "jsxSingleQuote": false,
+  "singleQuote": true,
+  "useTabs": false,
+  "tabWidth": 2
+}

package/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to Grafana / Create Plugin
+
+We are always grateful to receive contribution!<br />
+The following guidelines help you on how to start with the codebase and how to submit your work.
+
+## Installation
+
+### Prerequisites
+
+You need to have `npm` or `yarn` installed.
+
+### Installing
+
+```bash
+git clone git@github.com:grafana/create-plugin.git
+cd create-plugin
+yarn install
+```
+
+## Overview
+
+### Technologies
+
+- [**`Plop`**](https://github.com/plopjs/plop) - we are using Plop for the CLI tool and for scaffolding
+
+### Folder structure
+
+_Work in progress._
+
+## Development
+
+### Conventions
+
+_Work in progress._
+
+### Developing the templates
+
+_Work in progress._
+
+### Submitting a Pull Request
+
+_Work in progress._

package/README.md

@@ -0,0 +1,143 @@
+# Grafana / Create Plugin
+
+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)
+
+**Links**
+
+- [Plugin developer docs](https://grafana.com/docs/grafana/latest/developers/plugins/)
+- [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).
+
+## Create a new plugin
+
+### Quick overview
+
+The following commands scaffold a Grafana plugin inside the `./my-plugin` folder:
+
+```bash
+mkdir my-plugin && cd my-plugin
+yarn create @grafana/plugin
+yarn install
+yarn dev
+```
+
+Alterntives:
+
+#### [`npx`](https://github.com/npm/npx)
+
+```bash
+npx @grafana/create-plugin
+```
+
+#### [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-init)
+
+```bash
+npm init @grafana/plugin
+```
+
+#### [`yarn`](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) (1.x)
+
+```bash
+yarn create @grafana/plugin
+```
+
+#### [`yarn`](https://yarnpkg.com/cli/dlx) (> 2.x)
+
+```bash
+yarn dlx @grafana/create-plugin
+```
+
+---
+
+## Migrate your existing plugin
+
+In case you have an existing plugin previously created using the `@grafana/toolkit` you can use the
+following command to migrate it to the new build tooling:
+
+```bash
+# Run this command from the root of your plugin
+cd ./my-plugin
+
+npx @grafana/create-plugin migrate
+```
+
+### Things to check after migration
+
+- If you have a custom webpack configuration you might need to migrate it. You can read more about customizing or extending the basic configuration [here](templates/common/.config/README.md)
+- Build your plugin. Run `yarn build` to check your plugin builds as intended.
+- Test your plugin. Test your plugin inside grafana to confirm it is working as intended.
+
+---
+
+## Update your plugin build config
+
+**In case your plugin was using `@grafana/toolkit` before make sure to migrate it first using `npx @grafana/create-plugin migrate`.**
+
+As new Grafana versions come out we keep updating our plugin build tooling as well to stay compatible and to make it more performant.
+In order to receive these changes and to make sure your plugin is compatible with the most recent Grafana versions you can use the `update` command,
+that automatically updates the build configuration for you:
+
+```bash
+# Run this command from the root of your plugin
+cd ./my-plugin
+
+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.

package/dist/bin/run.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var minimist_1 = __importDefault(require("minimist"));
+var commands_1 = require("../commands");
+var args = process.argv.slice(2);
+var argv = (0, minimist_1["default"])(args);
+var commands = {
+    migrate: commands_1.migrate,
+    generate: commands_1.generate,
+    update: commands_1.update
+};
+var command = commands[argv._[0]] || commands.generate;
+command(argv);

package/dist/commands/generate.command.js

@@ -0,0 +1,56 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.generate = void 0;
+var path_1 = __importDefault(require("path"));
+var plop_1 = require("plop");
+var generate = function (argv) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        plop_1.Plop.launch({
+            cwd: argv.cwd,
+            configPath: path_1["default"].join(__dirname, 'generate.plopfile.js'),
+            require: argv.require,
+            completion: argv.completion
+        }, function (env) { return (0, plop_1.run)(env, undefined, true); });
+        return [2];
+    });
+}); };
+exports.generate = generate;

package/dist/commands/generate.plopfile.js

@@ -0,0 +1,119 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var glob_1 = __importDefault(require("glob"));
+var path_1 = __importDefault(require("path"));
+var fs_1 = __importDefault(require("fs"));
+var utils_handlebars_1 = require("../utils/utils.handlebars");
+var constants_1 = require("../constants");
+function default_1(plop) {
+    plop.setHelper('if_eq', utils_handlebars_1.ifEq);
+    plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
+    plop.setGenerator('create-plugin', {
+        description: 'used to scaffold a grafana plugin',
+        prompts: [
+            {
+                name: 'pluginName',
+                type: 'input',
+                message: 'What is going to be the name of your plugin?'
+            },
+            {
+                name: 'orgName',
+                type: 'input',
+                message: 'What is the organization name of your plugin?',
+                "default": 'my-org'
+            },
+            {
+                name: 'pluginDescription',
+                type: 'input',
+                message: 'How would you describe your plugin?',
+                "default": '<plugin description>'
+            },
+            {
+                name: 'pluginType',
+                type: 'list',
+                choices: [constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel],
+                message: 'What kind of plugin would you like? '
+            },
+            {
+                name: 'hasBackend',
+                type: 'confirm',
+                message: 'Do you want a backend part of your plugin?',
+                "default": false
+            },
+            {
+                name: 'hasGithubWorkflows',
+                type: 'confirm',
+                message: 'Do you want to add Github CI and Release workflows?',
+                "default": false
+            },
+            {
+                name: 'hasGithubLevitateWorkflow',
+                type: 'confirm',
+                message: 'Do you want to add a Github workflow for automatically checking "Grafana API compatibility" on PRs?',
+                "default": false
+            },
+        ],
+        actions: function (_a) {
+            var pluginType = _a.pluginType, hasBackend = _a.hasBackend, hasGithubWorkflows = _a.hasGithubWorkflows, hasGithubLevitateWorkflow = _a.hasGithubLevitateWorkflow;
+            var commonActions = getActionsForTemplateFolder(constants_1.TEMPLATE_PATHS.common);
+            var pluginTypeSpecificActions = getActionsForTemplateFolder(constants_1.TEMPLATE_PATHS[pluginType]);
+            var backendActions = hasBackend ? getActionsForTemplateFolder(constants_1.TEMPLATE_PATHS.backend) : [];
+            var ciWorkflowActions = hasGithubWorkflows ? getActionsForTemplateFolder(constants_1.TEMPLATE_PATHS.ciWorkflows) : [];
+            var isCompatibleWorkflowActions = hasGithubLevitateWorkflow
+                ? getActionsForTemplateFolder(constants_1.TEMPLATE_PATHS.isCompatibleWorkflow)
+                : [];
+            var readmeActions = getActionsForReadme();
+            return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], commonActions, true), pluginTypeSpecificActions, true), backendActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true);
+        }
+    });
+}
+exports["default"] = default_1;
+function getActionsForReadme() {
+    return [
+        replacePatternWithTemplateInReadme('-- INSERT FRONTEND GETTING STARTED --', 'frontend-getting-started.md'),
+        replacePatternWithTemplateInReadme('-- INSERT BACKEND GETTING STARTED --', 'backend-getting-started.md'),
+    ];
+}
+function replacePatternWithTemplateInReadme(pattern, partialsFile) {
+    return {
+        type: 'modify',
+        path: path_1["default"].join(constants_1.EXPORT_PATH_PREFIX, 'README.md'),
+        pattern: pattern,
+        template: undefined,
+        templateFile: path_1["default"].join(constants_1.PARTIALS_DIR, partialsFile),
+        data: constants_1.EXTRA_TEMPLATE_VARIABLES
+    };
+}
+function getActionsForTemplateFolder(folderPath) {
+    var files = glob_1["default"].sync("".concat(folderPath, "/**"), { dot: true });
+    var getExportFileName = function (f) { return (path_1["default"].extname(f) === '.hbs' ? path_1["default"].basename(f, '.hbs') : path_1["default"].basename(f)); };
+    var getExportPath = function (f) { return path_1["default"].relative(folderPath, path_1["default"].dirname(f)); };
+    return files.filter(isFile).map(function (f) { return ({
+        type: 'add',
+        templateFile: f,
+        path: path_1["default"].join(constants_1.EXPORT_PATH_PREFIX, getExportPath(f), getExportFileName(f)),
+        force: constants_1.IS_DEV,
+        abortOnFail: false,
+        data: constants_1.EXTRA_TEMPLATE_VARIABLES
+    }); });
+}
+function isFile(path) {
+    try {
+        return fs_1["default"].lstatSync(path).isFile();
+    }
+    catch (e) {
+        return false;
+    }
+}

package/dist/commands/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+exports.__esModule = true;
+__exportStar(require("./generate.command"), exports);
+__exportStar(require("./update.command"), exports);
+__exportStar(require("./migrate.command"), exports);