react-doctor 0.0.1 → 0.0.2

package/dist/cli.cjs

@@ -0,0 +1,423 @@
+#!/usr/bin/env node
+'use strict';
+
+var path = require('path');
+var commander = require('commander');
+var pc = require('picocolors');
+var fs = require('fs');
+var child_process = require('child_process');
+var os = require('os');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefault(path);
+var pc__default = /*#__PURE__*/_interopDefault(pc);
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var os__default = /*#__PURE__*/_interopDefault(os);
+
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var highlighter = {
+  error: pc__default.default.red,
+  warn: pc__default.default.yellow,
+  info: pc__default.default.cyan,
+  success: pc__default.default.green,
+  dim: pc__default.default.dim
+};
+
+// src/utils/logger.ts
+var logger = {
+  error(...args) {
+    console.log(highlighter.error(args.join(" ")));
+  },
+  warn(...args) {
+    console.log(highlighter.warn(args.join(" ")));
+  },
+  info(...args) {
+    console.log(highlighter.info(args.join(" ")));
+  },
+  success(...args) {
+    console.log(highlighter.success(args.join(" ")));
+  },
+  dim(...args) {
+    console.log(highlighter.dim(args.join(" ")));
+  },
+  log(...args) {
+    console.log(args.join(" "));
+  },
+  break() {
+    console.log("");
+  }
+};
+
+// src/utils/handle-error.ts
+var handleError = (error) => {
+  logger.break();
+  logger.error("Something went wrong. Please check the error below for more details.");
+  logger.error("If the problem persists, please open an issue on GitHub.");
+  logger.error("");
+  if (error instanceof Error) {
+    logger.error(error.message);
+  }
+  logger.break();
+  process.exit(1);
+};
+
+// src/constants.ts
+var SOURCE_FILE_PATTERN = /\.(tsx?|jsx?)$/;
+var SEPARATOR_LENGTH = 62;
+var SPAWN_MAX_BUFFER_BYTES = 100 * 1024 * 1024;
+var FRAMEWORK_PACKAGES = {
+  next: "nextjs",
+  vite: "vite",
+  "react-scripts": "cra",
+  "@remix-run/react": "remix",
+  gatsby: "gatsby"
+};
+var FRAMEWORK_DISPLAY_NAMES = {
+  nextjs: "Next.js",
+  vite: "Vite",
+  cra: "Create React App",
+  remix: "Remix",
+  gatsby: "Gatsby",
+  unknown: "React"
+};
+var formatFrameworkName = (framework) => FRAMEWORK_DISPLAY_NAMES[framework];
+var countSourceFiles = (rootDirectory) => {
+  const result = child_process.spawnSync("git", ["ls-files", "--cached", "--others", "--exclude-standard"], {
+    cwd: rootDirectory,
+    encoding: "utf-8"
+  });
+  if (result.error || result.status !== 0) {
+    return 0;
+  }
+  return result.stdout.split("\n").filter((filePath) => filePath.length > 0 && SOURCE_FILE_PATTERN.test(filePath)).length;
+};
+var detectFramework = (dependencies) => {
+  for (const [packageName, frameworkName] of Object.entries(FRAMEWORK_PACKAGES)) {
+    if (dependencies[packageName]) {
+      return frameworkName;
+    }
+  }
+  return "unknown";
+};
+var extractDependencyInfo = (packageJson) => {
+  const allDependencies = {
+    ...packageJson.dependencies,
+    ...packageJson.devDependencies
+  };
+  return {
+    reactVersion: allDependencies.react ?? null,
+    framework: detectFramework(allDependencies)
+  };
+};
+var parsePnpmWorkspacePatterns = (rootDirectory) => {
+  const workspacePath = path__default.default.join(rootDirectory, "pnpm-workspace.yaml");
+  if (!fs__default.default.existsSync(workspacePath)) return [];
+  const content = fs__default.default.readFileSync(workspacePath, "utf-8");
+  const patterns = [];
+  let insidePackagesBlock = false;
+  for (const line of content.split("\n")) {
+    const trimmed = line.trim();
+    if (trimmed === "packages:") {
+      insidePackagesBlock = true;
+      continue;
+    }
+    if (insidePackagesBlock && trimmed.startsWith("-")) {
+      patterns.push(trimmed.replace(/^-\s*/, "").replace(/["']/g, ""));
+    } else if (insidePackagesBlock && trimmed.length > 0 && !trimmed.startsWith("#")) {
+      insidePackagesBlock = false;
+    }
+  }
+  return patterns;
+};
+var getWorkspacePatterns = (rootDirectory, packageJson) => {
+  const pnpmPatterns = parsePnpmWorkspacePatterns(rootDirectory);
+  if (pnpmPatterns.length > 0) return pnpmPatterns;
+  if (Array.isArray(packageJson.workspaces)) {
+    return packageJson.workspaces;
+  }
+  if (packageJson.workspaces?.packages) {
+    return packageJson.workspaces.packages;
+  }
+  return [];
+};
+var resolveWorkspaceDirectories = (rootDirectory, pattern) => {
+  const cleanPattern = pattern.replace(/["']/g, "").replace(/\/\*\*$/, "/*");
+  if (!cleanPattern.includes("*")) {
+    const directoryPath = path__default.default.join(rootDirectory, cleanPattern);
+    if (fs__default.default.existsSync(directoryPath) && fs__default.default.existsSync(path__default.default.join(directoryPath, "package.json"))) {
+      return [directoryPath];
+    }
+    return [];
+  }
+  const baseDirectory = path__default.default.join(
+    rootDirectory,
+    cleanPattern.slice(0, cleanPattern.indexOf("*"))
+  );
+  if (!fs__default.default.existsSync(baseDirectory) || !fs__default.default.statSync(baseDirectory).isDirectory()) {
+    return [];
+  }
+  return fs__default.default.readdirSync(baseDirectory).map((entry) => path__default.default.join(baseDirectory, entry)).filter(
+    (entryPath) => fs__default.default.statSync(entryPath).isDirectory() && fs__default.default.existsSync(path__default.default.join(entryPath, "package.json"))
+  );
+};
+var findReactInWorkspaces = (rootDirectory, packageJson) => {
+  const patterns = getWorkspacePatterns(rootDirectory, packageJson);
+  const result = { reactVersion: null, framework: "unknown" };
+  for (const pattern of patterns) {
+    const directories = resolveWorkspaceDirectories(rootDirectory, pattern);
+    for (const workspaceDirectory of directories) {
+      const workspacePackageJson = JSON.parse(
+        fs__default.default.readFileSync(path__default.default.join(workspaceDirectory, "package.json"), "utf-8")
+      );
+      const info = extractDependencyInfo(workspacePackageJson);
+      if (info.reactVersion && !result.reactVersion) {
+        result.reactVersion = info.reactVersion;
+      }
+      if (info.framework !== "unknown" && result.framework === "unknown") {
+        result.framework = info.framework;
+      }
+      if (result.reactVersion && result.framework !== "unknown") {
+        return result;
+      }
+    }
+  }
+  return result;
+};
+var discoverProject = (directory) => {
+  const packageJsonPath = path__default.default.join(directory, "package.json");
+  if (!fs__default.default.existsSync(packageJsonPath)) {
+    throw new Error(`No package.json found in ${directory}`);
+  }
+  const packageJson = JSON.parse(fs__default.default.readFileSync(packageJsonPath, "utf-8"));
+  let { reactVersion, framework } = extractDependencyInfo(packageJson);
+  if (!reactVersion) {
+    const workspaceInfo = findReactInWorkspaces(directory, packageJson);
+    reactVersion = workspaceInfo.reactVersion;
+    framework = workspaceInfo.framework;
+  } else if (framework === "unknown") {
+    const workspaceInfo = findReactInWorkspaces(directory, packageJson);
+    if (workspaceInfo.framework !== "unknown") {
+      framework = workspaceInfo.framework;
+    }
+  }
+  const hasTypeScript = fs__default.default.existsSync(path__default.default.join(directory, "tsconfig.json"));
+  const sourceFileCount = countSourceFiles(directory);
+  return {
+    rootDirectory: directory,
+    reactVersion,
+    framework,
+    hasTypeScript,
+    sourceFileCount
+  };
+};
+
+// src/oxlint-config.ts
+var OXLINT_CONFIG = {
+  plugins: ["react", "jsx-a11y", "react-perf", "import", "typescript"],
+  rules: {
+    "react/rules-of-hooks": "error",
+    "react/no-direct-mutation-state": "error",
+    "react/jsx-no-duplicate-props": "error",
+    "react/jsx-key": "error",
+    "react/no-children-prop": "warn",
+    "react/no-danger": "warn",
+    "react/jsx-no-script-url": "error",
+    "react/no-render-return-value": "warn",
+    "react/no-string-refs": "warn",
+    "react/no-unescaped-entities": "warn",
+    "react/no-is-mounted": "warn",
+    "react/require-render-return": "error",
+    "react/no-unknown-property": "warn",
+    "jsx-a11y/alt-text": "error",
+    "jsx-a11y/anchor-is-valid": "warn",
+    "jsx-a11y/click-events-have-key-events": "warn",
+    "jsx-a11y/no-static-element-interactions": "warn",
+    "jsx-a11y/no-noninteractive-element-interactions": "warn",
+    "jsx-a11y/role-has-required-aria-props": "error",
+    "jsx-a11y/no-autofocus": "warn",
+    "jsx-a11y/heading-has-content": "warn",
+    "jsx-a11y/html-has-lang": "warn",
+    "jsx-a11y/no-redundant-roles": "warn",
+    "jsx-a11y/scope": "warn",
+    "jsx-a11y/tabindex-no-positive": "warn",
+    "jsx-a11y/label-has-associated-control": "warn",
+    "jsx-a11y/no-distracting-elements": "error",
+    "jsx-a11y/iframe-has-title": "warn",
+    "react-perf/jsx-no-new-object-as-prop": "warn",
+    "react-perf/jsx-no-new-array-as-prop": "warn",
+    "react-perf/jsx-no-new-function-as-prop": "warn",
+    "react-perf/jsx-no-jsx-as-prop": "warn",
+    "import/no-cycle": "error",
+    "import/no-self-import": "error",
+    "import/no-duplicates": "warn",
+    "import/no-named-default": "warn",
+    "typescript/consistent-type-imports": "warn",
+    "typescript/no-explicit-any": "warn",
+    "typescript/no-non-null-assertion": "warn",
+    "typescript/prefer-ts-expect-error": "warn",
+    "typescript/no-unnecessary-type-assertion": "warn"
+  }
+};
+
+// src/utils/run-oxlint.ts
+var PLUGIN_CATEGORY_MAP = {
+  react: "Correctness",
+  "react-hooks": "Correctness",
+  "jsx-a11y": "Accessibility",
+  "react-perf": "Performance",
+  import: "Bundle Size",
+  typescript: "TypeScript",
+  eslint: "Code Quality",
+  oxc: "Code Quality",
+  unicorn: "Code Quality"
+};
+var normalizePluginName = (rawPlugin) => rawPlugin.replace(/^eslint-plugin-/, "").replace(/^typescript-eslint$/, "typescript");
+var parseRuleCode = (code) => {
+  const match = code.match(/^(.+)\((.+)\)$/);
+  if (!match) return { plugin: "unknown", rule: code };
+  return { plugin: normalizePluginName(match[1]), rule: match[2] };
+};
+var resolveOxlintBinary = () => {
+  const oxlintMainPath = __require.resolve("oxlint");
+  const oxlintPackageDirectory = path__default.default.resolve(path__default.default.dirname(oxlintMainPath), "..");
+  return path__default.default.join(oxlintPackageDirectory, "bin", "oxlint");
+};
+var runOxlint = (rootDirectory, hasTypeScript) => {
+  const configPath = path__default.default.join(os__default.default.tmpdir(), `react-doctor-oxlintrc-${process.pid}.json`);
+  try {
+    fs__default.default.writeFileSync(configPath, JSON.stringify(OXLINT_CONFIG, null, 2));
+    const oxlintBinary = resolveOxlintBinary();
+    const args = [oxlintBinary, "-c", configPath, "--format", "json"];
+    if (hasTypeScript) {
+      args.push("--tsconfig", "./tsconfig.json");
+    }
+    args.push(".");
+    const result = child_process.spawnSync(process.execPath, args, {
+      cwd: rootDirectory,
+      encoding: "utf-8",
+      maxBuffer: SPAWN_MAX_BUFFER_BYTES
+    });
+    if (result.error) {
+      throw new Error(`Failed to run oxlint: ${result.error.message}`);
+    }
+    const stdout = result.stdout.trim();
+    if (!stdout) {
+      return [];
+    }
+    const output = JSON.parse(stdout);
+    return output.diagnostics.map((diagnostic) => {
+      const { plugin, rule } = parseRuleCode(diagnostic.code);
+      const primaryLabel = diagnostic.labels[0];
+      return {
+        filePath: diagnostic.filename,
+        plugin,
+        rule,
+        severity: diagnostic.severity,
+        message: diagnostic.message,
+        help: diagnostic.help,
+        line: primaryLabel?.span.line ?? 0,
+        column: primaryLabel?.span.column ?? 0,
+        category: PLUGIN_CATEGORY_MAP[plugin] ?? "Other"
+      };
+    });
+  } finally {
+    if (fs__default.default.existsSync(configPath)) {
+      fs__default.default.unlinkSync(configPath);
+    }
+  }
+};
+
+// src/scan.ts
+var groupDiagnosticsByCategory = (diagnostics) => {
+  const groups = /* @__PURE__ */ new Map();
+  for (const diagnostic of diagnostics) {
+    const existing = groups.get(diagnostic.category) ?? [];
+    existing.push(diagnostic);
+    groups.set(diagnostic.category, existing);
+  }
+  return groups;
+};
+var printCategorySection = (category, diagnostics) => {
+  const separatorFill = "\u2500".repeat(SEPARATOR_LENGTH - category.length - 6);
+  logger.log(`\u2500\u2500\u2500\u2500 ${category} ${separatorFill}`);
+  logger.break();
+  for (const diagnostic of diagnostics) {
+    const icon = diagnostic.severity === "error" ? highlighter.error("\u2717") : highlighter.warn("\u26A0");
+    logger.log(`  ${icon} ${diagnostic.message}`);
+    if (diagnostic.help) {
+      logger.dim(`    ${diagnostic.help}`);
+    }
+    logger.dim(`    ${diagnostic.filePath}:${diagnostic.line}:${diagnostic.column}`);
+    logger.dim(`    Rule: ${diagnostic.plugin}/${diagnostic.rule}`);
+    logger.break();
+  }
+};
+var printSummary = (diagnostics) => {
+  const errorCount = diagnostics.filter((diagnostic) => diagnostic.severity === "error").length;
+  const warningCount = diagnostics.filter((diagnostic) => diagnostic.severity === "warning").length;
+  logger.log("\u2500".repeat(SEPARATOR_LENGTH));
+  logger.break();
+  const parts = [];
+  if (errorCount > 0) {
+    parts.push(highlighter.error(`${errorCount} error${errorCount === 1 ? "" : "s"}`));
+  }
+  if (warningCount > 0) {
+    parts.push(highlighter.warn(`${warningCount} warning${warningCount === 1 ? "" : "s"}`));
+  }
+  logger.log(parts.join("  "));
+};
+var scan = (directory) => {
+  const projectInfo = discoverProject(directory);
+  if (!projectInfo.reactVersion) {
+    throw new Error("No React dependency found in package.json");
+  }
+  const frameworkLabel = formatFrameworkName(projectInfo.framework);
+  const languageLabel = projectInfo.hasTypeScript ? "TypeScript" : "JavaScript";
+  logger.log(
+    `Found: ${frameworkLabel} \xB7 React ${projectInfo.reactVersion} \xB7 ${languageLabel} \xB7 ${projectInfo.sourceFileCount} source files`
+  );
+  logger.break();
+  const diagnostics = runOxlint(directory, projectInfo.hasTypeScript);
+  if (diagnostics.length === 0) {
+    logger.success("No issues found!");
+    return;
+  }
+  const groupedDiagnostics = groupDiagnosticsByCategory(diagnostics);
+  for (const [category, categoryDiagnostics] of groupedDiagnostics) {
+    printCategorySection(category, categoryDiagnostics);
+  }
+  printSummary(diagnostics);
+};
+
+// src/cli.ts
+var VERSION = "0.0.2";
+process.on("SIGINT", () => process.exit(0));
+process.on("SIGTERM", () => process.exit(0));
+var program = new commander.Command().name("react-doctor").description("Diagnose React codebase health").version(VERSION, "-v, --version", "display the version number").argument("[directory]", "project directory to scan", ".").action((directory) => {
+  try {
+    const resolvedDirectory = path__default.default.resolve(directory);
+    logger.log(`react-doctor v${VERSION}`);
+    logger.break();
+    logger.dim(`Scanning ${resolvedDirectory}...`);
+    logger.break();
+    scan(resolvedDirectory);
+  } catch (error) {
+    handleError(error);
+  }
+}).addHelpText(
+  "after",
+  `
+${highlighter.dim("Learn more:")}
+  ${highlighter.info("https://github.com/aidenybai/react-doctor")}
+`
+);
+var main = async () => {
+  await program.parseAsync();
+};
+main();

package/dist/cli.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/package.json

@@ -1,11 +1,31 @@
 {
   "name": "react-doctor",
-  "version": "0.0.1",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "version": "0.0.2",
+  "bin": {
+    "react-doctor": "./dist/cli.cjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/cli.d.ts",
+      "import": "./dist/cli.js",
+      "require": "./dist/cli.cjs"
+    }
+  },
+  "dependencies": {
+    "commander": "^14.0.3",
+    "oxlint": "^1.47.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1"
+  },
   "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch"
+    "dev": "tsup --watch",
+    "build": "rm -rf dist && NODE_ENV=production tsup",
+    "typecheck": "tsc --noEmit"
   }
 }

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# react-doctor
-
-## 0.0.1
-
-### Patch Changes
-
-- init

package/dist/index.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/index.js

@@ -1 +0,0 @@
-export {};

package/src/index.ts

@@ -1 +0,0 @@
-export {};

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src"
-  },
-  "include": ["src"]
-}