@storm-software/eslint-plugin-bun 0.0.5 → 0.0.7

package/dist/rules/json-valid-catalog.mjs

@@ -1,426 +1,84 @@
-import defu from 'defu';
-import fs from 'node:fs';
-import process from 'node:process';
-import { findUpSync } from 'find-up-simple';
-import { dirname, normalize } from 'pathe';
-import 'tinyglobby';
-
-// src/helpers/create-rule.ts
-function RuleCreator(urlCreator) {
-  return function createNamedRule({
-    name,
-    meta,
-    ...rule
-  }) {
-    return createRuleInfo({
-      meta: {
-        ...meta,
-        docs: {
-          ...meta.docs,
-          url: urlCreator(name)
-        }
-      },
-      ...rule
-    });
-  };
-}
-function createRuleInfo({
-  create,
-  defaultOptions,
-  meta
-}) {
-  return {
-    create: ((context) => {
-      const optionsWithDefault = context.options.map((options, index) => {
-        return defu(defaultOptions?.[index] ?? {}, options);
-      });
-      return create(context, optionsWithDefault);
-    }),
-    defaultOptions: defaultOptions ?? {},
-    meta
-  };
-}
-var createRule = RuleCreator(
-  (ruleName) => `https://docs.stormsoftware.com/projects/storm-ops/eslint-plugin-bun/rules/${ruleName}.md`
-);
-function isWorkspaceObject(workspaces) {
-  return Boolean(workspaces) && typeof workspaces === "object" && !Array.isArray(workspaces);
-}
-function detectCatalogRoot(data) {
-  if (data.catalog || data.catalogs) {
-    return "top";
-  }
-  if (isWorkspaceObject(data.workspaces) && (data.workspaces.catalog || data.workspaces.catalogs)) {
-    return "workspaces";
-  }
-  return isWorkspaceObject(data.workspaces) ? "workspaces" : "top";
-}
-function normalizeCatalogName(name) {
-  return name.replace(/\^/g, "h").replace(/~/g, "t").replace(/\./g, "_").replace(/</g, "l").replace(/>/g, "g").replace(/=/g, "e").replace(/\*/g, "s").replace(/@/g, "a").replace(/\|/g, "p").replace(/&/g, "n").replace(/-/g, "m").replace(/\+/g, "u").replace(/\s/g, "_");
-}
-function sortObjectKeys(input) {
-  return Object.fromEntries(
-    Object.entries(input).sort(([left], [right]) => left.localeCompare(right))
-  );
-}
-function isWorkspaceRootPackageJson(data) {
-  return Boolean(
-    data.workspaces || data.catalog || data.catalogs
-  );
-}
-function readBunWorkspace(cwd = process.cwd()) {
-  const filepath = findUpSync("package.json", {
-    cwd,
-    type: "file"
-  });
-  if (!filepath) {
-    throw new Error("package.json not found");
-  }
-  let current = filepath;
-  let content = fs.readFileSync(current, "utf8");
-  let data = JSON.parse(content);
-  while (!isWorkspaceRootPackageJson(data)) {
-    const searchFrom = dirname(dirname(current));
-    const next = findUpSync("package.json", {
-      cwd: searchFrom,
-      type: "file"
-    });
-    if (!next || normalize(next) === normalize(current)) {
-      break;
-    }
-    current = next;
-    content = fs.readFileSync(current, "utf8");
-    data = JSON.parse(content);
-  }
-  if (!isWorkspaceRootPackageJson(data)) {
-    throw new Error(
-      "Bun workspace root package.json with workspaces/catalog not found"
-    );
-  }
-  let hasChanged = false;
-  let queueTimer;
-  const queue = [];
-  let catalogRoot = detectCatalogRoot(data);
-  const write = () => {
-    if (!fs.existsSync(current)) {
-      return;
-    }
-    fs.writeFileSync(current, `${JSON.stringify(data, null, 2)}
-`);
-  };
-  const clearQueue = () => {
-    if (queueTimer != null) {
-      clearTimeout(queueTimer);
-      queueTimer = void 0;
-    }
-    queue.length = 0;
-  };
-  const getCatalogContainer = () => {
-    if (catalogRoot === "workspaces") {
-      if (!isWorkspaceObject(data.workspaces)) {
-        data.workspaces = {
-          packages: Array.isArray(data.workspaces) ? data.workspaces : [],
-          catalog: {},
-          catalogs: {}
-        };
-      }
-      return data.workspaces;
-    }
-    return data;
-  };
-  const getCatalogData = () => {
-    const container = getCatalogContainer();
-    return {
-      catalog: container.catalog,
-      catalogs: container.catalogs
-    };
-  };
-  const setPackage = (catalogName, packageName, specifier) => {
-    const container = getCatalogContainer();
-    if (catalogName === "default") {
-      container.catalog ??= {};
-      if (container.catalog[packageName] !== specifier) {
-        container.catalog[packageName] = specifier;
-        container.catalog = sortObjectKeys(container.catalog);
-        hasChanged = true;
-      }
-      return;
-    }
-    container.catalogs ??= {};
-    container.catalogs[catalogName] ??= {};
-    if (container.catalogs[catalogName][packageName] !== specifier) {
-      container.catalogs[catalogName][packageName] = specifier;
-      container.catalogs[catalogName] = sortObjectKeys(
-        container.catalogs[catalogName]
-      );
-      container.catalogs = sortObjectKeys(container.catalogs);
-      hasChanged = true;
-    }
-  };
-  const hasSpecifierConflicts = (catalogName, packageName, specifier) => {
-    const { catalog, catalogs } = getCatalogData();
-    const existingSpecifier = catalogName === "default" ? catalog?.[packageName] : catalogs?.[catalogName]?.[packageName];
-    if (existingSpecifier === specifier) {
-      return {
-        conflicts: false,
-        newCatalogName: catalogName,
-        existingSpecifier
-      };
-    }
-    if (existingSpecifier) {
-      const versionSuffix = normalizeCatalogName(specifier);
-      const newCatalogName = catalogName === "default" ? `conflicts_${packageName}_${versionSuffix}` : `conflicts_${catalogName}_${versionSuffix}`;
-      return {
-        conflicts: true,
-        existingSpecifier,
-        newCatalogName
-      };
-    }
-    return {
-      conflicts: false,
-      newCatalogName: catalogName
-    };
-  };
-  const getPackageCatalogs = (packageName) => {
-    const found = [];
-    const { catalog, catalogs } = getCatalogData();
-    if (catalogs) {
-      for (const name of Object.keys(catalogs)) {
-        if (catalogs[name]?.[packageName]) {
-          found.push(name);
-        }
-      }
-    }
-    if (catalog?.[packageName]) {
-      found.push("default");
-    }
-    return found;
-  };
-  const workspace2 = {
-    filepath: current,
-    setContent(newContent) {
-      content = newContent;
-      data = JSON.parse(newContent);
-      catalogRoot = detectCatalogRoot(data);
-      hasChanged = false;
-    },
-    hasChanged: () => hasChanged,
-    hasQueue: () => queueTimer != null,
-    clearQueue,
-    queueChange(fn, order) {
-      if (order === "pre") {
-        queue.unshift(fn);
-      } else {
-        queue.push(fn);
-      }
-      if (queueTimer != null) {
-        clearTimeout(queueTimer);
-      }
-      queueTimer = setTimeout(() => {
-        queueTimer = void 0;
-        const clone = [...queue];
-        queue.length = 0;
-        for (const queued of clone) {
-          queued(workspace2);
-        }
-        if (hasChanged) {
-          write();
-        }
-      }, 1e3);
-    },
-    toJSON: () => data,
-    toString: () => `${JSON.stringify(data, null, 2)}
-`,
-    setPackage,
-    setPackageNoConflicts(catalogName, packageName, specifier) {
-      const { newCatalogName } = hasSpecifierConflicts(
-        catalogName,
-        packageName,
-        specifier
-      );
-      setPackage(newCatalogName, packageName, specifier);
-    },
-    getPackageCatalogs,
-    hasSpecifierConflicts,
-    getCatalogData,
-    getWorkspacePackagePatterns() {
-      if (Array.isArray(data.workspaces)) {
-        return data.workspaces;
-      }
-      if (isWorkspaceObject(data.workspaces) && data.workspaces.packages) {
-        return data.workspaces.packages;
-      }
-      return [];
-    }
-  };
-  return workspace2;
-}
-var WORKSPACE_CACHE_TIME = 1e4;
-var workspaceLastRead;
-var workspace;
-function getBunWorkspace(cwd = process.cwd()) {
-  if (workspaceLastRead && workspace && !workspace.hasQueue() && Date.now() - workspaceLastRead > WORKSPACE_CACHE_TIME) {
-    workspace = void 0;
-  }
-  if (!workspace) {
-    workspace = readBunWorkspace(cwd);
-    workspaceLastRead = Date.now();
-  }
-  return workspace;
-}
-
-// src/helpers/iterate-dependencies.ts
-function getPackageJsonRootNode(context) {
-  if (!context.filename.endsWith("package.json")) {
-    return void 0;
-  }
-  const ast = context.sourceCode.ast;
-  const root = ast.body[0];
-  if (root?.expression?.type === "JSONObjectExpression") {
-    return root.expression;
-  }
-  return void 0;
-}
-function* iterateDependencies(context, fields) {
-  const root = getPackageJsonRootNode(context);
-  if (!root) {
-    return;
-  }
-  for (const fieldName of fields) {
-    const path = fieldName.split(".");
-    let node = root;
-    for (const segment of path) {
-      const item = node.properties?.find(
-        (property) => property.key.type === "JSONLiteral" && property.key.value === segment
-      );
-      if (!item?.value || item.value.type !== "JSONObjectExpression") {
-        node = void 0;
-        break;
-      }
-      node = item.value;
-    }
-    if (!node || node === root || !node.properties) {
-      continue;
-    }
-    for (const property of node.properties) {
-      if (property.value.type !== "JSONLiteral" || property.key.type !== "JSONLiteral") {
-        continue;
-      }
-      if (typeof property.value.value !== "string") {
-        continue;
-      }
-      yield {
-        packageName: String(property.key.value),
-        specifier: String(property.value.value),
-        property
-      };
-    }
-  }
-}
-
-// src/rules/json-valid-catalog.ts
-var RULE_NAME = "json-valid-catalog";
-var DEFAULT_FIELDS = [
-  "dependencies",
-  "devDependencies",
-  "optionalDependencies",
-  "peerDependencies",
-  "resolutions",
-  "overrides"
+import { createRule } from "../helpers/create-rule.mjs";
+import { getBunWorkspace } from "../helpers/bun-workspace.mjs";
+import { iterateDependencies } from "../helpers/iterate-dependencies.mjs";
+//#region src/rules/json-valid-catalog.ts
+const RULE_NAME = "json-valid-catalog";
+const DEFAULT_FIELDS = [
+	"dependencies",
+	"devDependencies",
+	"optionalDependencies",
+	"peerDependencies",
+	"resolutions",
+	"overrides"
 ];
 var json_valid_catalog_default = createRule({
-  name: RULE_NAME,
-  meta: {
-    type: "layout",
-    docs: {
-      description: "Enforce using valid Bun catalog references in `package.json`"
-    },
-    fixable: "code",
-    schema: [
-      {
-        type: "object",
-        properties: {
-          autoInsert: {
-            type: "boolean",
-            description: "Whether to auto insert to catalog if missing",
-            default: true
-          },
-          autoInsertDefaultSpecifier: {
-            type: "string",
-            description: "Default specifier to use when auto inserting to catalog",
-            default: "^0.0.0"
-          },
-          autofix: {
-            type: "boolean",
-            description: "Whether to autofix the linting error",
-            default: true
-          },
-          fields: {
-            type: "array",
-            description: "Fields to check for catalog",
-            default: DEFAULT_FIELDS
-          }
-        },
-        additionalProperties: false
-      }
-    ],
-    messages: {
-      invalidCatalog: 'Catalog "{{specifier}}" for package "{{packageName}}" is not defined in the workspace root `package.json`.'
-    }
-  },
-  defaultOptions: [{}],
-  create(context, [options = {}]) {
-    const {
-      autoInsert = true,
-      autofix = true,
-      autoInsertDefaultSpecifier = "^0.0.0",
-      fields = DEFAULT_FIELDS
-    } = options || {};
-    for (const { packageName, specifier, property } of iterateDependencies(
-      context,
-      fields
-    )) {
-      if (!specifier.startsWith("catalog:")) {
-        continue;
-      }
-      let workspace2;
-      try {
-        workspace2 = getBunWorkspace();
-      } catch {
-        return {};
-      }
-      const currentCatalog = specifier.replace(/^catalog:/, "").trim() || "default";
-      const existingCatalogs = workspace2.getPackageCatalogs(packageName);
-      if (!existingCatalogs.includes(currentCatalog)) {
-        context.report({
-          node: property.value,
-          messageId: "invalidCatalog",
-          data: {
-            specifier,
-            packageName
-          },
-          fix: !autofix || !autoInsert && !existingCatalogs.length ? void 0 : (fixer) => {
-            let catalog = existingCatalogs[0];
-            if (!catalog && autoInsert) {
-              catalog = currentCatalog;
-              workspace2.queueChange(() => {
-                workspace2.setPackage(
-                  catalog,
-                  packageName,
-                  autoInsertDefaultSpecifier
-                );
-              }, "pre");
-            }
-            return fixer.replaceText(
-              property.value,
-              catalog === "default" ? JSON.stringify("catalog:") : JSON.stringify(`catalog:${catalog}`)
-            );
-          }
-        });
-      }
-    }
-    return {};
-  }
+	name: RULE_NAME,
+	meta: {
+		type: "layout",
+		docs: { description: "Enforce using valid Bun catalog references in `package.json`" },
+		fixable: "code",
+		schema: [{
+			type: "object",
+			properties: {
+				autoInsert: {
+					type: "boolean",
+					description: "Whether to auto insert to catalog if missing",
+					default: true
+				},
+				autoInsertDefaultSpecifier: {
+					type: "string",
+					description: "Default specifier to use when auto inserting to catalog",
+					default: "^0.0.0"
+				},
+				autofix: {
+					type: "boolean",
+					description: "Whether to autofix the linting error",
+					default: true
+				},
+				fields: {
+					type: "array",
+					description: "Fields to check for catalog",
+					default: DEFAULT_FIELDS
+				}
+			},
+			additionalProperties: false
+		}],
+		messages: { invalidCatalog: "Catalog \"{{specifier}}\" for package \"{{packageName}}\" is not defined in the workspace root `package.json`." }
+	},
+	defaultOptions: [{}],
+	create(context, [options = {}]) {
+		const { autoInsert = true, autofix = true, autoInsertDefaultSpecifier = "^0.0.0", fields = DEFAULT_FIELDS } = options || {};
+		for (const { packageName, specifier, property } of iterateDependencies(context, fields)) {
+			if (!specifier.startsWith("catalog:")) continue;
+			let workspace;
+			try {
+				workspace = getBunWorkspace();
+			} catch {
+				return {};
+			}
+			const currentCatalog = specifier.replace(/^catalog:/, "").trim() || "default";
+			const existingCatalogs = workspace.getPackageCatalogs(packageName);
+			if (!existingCatalogs.includes(currentCatalog)) context.report({
+				node: property.value,
+				messageId: "invalidCatalog",
+				data: {
+					specifier,
+					packageName
+				},
+				fix: !autofix || !autoInsert && !existingCatalogs.length ? void 0 : (fixer) => {
+					let catalog = existingCatalogs[0];
+					if (!catalog && autoInsert) {
+						catalog = currentCatalog;
+						workspace.queueChange(() => {
+							workspace.setPackage(catalog, packageName, autoInsertDefaultSpecifier);
+						}, "pre");
+					}
+					return fixer.replaceText(property.value, catalog === "default" ? JSON.stringify("catalog:") : JSON.stringify(`catalog:${catalog}`));
+				}
+			});
+		}
+		return {};
+	}
 });
-
+//#endregion
 export { json_valid_catalog_default as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/eslint-plugin-bun",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "private": false,
   "description": "An ESLint Plugin that enforces Bun catalog rules in Storm Software projects.",
   "keywords": ["eslint", "eslint-plugin", "storm-software", "bun", "catalog"],
@@ -40,29 +40,22 @@
   ],
   "type": "module",
   "exports": {
-    ".": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-    "./index": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-    "./configs": {
-      "types": "./dist/configs/index.d.ts",
-      "default": "./dist/configs/index.mjs"
-    },
-    "./configs/recommended": {
-      "types": "./dist/configs/recommended.d.ts",
-      "default": "./dist/configs/recommended.mjs"
-    },
-    "./helpers/create-rule": {
-      "types": "./dist/helpers/create-rule.d.ts",
-      "default": "./dist/helpers/create-rule.mjs"
-    },
-    "./plugin": {
-      "types": "./dist/plugin.d.ts",
-      "default": "./dist/plugin.mjs"
-    },
+    ".": "./dist/index.mjs",
+    "./configs": "./dist/configs/index.mjs",
+    "./configs/recommended": "./dist/configs/recommended.mjs",
+    "./helpers/bun-workspace": "./dist/helpers/bun-workspace.mjs",
+    "./helpers/create-rule": "./dist/helpers/create-rule.mjs",
+    "./helpers/iterate-dependencies": "./dist/helpers/iterate-dependencies.mjs",
+    "./plugin": "./dist/plugin.mjs",
+    "./rules/json-enforce-catalog": "./dist/rules/json-enforce-catalog.mjs",
+    "./rules/json-no-duplicate-catalog-item": "./dist/rules/json-no-duplicate-catalog-item.mjs",
+    "./rules/json-no-unused-catalog-item": "./dist/rules/json-no-unused-catalog-item.mjs",
+    "./rules/json-valid-catalog": "./dist/rules/json-valid-catalog.mjs",
     "./package.json": "./package.json"
   },
   "files": ["dist"],
   "dependencies": {
-    "@storm-software/package-constants": "0.1.130",
+    "@storm-software/package-constants": "0.1.132",
     "@typescript-eslint/utils": "^8.66.0",
     "defu": "^6.1.7",
     "find-up-simple": "^1.0.1",
@@ -73,7 +66,7 @@
   "devDependencies": {
     "@eslint/compat": "^2.1.0",
     "@eslint/config-inspector": "^1.5.0",
-    "@storm-software/prettier": "0.59.170",
+    "@storm-software/prettier": "0.59.172",
     "@types/eslint": "^9.6.1",
     "@types/eslint__js": "^8.42.3",
     "@types/node": "^25.9.5",
@@ -87,5 +80,5 @@
   "peerDependencies": { "eslint": ">=9.39.3" },
   "peerDependenciesMeta": { "eslint": { "optional": false } },
   "publishConfig": { "access": "public" },
-  "gitHead": "99b96e99f2b2b77d1d27f97d3c07a64e760a17a1"
+  "gitHead": "b0295f0d2bd154ea4c2eb15e55e0e6dc62978042"
 }

package/dist/configs/index.d.ts

@@ -1,5 +0,0 @@
-import { Linter } from 'eslint';
-
-declare const configs: Record<string, Linter.Config[]>;
-
-export { configs };

package/dist/configs/recommended.d.ts

@@ -1,5 +0,0 @@
-import { Linter } from 'eslint';
-
-declare const config: Linter.Config[];
-
-export { config as default };

package/dist/helpers/bun-workspace.d.ts

@@ -1,48 +0,0 @@
-interface BunWorkspacePackageJson {
-    catalog?: Record<string, string>;
-    catalogs?: Record<string, Record<string, string>>;
-    workspaces?: string[] | {
-        packages?: string[];
-        catalog?: Record<string, string>;
-        catalogs?: Record<string, Record<string, string>>;
-    };
-    [key: string]: unknown;
-}
-type CatalogName = "default" | (string & {});
-interface SpecifierConflicts {
-    conflicts: boolean;
-    newCatalogName: string;
-    existingSpecifier?: string;
-}
-interface BunWorkspace {
-    filepath: string;
-    setContent: (content: string) => void;
-    hasChanged: () => boolean;
-    hasQueue: () => boolean;
-    clearQueue: () => void;
-    queueChange: (fn: (workspace: BunWorkspace) => void, order?: "pre" | "post") => void;
-    toJSON: () => BunWorkspacePackageJson;
-    toString: () => string;
-    setPackage: (catalog: CatalogName, packageName: string, specifier: string) => void;
-    setPackageNoConflicts: (catalog: CatalogName, packageName: string, specifier: string) => void;
-    getPackageCatalogs: (packageName: string) => string[];
-    hasSpecifierConflicts: (catalog: CatalogName, packageName: string, specifier: string) => SpecifierConflicts;
-    getCatalogData: () => {
-        catalog?: Record<string, string>;
-        catalogs?: Record<string, Record<string, string>>;
-    };
-    getWorkspacePackagePatterns: () => string[];
-}
-/**
- * Find and parse the Bun workspace root `package.json` that holds catalogs.
- *
- * Catalogs live in root `package.json` (top-level or under `workspaces`), not
- * `pnpm-workspace.yaml`. See https://bun.com/docs/pm/catalogs
- */
-declare function readBunWorkspace(cwd?: string): BunWorkspace;
-declare function getBunWorkspace(cwd?: string): BunWorkspace;
-declare function resetBunWorkspaceCache(): void;
-declare function isRootWorkspacePackageJson(filename: string, cwd?: string): boolean;
-declare function collectWorkspacePackageJsonPaths(workspaceRoot: BunWorkspace): string[];
-
-export { type BunWorkspace, type BunWorkspacePackageJson, type CatalogName, type SpecifierConflicts, collectWorkspacePackageJsonPaths, getBunWorkspace, isRootWorkspacePackageJson, readBunWorkspace, resetBunWorkspaceCache };