@grafana/create-plugin 3.5.0 → 3.6.0-canary.669.68b0597.0

package/dist/commands/generate.command.js

@@ -11,7 +11,7 @@ import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile } from '../utils/utils.templates.js';
 import { getVersion } from '../utils/utils.version.js';
-import { prettifyFiles } from './generate/prettify-files.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 import { printGenerateSuccessMessage } from './generate/print-success-message.js';
 import { promptUser } from './generate/prompt-user.js';
 import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages.js';
@@ -36,7 +36,7 @@ export const generate = async (argv) => {
     if (answers.hasBackend) {
         await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
     }
-    await execPostScaffoldFunction(prettifyFiles, exportPath);
+    await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
     printGenerateSuccessMessage(answers);
 };
 function getTemplateData(answers) {

package/dist/commands/update.command.js

@@ -3,9 +3,10 @@ import { TEXT, UDPATE_CONFIG } from '../constants.js';
 import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates.js';
 import { confirmPrompt, selectPrompt, printMessage, printSuccessMessage, printRedBox } from '../utils/utils.console.js';
 import { updatePackageJson, hasNpmDependenciesToUpdate, getPackageJsonUpdatesAsText, updateNpmScripts, writePackageManagerInPackageJson, } from '../utils/utils.npm.js';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory } from '../utils/utils.plugin.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 export const update = async (argv) => {
     try {
         if (!(await isGitDirectory()) && !argv.force) {
@@ -38,6 +39,8 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         if (await confirmPrompt(TEXT.updateConfigPrompt)) {
             compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
             printSuccessMessage(TEXT.overrideFilesSuccess);
+            const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+            printMessage(prettifyMsg);
         }
         else {
             printMessage(TEXT.overrideFilesAborted);
@@ -78,6 +81,8 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         }
         const packageManager = getPackageManagerWithFallback();
         writePackageManagerInPackageJson(packageManager);
+        const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+        printMessage(prettifyMsg);
         printSuccessMessage(TEXT.updateCommandSuccess);
     }
     catch (error) {

package/dist/utils/utils.packagejson.js

@@ -3,8 +3,8 @@ import { TEMPLATE_PATHS } from '../constants.js';
 import { readJsonFile } from './utils.files.js';
 import { getTemplateData, renderTemplateFromFile } from './utils.templates.js';
 import fs from 'node:fs';
-export function getPackageJson() {
-    return readJsonFile(path.join(process.cwd(), 'package.json'));
+export function getPackageJson(rootPath = process.cwd()) {
+    return readJsonFile(path.join(rootPath, 'package.json'));
 }
 export function getLatestPackageJson() {
     const packageJsonPath = path.join(TEMPLATE_PATHS.common, '_package.json');

package/dist/utils/utils.prettifyFiles.js

@@ -0,0 +1,31 @@
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+import { getPackageJson } from './utils.packagejson.js';
+const exec = promisify(nodeExec);
+export async function prettifyFiles(options) {
+    const targetPath = options.targetPath ?? process.cwd();
+    const projectRoot = options.projectRoot ?? targetPath;
+    if (!isPrettierUsed(projectRoot)) {
+        return 'Prettify skipped, because it is not used in this project.';
+    }
+    if (!fs.existsSync(targetPath)) {
+        return '';
+    }
+    const prettierVersion = getPrettierVersion(projectRoot);
+    try {
+        let command = `npx -y prettier@${prettierVersion} . --write`;
+        await exec(command, { cwd: targetPath });
+    }
+    catch (error) {
+        throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
+    }
+    return 'Successfully ran prettier against new plugin.';
+}
+function isPrettierUsed(projectRoot) {
+    return Boolean(getPrettierVersion(projectRoot));
+}
+function getPrettierVersion(projectRoot) {
+    const packageJson = getPackageJson(projectRoot);
+    return packageJson.devDependencies?.prettier || packageJson.dependencies?.prettier;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "3.5.0",
+  "version": "3.6.0-canary.669.68b0597.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "7ba4714d92f47bb41a9bb83fdedbc4497eecc9f2"
+  "gitHead": "68b05979a4745baaf52da1de8a5e4c002ecb5ca6"
 }

package/src/commands/generate.command.ts

@@ -12,7 +12,7 @@ import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile } from '../utils/utils.templates.js';
 import { getVersion } from '../utils/utils.version.js';
-import { prettifyFiles } from './generate/prettify-files.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 import { printGenerateSuccessMessage } from './generate/print-success-message.js';
 import { promptUser } from './generate/prompt-user.js';
 import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages.js';
@@ -45,7 +45,7 @@ export const generate = async (argv: minimist.ParsedArgs) => {
   if (answers.hasBackend) {
     await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
   }
-  await execPostScaffoldFunction(prettifyFiles, exportPath);
+  await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
 
   printGenerateSuccessMessage(answers);
 };

package/src/commands/update.command.ts

@@ -10,9 +10,10 @@ import {
   updateNpmScripts,
   writePackageManagerInPackageJson,
 } from '../utils/utils.npm.js';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory } from '../utils/utils.plugin.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 
 export const update = async (argv: minimist.ParsedArgs) => {
   try {
@@ -58,7 +59,11 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
     // -----------------------------------
     if (await confirmPrompt(TEXT.updateConfigPrompt)) {
       compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
+
       printSuccessMessage(TEXT.overrideFilesSuccess);
+
+      const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+      printMessage(prettifyMsg);
     } else {
       printMessage(TEXT.overrideFilesAborted);
       process.exit(0);
@@ -110,6 +115,9 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
     const packageManager = getPackageManagerWithFallback();
     writePackageManagerInPackageJson(packageManager);
 
+    const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+    printMessage(prettifyMsg);
+
     // 4. Summary
     // -------------
     printSuccessMessage(TEXT.updateCommandSuccess);

package/src/utils/utils.packagejson.ts

@@ -10,8 +10,8 @@ export type PackageJson = {
   devDependencies: Record<string, string>;
   packageManager?: string;
 } & Record<string, any>;
-export function getPackageJson(): PackageJson {
-  return readJsonFile(path.join(process.cwd(), 'package.json'));
+export function getPackageJson(rootPath = process.cwd()): PackageJson {
+  return readJsonFile(path.join(rootPath, 'package.json'));
 }
 
 // Returns with a package.json that is generated based on the latest templates

package/src/utils/utils.prettifyFiles.ts

@@ -0,0 +1,48 @@
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+import { getPackageJson } from './utils.packagejson.js';
+
+const exec = promisify(nodeExec);
+
+type PrettifyFilesArgs = {
+  // The path where we want to prettify files, defaults to the CWD
+  targetPath?: string;
+
+  // In case the `targetPath` would be set to a subdirectory, e.g. `.config/`. Defaults to `targetPath`.
+  projectRoot?: string;
+};
+
+export async function prettifyFiles(options: PrettifyFilesArgs) {
+  const targetPath = options.targetPath ?? process.cwd();
+  const projectRoot = options.projectRoot ?? targetPath;
+
+  if (!isPrettierUsed(projectRoot)) {
+    return 'Prettify skipped, because it is not used in this project.';
+  }
+
+  if (!fs.existsSync(targetPath)) {
+    return '';
+  }
+
+  const prettierVersion = getPrettierVersion(projectRoot);
+
+  try {
+    let command = `npx -y prettier@${prettierVersion} . --write`;
+    await exec(command, { cwd: targetPath });
+  } catch (error) {
+    throw new Error(
+      'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
+    );
+  }
+  return 'Successfully ran prettier against new plugin.';
+}
+
+function isPrettierUsed(projectRoot?: string) {
+  return Boolean(getPrettierVersion(projectRoot));
+}
+
+function getPrettierVersion(projectRoot?: string) {
+  const packageJson = getPackageJson(projectRoot);
+  return packageJson.devDependencies?.prettier || packageJson.dependencies?.prettier;
+}

package/dist/commands/generate/prettify-files.js

@@ -1,17 +0,0 @@
-import { exec as nodeExec } from 'node:child_process';
-import { promisify } from 'node:util';
-import fs from 'node:fs';
-const exec = promisify(nodeExec);
-export async function prettifyFiles(exportPath) {
-    if (!fs.existsSync(exportPath)) {
-        return '';
-    }
-    try {
-        let command = 'npx -y prettier@2 . --write';
-        await exec(command, { cwd: exportPath });
-    }
-    catch (error) {
-        throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
-    }
-    return 'Successfully ran prettier against new plugin.';
-}

package/src/commands/generate/prettify-files.ts

@@ -1,21 +0,0 @@
-import { exec as nodeExec } from 'node:child_process';
-import { promisify } from 'node:util';
-import fs from 'node:fs';
-
-const exec = promisify(nodeExec);
-
-export async function prettifyFiles(exportPath: string) {
-  if (!fs.existsSync(exportPath)) {
-    return '';
-  }
-
-  try {
-    let command = 'npx -y prettier@2 . --write';
-    await exec(command, { cwd: exportPath });
-  } catch (error) {
-    throw new Error(
-      'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
-    );
-  }
-  return 'Successfully ran prettier against new plugin.';
-}