@grafana/react-detect 0.6.2 → 0.6.3-canary.2558.23891449991.0

package/dist/bin/run.js

@@ -5,7 +5,7 @@ import { detect19 } from '../commands/detect19.js';
 const args = process.argv.slice(2);
 const argv = minimist(args, {
   boolean: ["json", "skipBuildTooling", "skipDependencies", "noErrorExitCode"],
-  string: ["pluginRoot"],
+  string: ["pluginRoot", "distDir"],
   default: {
     json: false,
     skipBuildTooling: false,

package/dist/commands/detect19.js

@@ -1,3 +1,4 @@
+import { join } from 'node:path';
 import { findSourceMapFiles } from '../file-scanner.js';
 import { generateAnalysisResults } from '../results.js';
 import { DependencyContext } from '../utils/dependencies.js';
@@ -10,10 +11,11 @@ import { output } from '../utils/output.js';
 async function detect19(argv) {
   try {
     const pluginRoot = argv.pluginRoot || process.cwd();
+    const distDir = argv.distDir || join(pluginRoot, "dist");
     const skipDependencies = argv.skipDependencies || false;
     const skipBuildTooling = argv.skipBuildTooling || false;
     const jsonOutput = argv.json || false;
-    const allMatches = await getAllMatches(pluginRoot);
+    const allMatches = await getAllMatches(distDir);
     let depContext = null;
     if (!skipDependencies) {
       depContext = new DependencyContext();
@@ -39,7 +41,7 @@ async function detect19(argv) {
       }
       return match;
     });
-    const results = generateAnalysisResults(matchesWithRootDependency, pluginRoot, depContext, {
+    const results = generateAnalysisResults(matchesWithRootDependency, distDir, depContext, {
       skipBuildTooling,
       skipDependencies
     });
@@ -61,10 +63,10 @@ async function detect19(argv) {
     process.exit(1);
   }
 }
-async function getAllMatches(pluginRoot) {
-  const sourcemapPaths = await findSourceMapFiles(pluginRoot);
+async function getAllMatches(distDir) {
+  const sourcemapPaths = await findSourceMapFiles(distDir);
   if (sourcemapPaths.length === 0) {
-    throw new Error("No source map files found in dist directory. Make sure to build your plugin first.");
+    throw new Error(`No source map files found in "${distDir}". Make sure to build your plugin first.`);
   }
   const sources = await extractAllSources(sourcemapPaths);
   if (sources.length === 0) {

package/dist/file-scanner.js

@@ -1,18 +1,16 @@
 import fg from 'fast-glob';
-import { join } from 'node:path';
 
-async function findSourceMapFiles(directory) {
-  const distDirectory = join(directory, "dist");
+async function findSourceMapFiles(distDir) {
   try {
     const files = await fg("**/*.js.map", {
-      cwd: distDirectory,
+      cwd: distDir,
       absolute: true,
       ignore: ["**/node_modules/**"]
     });
     return files;
   } catch (error) {
     throw new Error(
-      `Error finding source map files in ${distDirectory}: ${error instanceof Error ? error.message : "Unknown error"}`
+      `Error finding source map files in "${distDir}": ${error instanceof Error ? error.message : "Unknown error"}`
     );
   }
 }

package/dist/results.js

@@ -3,9 +3,9 @@ import { getPluginJson, hasExternalisedJsxRuntime } from './utils/plugin.js';
 import { isExternal } from './utils/dependencies.js';
 import path from 'node:path';
 
-function generateAnalysisResults(matches, pluginRoot, depContext, options = { skipBuildTooling: false, skipDependencies: false }) {
+function generateAnalysisResults(matches, distDir, depContext, options = { skipBuildTooling: false, skipDependencies: false }) {
   const filtered = filterMatches(matches, options.skipBuildTooling);
-  const pluginJson = getPluginJson(pluginRoot);
+  const pluginJson = getPluginJson(distDir);
   const filteredWithoutExternals = filtered.filter((match) => shouldIncludeDependencyMatch(match));
   const sourceMatches = filteredWithoutExternals.filter((m) => m.type === "source");
   const dependencyMatches = filteredWithoutExternals.filter((m) => m.type === "dependency");

package/dist/utils/plugin.js

@@ -4,12 +4,11 @@ import { parseFile } from '../parser.js';
 import { walk } from './ast.js';
 
 let cachedPluginJson = null;
-function getPluginJson(dir) {
+function getPluginJson(distDir) {
   if (cachedPluginJson) {
     return cachedPluginJson;
   }
-  const srcPath = dir ? path.join(dir, "dist") : path.join(process.cwd(), "dist");
-  const pluginJsonPath = path.join(srcPath, "plugin.json");
+  const pluginJsonPath = path.join(distDir, "plugin.json");
   cachedPluginJson = readJsonFile(pluginJsonPath);
   return cachedPluginJson;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grafana/react-detect",
   "description": "Run various checks to detect if a Grafana plugin is compatible with React.",
-  "version": "0.6.2",
+  "version": "0.6.3-canary.2558.23891449991.0",
   "repository": {
     "directory": "packages/react-detect",
     "url": "https://github.com/grafana/plugin-tools"
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "def49813c11febf54299c9541b0eeb243fb4e495"
+  "gitHead": "2cb04b2c307bd2e796b10e3cb1b672801c06ec57"
 }

package/src/bin/run.ts

@@ -6,7 +6,7 @@ import { detect19 } from '../commands/detect19.js';
 const args = process.argv.slice(2);
 const argv = minimist(args, {
   boolean: ['json', 'skipBuildTooling', 'skipDependencies', 'noErrorExitCode'],
-  string: ['pluginRoot'],
+  string: ['pluginRoot', 'distDir'],
   default: {
     json: false,
     skipBuildTooling: false,

package/src/commands/detect19.ts

@@ -1,4 +1,5 @@
 import minimist from 'minimist';
+import { join } from 'node:path';
 import { findSourceMapFiles } from '../file-scanner.js';
 import { generateAnalysisResults } from '../results.js';
 import { DependencyContext } from '../utils/dependencies.js';
@@ -13,11 +14,12 @@ import { output } from '../utils/output.js';
 export async function detect19(argv: minimist.ParsedArgs) {
   try {
     const pluginRoot = argv.pluginRoot || process.cwd();
+    const distDir = argv.distDir || join(pluginRoot, 'dist');
     const skipDependencies = argv.skipDependencies || false;
     const skipBuildTooling = argv.skipBuildTooling || false;
     const jsonOutput = argv.json || false;
 
-    const allMatches = await getAllMatches(pluginRoot);
+    const allMatches = await getAllMatches(distDir);
 
     // Conditionally load dependencies
     let depContext: DependencyContext | null = null;
@@ -52,7 +54,7 @@ export async function detect19(argv: minimist.ParsedArgs) {
             return match;
           });
 
-    const results = generateAnalysisResults(matchesWithRootDependency, pluginRoot, depContext, {
+    const results = generateAnalysisResults(matchesWithRootDependency, distDir, depContext, {
       skipBuildTooling,
       skipDependencies,
     });
@@ -77,11 +79,11 @@ export async function detect19(argv: minimist.ParsedArgs) {
   }
 }
 
-async function getAllMatches(pluginRoot: string) {
-  const sourcemapPaths = await findSourceMapFiles(pluginRoot);
+async function getAllMatches(distDir: string) {
+  const sourcemapPaths = await findSourceMapFiles(distDir);
 
   if (sourcemapPaths.length === 0) {
-    throw new Error('No source map files found in dist directory. Make sure to build your plugin first.');
+    throw new Error(`No source map files found in "${distDir}". Make sure to build your plugin first.`);
   }
 
   const sources = await extractAllSources(sourcemapPaths);

package/src/file-scanner.test.ts

@@ -0,0 +1,36 @@
+import { describe, it, expect } from 'vitest';
+import { findSourceMapFiles } from './file-scanner.js';
+import { mkdtempSync, writeFileSync, mkdirSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+describe('findSourceMapFiles', () => {
+  it('searches the given directory directly without appending a dist subdirectory', async () => {
+    const dir = mkdtempSync(join(tmpdir(), 'react-detect-test-'));
+    writeFileSync(join(dir, 'module.js.map'), '{}');
+
+    const files = await findSourceMapFiles(dir);
+
+    expect(files).toHaveLength(1);
+    expect(files[0]).toContain('module.js.map');
+  });
+
+  it('finds source map files recursively within the given directory', async () => {
+    const dir = mkdtempSync(join(tmpdir(), 'react-detect-test-'));
+    mkdirSync(join(dir, 'nested'));
+    writeFileSync(join(dir, 'a.js.map'), '{}');
+    writeFileSync(join(dir, 'nested', 'b.js.map'), '{}');
+
+    const files = await findSourceMapFiles(dir);
+
+    expect(files).toHaveLength(2);
+  });
+
+  it('returns empty array when no source map files exist', async () => {
+    const dir = mkdtempSync(join(tmpdir(), 'react-detect-test-'));
+
+    const files = await findSourceMapFiles(dir);
+
+    expect(files).toHaveLength(0);
+  });
+});

package/src/file-scanner.ts

@@ -1,19 +1,16 @@
 import fg from 'fast-glob';
-import { join } from 'node:path';
-
-export async function findSourceMapFiles(directory: string): Promise<string[]> {
-  const distDirectory = join(directory, 'dist');
 
+export async function findSourceMapFiles(distDir: string): Promise<string[]> {
   try {
     const files = await fg('**/*.js.map', {
-      cwd: distDirectory,
+      cwd: distDir,
       absolute: true,
       ignore: ['**/node_modules/**'],
     });
     return files;
   } catch (error) {
     throw new Error(
-      `Error finding source map files in ${distDirectory}: ${error instanceof Error ? error.message : 'Unknown error'}`
+      `Error finding source map files in "${distDir}": ${error instanceof Error ? error.message : 'Unknown error'}`
     );
   }
 }

package/src/results.test.ts

@@ -36,7 +36,7 @@ describe('generateAnalysisResults', () => {
     bundledFilePath: `node_modules/${packageName}/index.js`,
   });
 
-  const pluginRoot = process.cwd();
+  const distDir = process.cwd();
   const depContext = new DependencyContext();
   const options: AnalysisOptions = {
     skipBuildTooling: true,
@@ -64,7 +64,7 @@ describe('generateAnalysisResults', () => {
         bundledFilePath: 'src/components/MyComponent.tsx',
       };
       const matches: AnalyzedMatch[] = [sourceMatch, createDependencyMatch('react', 'react')];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
 
       expect(results.summary.sourceIssuesCount).toBe(1);
       expect(results.summary.dependencyIssuesCount).toBe(0);
@@ -75,7 +75,7 @@ describe('generateAnalysisResults', () => {
         createDependencyMatch('lodash', 'lodash'), // lodash is externalized by Grafana
         createDependencyMatch('axios', 'axios'),
       ];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
 
       expect(results.issues.dependencies).toHaveLength(1);
       expect(results.issues.dependencies[0].packageName).toBe('axios');
@@ -87,7 +87,7 @@ describe('generateAnalysisResults', () => {
         createDependencyMatch('@grafana/ui', '@grafana/ui'),
         createDependencyMatch('@custom/package', '@custom/package'),
       ];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
 
       expect(results.issues.dependencies).toHaveLength(1);
       expect(results.issues.dependencies[0].packageName).toBe('@custom/package');
@@ -98,7 +98,7 @@ describe('generateAnalysisResults', () => {
         createDependencyMatch('@grafana/data/utils', '@grafana/data'),
         createDependencyMatch('@custom/package/utils', '@custom/package'),
       ];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
 
       expect(results.issues.dependencies).toHaveLength(1);
       expect(results.issues.dependencies[0].packageName).toBe('@custom/package/utils');
@@ -111,7 +111,7 @@ describe('generateAnalysisResults', () => {
         createDependencyMatch('scheduler', 'react'),
         createDependencyMatch('debug', 'axios'), // Non-externalized root dependency
       ];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
 
       expect(results.issues.dependencies).toHaveLength(1);
       expect(results.issues.dependencies[0].packageName).toBe('debug');
@@ -125,7 +125,7 @@ describe('generateAnalysisResults', () => {
         createDependencyMatch('@grafana/data', '@grafana/data'),
         createDependencyMatch('axios', 'axios'),
       ];
-      const results = generateAnalysisResults(matches, pluginRoot, depContext, options);
+      const results = generateAnalysisResults(matches, distDir, depContext, options);
       // Filter to only critical dep issues
       const reportedDeps = results.issues.critical.filter((i) => i.location.type === 'dependency');
       expect(reportedDeps).toHaveLength(1);

package/src/results.ts

@@ -12,12 +12,12 @@ export interface AnalysisOptions {
 
 export function generateAnalysisResults(
   matches: AnalyzedMatch[],
-  pluginRoot: string,
+  distDir: string,
   depContext: DependencyContext | null,
   options: AnalysisOptions = { skipBuildTooling: false, skipDependencies: false }
 ): PluginAnalysisResults {
   const filtered = filterMatches(matches, options.skipBuildTooling);
-  const pluginJson = getPluginJson(pluginRoot);
+  const pluginJson = getPluginJson(distDir);
 
   // Filter out externalized dependencies
   const filteredWithoutExternals = filtered.filter((match) => shouldIncludeDependencyMatch(match, depContext));

package/src/utils/plugin.test.ts

@@ -0,0 +1,32 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { mkdtempSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+// Reset module cache between tests since getPluginJson caches internally
+beforeEach(async () => {
+  const { resetPluginJsonCache } = await import('./plugin.js');
+  resetPluginJsonCache();
+});
+
+describe('getPluginJson', () => {
+  it('reads plugin.json from the given distDir directly without appending /dist', async () => {
+    const distDir = mkdtempSync(join(tmpdir(), 'react-detect-plugin-test-'));
+    const pluginJson = { id: 'my-plugin', name: 'My Plugin', type: 'app', info: { version: '2.0.0' } };
+    writeFileSync(join(distDir, 'plugin.json'), JSON.stringify(pluginJson));
+
+    const { getPluginJson } = await import('./plugin.js');
+    const result = getPluginJson(distDir);
+
+    expect(result?.id).toBe('my-plugin');
+    expect(result?.info.version).toBe('2.0.0');
+  });
+
+  it('throws when plugin.json does not exist in the given distDir', async () => {
+    const distDir = mkdtempSync(join(tmpdir(), 'react-detect-plugin-test-'));
+
+    const { getPluginJson } = await import('./plugin.js');
+
+    expect(() => getPluginJson(distDir)).toThrow('plugin.json');
+  });
+});

package/src/utils/plugin.ts

@@ -14,13 +14,16 @@ interface PluginJson {
 
 let cachedPluginJson: PluginJson | null = null;
 
-export function getPluginJson(dir?: string) {
+export function resetPluginJsonCache() {
+  cachedPluginJson = null;
+}
+
+export function getPluginJson(distDir: string) {
   if (cachedPluginJson) {
     return cachedPluginJson;
   }
 
-  const srcPath = dir ? path.join(dir, 'dist') : path.join(process.cwd(), 'dist');
-  const pluginJsonPath = path.join(srcPath, 'plugin.json');
+  const pluginJsonPath = path.join(distDir, 'plugin.json');
   cachedPluginJson = readJsonFile(pluginJsonPath);
   return cachedPluginJson;
 }