@grafana/create-plugin 0.10.0 → 1.0.0-canary.193.70e38b4.0

package/CHANGELOG.md

@@ -1,15 +1,3 @@
-# v0.10.0 (Thu Feb 02 2023)
-
-#### 🚀 Enhancement
-
-- CreatePlugin: Change default docker image to grafana-enterprise [#197](https://github.com/grafana/plugin-tools/pull/197) ([@mckn](https://github.com/mckn))
-
-#### Authors: 1
-
-- Marcus Andersson ([@mckn](https://github.com/mckn))
-
----
-
 # v0.9.1 (Thu Feb 02 2023)
 
 #### 🐛 Bug Fix

package/README.md

@@ -12,13 +12,13 @@ Create Grafana plugins with ease.
       - [`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**
 
+- [Plugin Tools docs](https://grafana.github.io/plugin-tools/)
 - [Plugin developer docs](https://grafana.com/docs/grafana/latest/developers/plugins/)
 - [Plugin migration guide](https://grafana.com/docs/grafana/latest/developers/plugins/migration-guide/)
 
@@ -61,6 +61,7 @@ npm init @grafana/plugin
 ---
 
 ## Migrate your existing plugin
+
 :warning: We [do not support](https://grafana.com/docs/grafana/latest/developers/angular_deprecation/) plugins written in `angular`
 
 In case you have an existing plugin previously created using the `@grafana/toolkit` you can use the
@@ -73,11 +74,7 @@ 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.
+For more information see [here](https://grafana.github.io/plugin-tools/docs/migrating-from-toolkit)
 
 ---
 
@@ -96,11 +93,13 @@ cd ./my-plugin
 npx @grafana/create-plugin update
 ```
 
+For more information see [here](https://grafana.github.io/plugin-tools/docs/updating-to-new-releases)
+
 ---
 
 ## Customizing or extending the basic configs
 
-You can read more about customizing or extending the basic configuration [here](templates/common/.config/README.md)
+You can read more about customizing or extending the basic configuration [here](https://grafana.github.io/plugin-tools/docs/advanced-configuration/)
 
 ## Contributing
 

package/dist/bin/run.js

@@ -11,7 +11,8 @@ var argv = (0, minimist_1["default"])(args);
 var commands = {
     migrate: commands_1.migrate,
     generate: commands_1.generate,
-    update: commands_1.update
+    update: commands_1.update,
+    version: commands_1.version
 };
 var command = commands[argv._[0]] || commands.generate;
 command(argv);

package/dist/commands/index.js

@@ -17,3 +17,4 @@ exports.__esModule = true;
 __exportStar(require("./generate.command"), exports);
 __exportStar(require("./update.command"), exports);
 __exportStar(require("./migrate.command"), exports);
+__exportStar(require("./version.command"), exports);

package/dist/commands/version.command.js

@@ -0,0 +1,63 @@
+"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 };
+    }
+};
+exports.__esModule = true;
+exports.version = void 0;
+var path_1 = require("path");
+var fs_1 = require("fs");
+var version = function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        try {
+            console.log(getVersion());
+        }
+        catch (error) {
+            console.error(error);
+            process.exit(1);
+        }
+        return [2];
+    });
+}); };
+exports.version = version;
+var getVersion = function () {
+    var packageJsonPath = (0, path_1.resolve)(__dirname, '..', '..', 'package.json');
+    var pkg = (0, fs_1.readFileSync)(packageJsonPath, 'utf8');
+    var version = JSON.parse(pkg).version;
+    if (!version) {
+        throw "Could not find the version of sign-plugin";
+    }
+    return version;
+};

package/dist/constants.js

@@ -80,7 +80,7 @@ exports.TEXT = {
     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: "\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  ",
+    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://grafana.github.io/plugin-tools/docs/advanced-configuration/\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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.10.0",
+  "version": "1.0.0-canary.193.70e38b4.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "4528730fa262596399c6e1b0158311ae31bf64bd"
+  "gitHead": "70e38b4e71526b3a2a3af29e646777b949ef3a04"
 }

