@grafana/create-plugin 2.2.2 → 2.2.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v2.2.3 (Tue Oct 24 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Fix wrongly named files when upgrading/migrating [#490](https://github.com/grafana/plugin-tools/pull/490) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v2.2.2 (Mon Oct 23 2023)
 
 #### 🐛 Bug Fix

package/dist/commands/generate.plopfile.js

@@ -33,6 +33,7 @@ var utils_packageManager_1 = require("../utils/utils.packageManager");
 var print_success_message_1 = require("./generate-actions/print-success-message");
 var update_go_sdk_and_packages_1 = require("./generate-actions/update-go-sdk-and-packages");
 var prettify_files_1 = require("./generate-actions/prettify-files");
+var utils_files_1 = require("../utils/utils.files");
 function default_1(plop) {
     plop.setHelper('if_eq', utils_handlebars_1.ifEq);
     plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
@@ -185,31 +186,18 @@ function getActionsForTemplateFolder(_a) {
     if (templateData.packageManagerName !== 'pnpm') {
         files = files.filter(function (file) { return path_1.default.basename(file) !== 'npmrc'; });
     }
-    function getExportFileName(f) {
-        var baseName = path_1.default.basename(f);
-        if (Object.keys(configFileNamesMap).includes(baseName)) {
-            return configFileNamesMap[baseName];
-        }
-        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));
     }
     return files.filter(isFile).map(function (f) { return ({
         type: 'add',
         templateFile: f,
-        path: path_1.default.join(exportPath, getExportPath(f), getExportFileName(f)),
+        path: path_1.default.join(exportPath, getExportPath(f), (0, utils_files_1.getExportFileName)(f)),
         force: constants_1.IS_DEV,
         abortOnFail: false,
         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/utils.files.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFileStartingWith = exports.removeFilesInCwd = exports.getOnlyNotExistingInCwd = exports.getOnlyExistingInCwd = exports.readJsonFile = exports.isFile = exports.filterOutCommonFiles = void 0;
+exports.isFileStartingWith = exports.getExportFileName = exports.removeFilesInCwd = exports.getOnlyNotExistingInCwd = exports.getOnlyExistingInCwd = exports.readJsonFile = exports.isFile = exports.filterOutCommonFiles = void 0;
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
 var constants_1 = require("../constants");
@@ -52,6 +52,20 @@ function removeFilesInCwd(files) {
     }
 }
 exports.removeFilesInCwd = removeFilesInCwd;
+function getExportFileName(f) {
+    var baseName = path_1.default.basename(f);
+    if (Object.keys(configFileNamesMap).includes(baseName)) {
+        return configFileNamesMap[baseName];
+    }
+    return path_1.default.extname(f) === '.hbs' ? path_1.default.basename(f, '.hbs') : baseName;
+}
+exports.getExportFileName = getExportFileName;
+var configFileNamesMap = {
+    gitignore: '.gitignore',
+    npmrc: '.npmrc',
+    _eslintrc: '.eslintrc',
+    '_package.json': 'package.json',
+};
 function isFileStartingWith(file, filter) {
     if (Array.isArray(filter)) {
         return filter.some(function (f) { return file.startsWith(f); });

package/dist/utils/utils.templates.js

@@ -33,6 +33,7 @@ var utils_handlebars_1 = require("./utils.handlebars");
 var utils_plugin_1 = require("./utils.plugin");
 var constants_1 = require("../constants");
 var utils_packageManager_1 = require("./utils.packageManager");
+var utils_files_2 = require("../utils/utils.files");
 function getTemplateFiles(pluginType, filter) {
     var commonFiles = glob_1.default.sync("".concat(constants_1.TEMPLATE_PATHS.common, "/**"), { dot: true });
     var pluginTypeSpecificFiles = glob_1.default.sync("".concat(constants_1.TEMPLATE_PATHS[pluginType], "/**"), { dot: true });
@@ -61,7 +62,7 @@ function compileSingleTemplateFile(pluginType, templateFile, data) {
     }
     var rendered = renderTemplateFromFile(templateFile, data);
     var relativeExportPath = templateFile.replace(constants_1.TEMPLATE_PATHS.common, '').replace(constants_1.TEMPLATE_PATHS[pluginType], '');
-    var exportPath = path_1.default.join(constants_1.EXPORT_PATH_PREFIX, relativeExportPath);
+    var exportPath = path_1.default.join(constants_1.EXPORT_PATH_PREFIX, path_1.default.dirname(relativeExportPath), (0, utils_files_2.getExportFileName)(templateFile));
     mkdirp_1.default.sync(path_1.default.dirname(exportPath));
     fs_1.default.writeFileSync(exportPath, rendered);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "37c4128d0cbf095ba8644938b0b503566029d0bf"
+  "gitHead": "2ea414b13f32a3e9e0e68c703e5d8cf6ff0c08d9"
 }

package/src/commands/generate.plopfile.ts

@@ -10,6 +10,7 @@ import { printGenerateSuccessMessage } from './generate-actions/print-success-me
 import { updateGoSdkAndModules } from './generate-actions/update-go-sdk-and-packages';
 import { prettifyFiles } from './generate-actions/prettify-files';
 import { CliArgs, TemplateData } from './types';
+import { getExportFileName } from '../utils/utils.files';
 
 // Plopfile API documentation: https://plopjs.com/documentation/#plopfile-api
 export default function (plop: NodePlopAPI) {
@@ -236,16 +237,6 @@ function getActionsForTemplateFolder({
     files = files.filter((file) => path.basename(file) !== 'npmrc');
   }
 
-  function getExportFileName(f: string) {
-    const baseName = path.basename(f);
-
-    if (Object.keys(configFileNamesMap).includes(baseName)) {
-      return configFileNamesMap[baseName];
-    }
-
-    return path.extname(f) === '.hbs' ? path.basename(f, '.hbs') : baseName;
-  }
-
   function getExportPath(f: string) {
     return path.relative(folderPath, path.dirname(f));
   }
@@ -266,16 +257,6 @@ 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/utils.files.ts

@@ -50,6 +50,26 @@ export function removeFilesInCwd(files: string[]) {
   }
 }
 
+export function getExportFileName(f: string) {
+  const baseName = path.basename(f);
+
+  if (Object.keys(configFileNamesMap).includes(baseName)) {
+    return configFileNamesMap[baseName];
+  }
+
+  return path.extname(f) === '.hbs' ? path.basename(f, '.hbs') : baseName;
+}
+
+// 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',
+};
+
 /**
  * Returns TRUE if the file is starting with any of the provided string filters.
  *

package/src/utils/utils.templates.ts

@@ -7,6 +7,7 @@ import { renderHandlebarsTemplate } from './utils.handlebars';
 import { getPluginJson } from './utils.plugin';
 import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants';
 import { getPackageManagerWithFallback } from './utils.packageManager';
+import { getExportFileName } from '../utils/utils.files';
 
 /**
  *
@@ -52,7 +53,7 @@ export function compileSingleTemplateFile(pluginType: string, templateFile: stri
 
   const rendered = renderTemplateFromFile(templateFile, data);
   const relativeExportPath = templateFile.replace(TEMPLATE_PATHS.common, '').replace(TEMPLATE_PATHS[pluginType], '');
-  const exportPath = path.join(EXPORT_PATH_PREFIX, relativeExportPath);
+  const exportPath = path.join(EXPORT_PATH_PREFIX, path.dirname(relativeExportPath), getExportFileName(templateFile));
 
   mkdirp.sync(path.dirname(exportPath));
   fs.writeFileSync(exportPath, rendered);