@grafana/create-plugin 2.2.0 → 2.2.1-canary.481.f400697.0

package/dist/commands/generate.plopfile.js

@@ -186,13 +186,11 @@ function getActionsForTemplateFolder(_a) {
         files = files.filter(function (file) { return path_1.default.basename(file) !== 'npmrc'; });
     }
     function getExportFileName(f) {
-        if (path_1.default.basename(f) === 'gitignore') {
-            return '.gitignore';
+        var baseName = path_1.default.basename(f);
+        if (Object.keys(configFileNamesMap).includes(baseName)) {
+            return configFileNamesMap[baseName];
         }
-        if (path_1.default.basename(f) === 'npmrc') {
-            return '.npmrc';
-        }
-        return path_1.default.extname(f) === '.hbs' ? path_1.default.basename(f, '.hbs') : path_1.default.basename(f);
+        return path_1.default.extname(f) === '.hbs' ? path_1.default.basename(f, '.hbs') : baseName;
     }
     function getExportPath(f) {
         return path_1.default.relative(folderPath, path_1.default.dirname(f));
@@ -206,6 +204,12 @@ function getActionsForTemplateFolder(_a) {
         data: __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), templateData),
     }); });
 }
+var configFileNamesMap = {
+    gitignore: '.gitignore',
+    npmrc: '.npmrc',
+    _eslintrc: '.eslintrc',
+    '_package.json': 'package.json',
+};
 function isFile(path) {
     try {
         return fs_1.default.lstatSync(path).isFile();

package/dist/utils/tests/utils.templates.test.js

@@ -19,7 +19,7 @@ describe('Utils / Templates', function () {
             expect(templateFiles.length).toBe(0);
         });
         test('should be possible to filter for multiple different files', function () {
-            var templateFiles = (0, utils_templates_1.getTemplateFiles)(constants_1.PLUGIN_TYPES.app, ['.eslintrc', '.prettierrc.js', 'tsconfig.json']);
+            var templateFiles = (0, utils_templates_1.getTemplateFiles)(constants_1.PLUGIN_TYPES.app, ['.prettierrc.js', 'cypress.json', 'tsconfig.json']);
             expect(Array.isArray(templateFiles)).toBe(true);
             expect(templateFiles.length).toBe(3);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.2.0",
+  "version": "2.2.1-canary.481.f400697.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "67123c677a1ecc23d0d83249b353bd2e467779e4"
+  "gitHead": "f40069751aa92d8136651fefac2bf57b1cd15c4d"
 }

package/src/commands/generate.plopfile.ts

@@ -237,16 +237,13 @@ function getActionsForTemplateFolder({
   }
 
   function getExportFileName(f: string) {
-    // yarn and npm packing will not include `.gitignore` files
-    // so we have to manually rename them to add the dot prefix
-    if (path.basename(f) === 'gitignore') {
-      return '.gitignore';
-    }
-    if (path.basename(f) === 'npmrc') {
-      return '.npmrc';
+    const baseName = path.basename(f);
+
+    if (Object.keys(configFileNamesMap).includes(baseName)) {
+      return configFileNamesMap[baseName];
     }
 
-    return path.extname(f) === '.hbs' ? path.basename(f, '.hbs') : path.basename(f);
+    return path.extname(f) === '.hbs' ? path.basename(f, '.hbs') : baseName;
   }
 
   function getExportPath(f: string) {
@@ -269,6 +266,16 @@ function getActionsForTemplateFolder({
   }));
 }
 
+// yarn and npm packing will not include `.gitignore` files
+// so we have to manually rename them to add the dot prefix
+// other config files trip up the tooling in the plugin-tools monorepo
+const configFileNamesMap: Record<string, string> = {
+  gitignore: '.gitignore',
+  npmrc: '.npmrc',
+  _eslintrc: '.eslintrc',
+  '_package.json': 'package.json',
+};
+
 function isFile(path: string) {
   try {
     return fs.lstatSync(path).isFile();

package/src/utils/tests/utils.templates.test.ts

@@ -28,7 +28,7 @@ describe('Utils / Templates', () => {
     });
 
     test('should be possible to filter for multiple different files', () => {
-      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, ['.eslintrc', '.prettierrc.js', 'tsconfig.json']);
+      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, ['.prettierrc.js', 'cypress.json', 'tsconfig.json']);
 
       expect(Array.isArray(templateFiles)).toBe(true);
       expect(templateFiles.length).toBe(3);

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

@@ -1,6 +1,6 @@
 ### Backend
 
-1. Update [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/) dependency to the latest minor version:
+1. Update [Grafana plugin SDK for Go](https://grafana.com/developers/plugin-tools/introduction/grafana-plugin-sdk-for-go) dependency to the latest minor version:
 
    ```bash
    go get -u github.com/grafana/grafana-plugin-sdk-go

package/templates/_partials/distributing-your-plugin.md

@@ -6,11 +6,11 @@ _Note: It's not necessary to sign a plugin during development. The docker develo
 
 ## Initial steps
 
-Before signing a plugin please read the Grafana [plugin publishing and signing criteria](https://grafana.com/docs/grafana/latest/developers/plugins/publishing-and-signing-criteria/) documentation carefully.
+Before signing a plugin please read the Grafana [plugin publishing and signing criteria](https://grafana.com/legal/plugins/#plugin-publishing-and-signing-criteria) documentation carefully.
 
 `@grafana/create-plugin` has added the necessary commands and workflows to make signing and distributing a plugin via the grafana plugins catalog as straightforward as possible.
 
-Before signing a plugin for the first time please consult the Grafana [plugin signature levels](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#plugin-signature-levels) documentation to understand the differences between the types of signature level.
+Before signing a plugin for the first time please consult the Grafana [plugin signature levels](https://grafana.com/legal/plugins/#what-are-the-different-classifications-of-plugins) documentation to understand the differences between the types of signature level.
 
 1. Create a [Grafana Cloud account](https://grafana.com/signup).
 2. Make sure that the first part of the plugin ID matches the slug of your Grafana Cloud account.

package/templates/app/README.md

@@ -19,4 +19,4 @@ Below you can find source code for existing app plugins and other related docume
 
 - [Basic app plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/app-basic#readme)
 - [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference-plugin-json)
-- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/)
+- [How to sign a plugin?](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)

package/templates/backend/pkg/plugin/datasource.go

@@ -74,7 +74,7 @@ func (d *Datasource) query(_ context.Context, pCtx backend.PluginContext, query
 
 	// create data frame response.
 	// For an overview on data frames and how grafana handles them:
-	// https://grafana.com/docs/grafana/latest/developers/plugins/data-frames/
+	// https://grafana.com/developers/plugin-tools/introduction/data-frames
 	frame := data.NewFrame("response")
 
 	// add fields.

package/templates/common/src/README.md

@@ -33,7 +33,7 @@ Consider other [badges](https://shields.io/badges) as you feel appropriate for y
 Provide one or more paragraphs as an introduction to your plugin to help users understand why they should use it.  
 
 Consider including screenshots:
-- in [plugin.json](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/#info) include them as relative links.
+- in [plugin.json](https://grafana.com/developers/plugin-tools/reference-plugin-json#info) include them as relative links.
 - in the README ensure they are absolute URLs.
 
 ## Requirements

package/templates/datasource/README.md

@@ -19,4 +19,4 @@ Below you can find source code for existing app plugins and other related docume
 
 - [Basic data source plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/datasource-basic#readme)
 - [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference-plugin-json)
-- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/)
+- [How to sign a plugin?](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)

package/templates/github/ci/.github/workflows/release.yml

@@ -61,7 +61,7 @@ jobs:
 
       - name: Warn missing Grafana access policy token
         run: |
-          echo Please generate a Grafana access policy token: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-a-token
+          echo Please generate a Grafana access policy token: https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token
           echo Once done please follow the instructions found here: https://github.com/$\{{github.repository}}/blob/main/README.md#using-github-actions-release-workflow
         if: $\{{ env.GRAFANA_ACCESS_POLICY_TOKEN == '' }}
 

package/templates/panel/README.md

@@ -20,4 +20,4 @@ Below you can find source code for existing app plugins and other related docume
 
 - [Basic panel plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/panel-basic#readme)
 - [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference-plugin-json)
-- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/)
+- [How to sign a plugin?](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)