@grafana/create-plugin 0.1.1 → 0.2.0

package/dist/commands/migrate.command.js

@@ -120,6 +120,7 @@ var migrate = function () { return __awaiter(void 0, void 0, void 0, function ()
                 else {
                     (0, utils_console_1.printMessage)(constants_1.TEXT.updateNpmScriptsAborted);
                 }
+                (0, utils_npm_1.cleanUpPackageJson)();
                 (0, utils_console_1.printSuccessMessage)(constants_1.TEXT.migrationCommandSuccess);
                 return [3, 12];
             case 11:

package/dist/utils/utils.npm.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.updateNpmScripts = exports.removeNpmDependencies = exports.getRemovableNpmDependencies = exports.getUpdatableNpmDependencies = exports.getPackageJsonUpdates = exports.updateNpmDependencies = exports.updatePackageJson = exports.hasNpmDependenciesToUpdate = exports.getPackageJsonUpdatesAsText = exports.getNpmDependencyUpdatesAsText = exports.writePackageJson = exports.getLatestPackageJson = exports.getPackageJson = void 0;
+exports.cleanUpPackageJson = exports.updateNpmScripts = exports.removeNpmDependencies = exports.getRemovableNpmDependencies = exports.getUpdatableNpmDependencies = exports.getPackageJsonUpdates = exports.updateNpmDependencies = exports.updatePackageJson = exports.hasNpmDependenciesToUpdate = exports.getPackageJsonUpdatesAsText = exports.getNpmDependencyUpdatesAsText = exports.writePackageJson = exports.getLatestPackageJson = exports.getPackageJson = void 0;
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
 var semver_1 = __importDefault(require("semver"));
@@ -160,3 +160,19 @@ function updateNpmScripts() {
     writePackageJson(packageJson);
 }
 exports.updateNpmScripts = updateNpmScripts;
+function cleanUpPackageJson() {
+    var packageJson = getPackageJson();
+    packageJson.scripts = sortKeysAlphabetically(packageJson.scripts);
+    packageJson.dependencies = sortKeysAlphabetically(packageJson.dependencies);
+    packageJson.devDependencies = sortKeysAlphabetically(packageJson.devDependencies);
+    writePackageJson(packageJson);
+}
+exports.cleanUpPackageJson = cleanUpPackageJson;
+function sortKeysAlphabetically(obj) {
+    return Object.keys(obj)
+        .sort()
+        .reduce(function (acc, key) {
+        acc[key] = obj[key];
+        return acc;
+    }, {});
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "main": "index.js",
   "repository": "git@github.com:grafana/create-plugin.git",
   "author": "Grafana",

package/src/commands/migrate.command.ts

@@ -9,6 +9,7 @@ import {
   getRemovableNpmDependencies,
   removeNpmDependencies,
   updateNpmScripts,
+  cleanUpPackageJson,
 } from '../utils/utils.npm';
 
 export const migrate = async () => {
@@ -90,7 +91,11 @@ export const migrate = async () => {
       printMessage(TEXT.updateNpmScriptsAborted);
     }
 
-    // 4. Summary
+    // Tidy package.json file so any changed fields are sorted as a
+    // package manager would expect.
+    cleanUpPackageJson();
+
+    // 7. Summary
     // -------------
     printSuccessMessage(TEXT.migrationCommandSuccess);
   } catch (error) {

package/src/utils/utils.npm.ts

@@ -187,3 +187,20 @@ export function updateNpmScripts() {
 
   writePackageJson(packageJson);
 }
+
+export function cleanUpPackageJson() {
+  const packageJson = getPackageJson();
+  packageJson.scripts = sortKeysAlphabetically(packageJson.scripts);
+  packageJson.dependencies = sortKeysAlphabetically(packageJson.dependencies);
+  packageJson.devDependencies = sortKeysAlphabetically(packageJson.devDependencies);
+  writePackageJson(packageJson);
+}
+
+function sortKeysAlphabetically(obj: Record<string, string>) {
+  return Object.keys(obj)
+    .sort()
+    .reduce<Record<string, string>>((acc, key) => {
+      acc[key] = obj[key];
+      return acc;
+    }, {});
+}

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

@@ -45,6 +45,7 @@ const config = async (env): Promise<Configuration> => ({
     'react-redux',
     'redux',
     'rxjs',
+    'react-router',
     'react-router-dom',
     'd3',
     'angular',

package/templates/common/docker-compose.yaml

@@ -3,12 +3,12 @@ version: '3.0'
 services:
   grafana:
     container_name: '{{ kebabCase pluginName }}'
-    build: 
+    build:
       context: ./.config
       args:
         grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }
     ports:
       - 3000:3000/tcp
     volumes:
-      - ./dist:/var/lib/grafana/plugins/{{ kebabCase pluginName }},
+      - ./dist:/var/lib/grafana/plugins/{{ kebabCase pluginName }}
       - ./provisioning:/etc/grafana/provisioning

package/templates/common/package.json

@@ -28,7 +28,8 @@
     "@testing-library/jest-dom": "^5.16.2",
     "@testing-library/react": "^12.1.3",
     "@types/glob": "^8.0.0",
-    "@types/jest": "^27.4.1",{{#if_eq pluginType "app"}}
+    "@types/jest": "^27.4.1",
+    "@types/lodash": "latest",{{#if_eq pluginType "app"}}
     "@types/react-router-dom": "^5.3.3",{{/if_eq}}
     "@types/node": "^17.0.19",
     "@typescript-eslint/eslint-plugin": "^4.33.0",
@@ -62,8 +63,8 @@
     "@grafana/data": "{{ grafanaVersion }}",
     "@grafana/runtime": "{{ grafanaVersion }}",
     "@grafana/ui": "{{ grafanaVersion }}",
-    "@types/lodash": "latest"{{#if_eq pluginType "app"}},
-    "react-router-dom": "^5.2.0"
-    {{/if_eq}}
+    "react": "17.0.2",
+    "react-dom": "17.0.2"{{#if_eq pluginType "app"}},
+    "react-router-dom": "^5.2.0"{{/if_eq}}
   }
 }