@grafana/plugin-meta-extractor 0.0.1-canary.805.cbc58e2.0 → 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.0.1 (Fri May 03 2024)
+
+#### 🐛 Bug Fix
+
+- Plugin Meta Extractor: Initial version [#805](https://github.com/grafana/plugin-tools/pull/805) ([@mckn](https://github.com/mckn) [@leventebalogh](https://github.com/leventebalogh))
+
+#### Authors: 2
+
+- Levente Balogh ([@leventebalogh](https://github.com/leventebalogh))
+- Marcus Andersson ([@mckn](https://github.com/mckn))

package/README.md

@@ -1,8 +1,6 @@
 # Grafana / Plugin Meta Extractor
 
-`@grafana/plugin-meta-extractor` is a small package that can be used to extract meta-information from the source code of a Grafana plugin. The main use case is to be able to automatically generate static information for a plugin without the need for manual intervention, which can help Grafana core to understand when a plugin that registers extensions should be preloaded without running the plugin code.
-
-(If you are developing a plugin there is nothing that you _have to_ do - only make sure that your plugin build workflow is up-to-date by running `npx @grafana/create-plugin@latest update`, and the build config will run this tool in the background.)
+`@grafana/plugin-meta-extractor` is a cli tool that can be used to extract meta-information from the source code of a Grafana plugin. It is used to generate plugin metadata without the need for manual intervention, which is then used by the Grafana application to understand features or functionalities a plugin supports or uses.
 
 ## Install
 
@@ -14,7 +12,7 @@ npm install @grafana/plugin-meta-extractor --save-dev
 
 #### With Webpack
 
-The package exposes a webpack plugin that can be used to generate plugin meta-information on every build based on the source code. The plugin is adding the information to the `plugin.json` file by overriding the `generated` property in the JSON.
+The package exposes a webpack plugin that can be used to generate plugin meta-information on every build based on the source code. The plugin adds additional information to the `plugin.json` file by overriding the `generated` property in the JSON.
 
 ```ts
 // webpack.config.ts
@@ -71,7 +69,7 @@ The returned meta-data is in the following format:
 
 ## Plugin support
 
-At this point the tool requires the `module.(ts|tsx)` to be in a certain format to be able to parse it (we are planning to improve on this in the future). The method calls for registering extensions have to be in the `module.(ts|tsx)`, and they need to be called on the `AppPlugin` instance in a "chained" manner:
+This package requires the `module.(ts|tsx)` to be in a certain format to be able to parse it (we are planning to improve on this in the future). The method calls for registering extensions have to be in the `module.(ts|tsx)`, and they need to be called on the `AppPlugin` instance in a "chained" manner:
 
 ```ts
 // src/module.ts

package/dist/bin/run.js

@@ -17,7 +17,7 @@ if (!fs.existsSync(entryPath)) {
 }
 // Check if it is a module file
 const fileName = entryPath.split('/').pop();
-if (!fileName?.match(/^(module\.ts|module\.tsx)$/)) {
+if (!fileName?.match(/^(module\.tsx?)$/)) {
     console.error(`The tool can only run against a "module.ts" or "module.tsx" plugin file.\nThe following path is invalid: "${entryPath}".`);
     process.exit(1);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-meta-extractor",
-  "version": "0.0.1-canary.805.cbc58e2.0",
+  "version": "0.0.1",
   "description": "Extract meta information from a Grafana plugin source code.",
   "types": "./dist/index.d.ts",
   "bin": "./dist/bin/run.js",
@@ -44,5 +44,5 @@
     "react": "^18.2.0",
     "ts-jest": "^29.1.2"
   },
-  "gitHead": "cbc58e2c9f1a0553e881b23a4ef53a04c61fb175"
+  "gitHead": "5533099402b7b5f626223a8d58592984c45b13eb"
 }

package/src/bin/run.ts

@@ -19,7 +19,7 @@ if (!fs.existsSync(entryPath)) {
 
 // Check if it is a module file
 const fileName = entryPath.split('/').pop();
-if (!fileName?.match(/^(module\.ts|module\.tsx)$/)) {
+if (!fileName?.match(/^(module\.tsx?)$/)) {
   console.error(
     `The tool can only run against a "module.ts" or "module.tsx" plugin file.\nThe following path is invalid: "${entryPath}".`
   );