package/src/bin/run.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import minimist from 'minimist';
-import { generate, update, migrate } from '../commands';
+import { generate, update, migrate, version } from '../commands';
 
 const args = process.argv.slice(2);
 const argv = minimist(args);
@@ -9,6 +9,7 @@ const commands: Record<string, (argv: minimist.ParsedArgs) => void> = {
   migrate,
   generate,
   update,
+  version,
 };
 const command = commands[argv._[0]] || commands.generate;
 

package/src/commands/index.ts

@@ -1,3 +1,4 @@
 export * from './generate.command';
 export * from './update.command';
 export * from './migrate.command';
+export * from './version.command';

package/src/commands/version.command.ts

@@ -0,0 +1,21 @@
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+
+export const version = async () => {
+  try {
+    console.log(getVersion());
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+};
+
+const getVersion = () => {
+  const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');
+  const pkg = readFileSync(packageJsonPath, 'utf8');
+  const { version } = JSON.parse(pkg);
+  if (!version) {
+    throw `Could not find the version of sign-plugin`;
+  }
+  return version;
+};

package/src/constants.ts

@@ -115,7 +115,7 @@ export const TEXT = {
  * 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
+See instructions on how to customize your configuration here https://grafana.github.io/plugin-tools/docs/advanced-configuration/
   `,
 
   updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',

package/templates/common/.config/.eslintrc

@@ -1,7 +1,8 @@
 /*
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
- * In order to extend the configuration follow the steps in .config/README.md
+ * In order to extend the configuration follow the steps in
+ * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-eslint-config
  */
  {
   "extends": ["@grafana/eslint-config"],

package/templates/common/.config/Dockerfile

@@ -1,7 +1,6 @@
 ARG grafana_version=latest
-ARG grafana_image=grafana-enterprise
 
-FROM grafana/${grafana_image}:${grafana_version}
+FROM grafana/grafana:${grafana_version}
 
 # Make it as simple as possible to access the grafana instance for development purposes
 # Do NOT enable these settings in a public facing / production grafana instance

package/templates/common/.config/README.md

@@ -139,26 +139,3 @@ We need to update the `scripts` in the `package.json` to use the extended Webpac
 -"dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
 +"dev": "webpack -w -c ./webpack.config.ts --env development",
 ```
-
-### Configure grafana image to use when running docker
-
-By default `grafana-enterprise` will be used as the docker image for all docker related commands. If you want to override this behaviour simply alter the `docker-compose.yaml` by adding the following build arg `grafana_image`. 
-
-**Example:**
-
-```yaml
-version: '3.7'
-
-services:
-  grafana:
-    container_name: 'myorg-basic-app'
-    build:
-      context: ./.config
-      args:
-        grafana_version: ${GRAFANA_VERSION:-9.1.2}
-        grafana_image: ${GRAFANA_IMAGE:-grafana}
-```
-
-In this example we are assigning the environment variable `GRAFANA_IMAGE` to the build arg `grafana_image` with a default value of `grafana`. This will give you the possibility to set the value while running the docker-compose commands which might be convinent in some scenarios.
-
----

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

@@ -1,7 +1,8 @@
 /*
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
- * In order to extend the configuration follow the steps in .config/README.md
+ * In order to extend the configuration follow the steps in
+ * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-jest-config
  */
 
 import '@testing-library/jest-dom';

package/templates/common/.config/tsconfig.json

@@ -1,7 +1,8 @@
 /*
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
- * In order to extend the configuration follow the steps in .config/README.md
+ * In order to extend the configuration follow the steps in
+ * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-typescript-config
  */
  {
   "compilerOptions": {

package/templates/common/.config/webpack/webpack.config.ts

@@ -1,7 +1,8 @@
 /*
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
- * In order to extend the configuration follow the steps in .config/README.md
+ * In order to extend the configuration follow the steps in
+ * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-webpack-config
  */
 
 import CopyWebpackPlugin from 'copy-webpack-plugin';