@grafana/create-plugin 1.6.0 → 1.6.2

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+# v1.6.2 (Wed Jun 07 2023)
+
+### Release Notes
+
+#### Create Plugin: Introduce OS check ([#263](https://github.com/grafana/plugin-tools/pull/263))
+
+`create-plugin` will now exit when run natively on Windows, which is an unsupported platform with known issues. By exiting early we hope to prevent users from hitting issues whilst developing plugins. We recommend the use of Windows Subsystem for Linux (WSL) which is supported.
+
+---
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Introduce OS check [#263](https://github.com/grafana/plugin-tools/pull/263) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v1.6.1 (Tue Jun 06 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Ben Sully ([@sd2k](https://github.com/sd2k)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Create Plugin: fix 'Install dependencies' command in generated frontend README [#276](https://github.com/grafana/plugin-tools/pull/276) ([@sd2k](https://github.com/sd2k))
+
+#### Authors: 1
+
+- Ben Sully ([@sd2k](https://github.com/sd2k))
+
+---
+
 # v1.6.0 (Tue Jun 06 2023)
 
 #### 🚀 Enhancement

package/dist/bin/run.js

@@ -6,6 +6,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports.__esModule = true;
 var minimist_1 = __importDefault(require("minimist"));
 var commands_1 = require("../commands");
+var utils_os_1 = require("../utils/utils.os");
+if ((0, utils_os_1.isUnsupportedPlatform)()) {
+    console.error("Unsupported operating system 'Windows' detected. Please use WSL with create-plugin.");
+    process.exit(1);
+}
 var args = process.argv.slice(2);
 var argv = (0, minimist_1["default"])(args);
 var commands = {

package/dist/utils/utils.os.js

@@ -0,0 +1,12 @@
+"use strict";
+exports.__esModule = true;
+exports.isUnsupportedPlatform = void 0;
+var os_1 = require("os");
+function isUnsupportedPlatform() {
+    var os = (0, os_1.platform)();
+    if (os === 'win32') {
+        return true;
+    }
+    return false;
+}
+exports.isUnsupportedPlatform = isUnsupportedPlatform;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "e39be36286031d2f39ac5a513eeb319bdfb33891"
+  "gitHead": "8bb2069edfde4077a018ce301be52acce67b7d1d"
 }

package/src/bin/run.ts

@@ -2,6 +2,13 @@
 
 import minimist from 'minimist';
 import { generate, update, migrate, version } from '../commands';
+import { isUnsupportedPlatform } from '../utils/utils.os';
+
+// Exit early if operating system isn't supported.
+if (isUnsupportedPlatform()) {
+  console.error("Unsupported operating system 'Windows' detected. Please use WSL with create-plugin.");
+  process.exit(1);
+}
 
 const args = process.argv.slice(2);
 const argv = minimist(args);

package/src/utils/utils.os.ts

@@ -0,0 +1,11 @@
+import { platform } from 'os';
+
+export function isUnsupportedPlatform() {
+  const os = platform();
+
+  if (os === 'win32') {
+    return true;
+  }
+
+  return false;
+}

package/templates/_partials/frontend-getting-started.md

@@ -3,7 +3,7 @@
 1. Install dependencies
 
    ```bash
-   {{ packageManagerName }} run install
+   {{ packageManagerName }} install
    ```
 
 2. Build plugin in development mode and run in watch mode