@grafana/create-plugin 5.18.1 → 5.18.2

package/CONTRIBUTING.md

@@ -49,28 +49,52 @@ npm install
 
 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.
 
-### Commmands
-
-Below are the main commands used for developing `create-plugin`. They can be run by either `npx nx run @grafana/create-plugin:<name_of_command>`, `npm run <name_of_command> -w @grafana/create-plugin` or navigating to `packages/create-plugin` and running the command directly as detailed below.
+Development requires linking this application so you can run it in your terminal to see what effect your changes have.
 
 ```shell
-npm run build # used to build @grafana/create-plugin
+npm run build -w @grafana/create-plugin
+npm link -w @grafana/create-plugin
 ```
 
-```shell
-npm run dev # watches for changes to files and rebuilds @grafana/create-plugin automatically
-```
+Run the following commands to confirm the above worked successfully:
 
 ```shell
-npm run dev-app # watches for changes and scaffolds an app plugin (in ./generated) for developing app configs
+which create-plugin
+# /Users/jackwestbrook/.nvm/versions/node/v22.13.0/bin/create-plugin
+npx create-plugin version
+# 5.18.0
 ```
 
+You should now be able to run `npx create-plugin` or `npx create-plugin update` to test out changes locally.
+
+If you see `create-plugin not found` try running `npm unlink -g @grafana/create-plugin` then run the build and link commands again.
+
+### Commmands
+
+Below are the main commands used for developing `create-plugin`. They can be run using either `npx nx run`, `npm run` or navigating to `packages/create-plugin` and running the command directly.
+
+#### Build
+
+Creates a production build of @grafana/create-plugin.
+
 ```shell
-npm run dev-panel # watches for changes and scaffolds an app plugin (in ./generated) for developing panel configs
+npm run build -w @grafana/create-plugin
+# or with nx caching
+npx nx run @grafana/create-plugin:build
+# or from with packages/create-plugin directory
+npm run build
 ```
 
+#### Develop
+
+Creates a development build of @grafana/create-plugin and watches for changes to files and rebuilds automatically.
+
 ```shell
-npm run dev-datasource # watches for changes and scaffolds an app plugin (in ./generated) for developing datasource configs
+npm run dev -w @grafana/create-plugin
+# or with nx
+npx nx run @grafana/create-plugin:dev
+# or from with packages/create-plugin directory
+npm run dev
 ```
 
 ### Conventions

package/dist/constants.js

@@ -2,8 +2,7 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 export const IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
-export const DEV_EXPORT_DIR = path.join(__dirname, '..', 'generated');
-export const EXPORT_PATH_PREFIX = IS_DEV ? DEV_EXPORT_DIR : process.cwd();
+export const EXPORT_PATH_PREFIX = process.cwd();
 export const DIST_DIR = path.join(__dirname, 'dist');
 export const TEMPLATES_DIR = path.join(__dirname, '..', 'templates');
 export const PARTIALS_DIR = path.join(TEMPLATES_DIR, '_partials');

package/dist/utils/utils.path.js

@@ -1,11 +1,5 @@
 import path from 'node:path';
-import { IS_DEV, DEV_EXPORT_DIR } from '../constants.js';
 import { normalizeId } from './utils.handlebars.js';
 export function getExportPath(pluginName, orgName, pluginType) {
-    if (IS_DEV) {
-        return DEV_EXPORT_DIR;
-    }
-    else {
-        return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
-    }
+    return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.18.1",
+  "version": "5.18.2",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -25,16 +25,6 @@
     "clean-generated": "find ./generated -not -path \"./generated/node_modules*\" -not -path \"./generated\" -not -path \"./generated/package-lock.json\" -maxdepth 1 -print0 | xargs -0  -I {} rm -rf {}",
     "build": "npm run clean && tsc && chmod +x ./dist/bin/run.js",
     "dev": "nodemon --exec 'tsc'",
-    "dev-app": "nodemon --exec 'npm run generate-app'",
-    "dev-scenes-app": "nodemon --exec 'npm run generate-scenes-app'",
-    "dev-panel": "nodemon --exec 'npm run generate-panel'",
-    "dev-datasource": "nodemon --exec 'npm run generate-datasource'",
-    "generate-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginType='app' --no-hasBackend",
-    "generate-scenes-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample scenesapp' --orgName='sample-org' --pluginType='scenesapp' --no-hasBackend",
-    "generate-app-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginType='app' --hasBackend",
-    "generate-panel": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample panel' --orgName='sample-org' --pluginType='panel'",
-    "generate-datasource": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginType='datasource' --no-hasBackend",
-    "generate-datasource-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginType='datasource' --hasBackend",
     "lint": "eslint --cache ./src",
     "lint:fix": "npm run lint -- --fix",
     "test": "vitest --passWithNoTests",
@@ -88,5 +78,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "9fb525b65ba89230f6f3d774d1f9e7d4bd88bab4"
+  "gitHead": "4396c62bff668d73e61e073c9e02e7326f47c826"
 }

package/src/constants.ts

@@ -5,9 +5,7 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 export const IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
 
-export const DEV_EXPORT_DIR = path.join(__dirname, '..', 'generated');
-
-export const EXPORT_PATH_PREFIX = IS_DEV ? DEV_EXPORT_DIR : process.cwd();
+export const EXPORT_PATH_PREFIX = process.cwd();
 
 export const DIST_DIR = path.join(__dirname, 'dist');
 

package/src/utils/utils.path.ts

@@ -1,11 +1,7 @@
 import path from 'node:path';
-import { PLUGIN_TYPES, IS_DEV, DEV_EXPORT_DIR } from '../constants.js';
+import { PLUGIN_TYPES } from '../constants.js';
 import { normalizeId } from './utils.handlebars.js';
 
-export function getExportPath(pluginName: string, orgName: string, pluginType: PLUGIN_TYPES): string {
-  if (IS_DEV) {
-    return DEV_EXPORT_DIR;
-  } else {
-    return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
-  }
+export function getExportPath(pluginName: string, orgName: string, pluginType: PLUGIN_TYPES) {
+  return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
 }