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

package/dist/rules/json-no-unused-catalog-item.mjs

@@ -1,429 +1,76 @@
-import fs from 'node:fs';
-import defu from 'defu';
-import process from 'node:process';
-import { findUpSync } from 'find-up-simple';
-import { normalize, resolve, dirname } from 'pathe';
-import { globSync } from 'tinyglobby';
-
-// src/rules/json-no-unused-catalog-item.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;
-}
-function isRootWorkspacePackageJson(filename, cwd = process.cwd()) {
-  try {
-    const root = getBunWorkspace(cwd);
-    return normalize(root.filepath) === normalize(filename);
-  } catch {
-    return false;
-  }
-}
-function collectWorkspacePackageJsonPaths(workspaceRoot) {
-  const root = resolve(dirname(workspaceRoot.filepath));
-  const patterns = workspaceRoot.getWorkspacePackagePatterns();
-  const dirs = patterns.length ? globSync(patterns, {
-    cwd: root,
-    dot: false,
-    ignore: [
-      "**/node_modules/**",
-      "**/dist/**",
-      "**/build/**"
-    ],
-    absolute: true,
-    expandDirectories: false,
-    onlyDirectories: true
-  }) : [];
-  dirs.push(root);
-  return dirs.map((dir) => resolve(dir, "package.json")).filter((path) => fs.existsSync(path)).sort();
-}
-
-// 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 getObjectPath(obj, path) {
-  let current = obj;
-  for (const key of path) {
-    if (!current || typeof current !== "object") {
-      return void 0;
-    }
-    current = current[key];
-    if (!current) {
-      return void 0;
-    }
-  }
-  return current;
-}
-
-// src/rules/json-no-unused-catalog-item.ts
-var RULE_NAME = "json-no-unused-catalog-item";
-var FIELDS = [
-  "dependencies",
-  "devDependencies",
-  "peerDependencies",
-  "optionalDependencies",
-  "overrides",
-  "resolutions"
+import { createRule } from "../helpers/create-rule.mjs";
+import { collectWorkspacePackageJsonPaths, getBunWorkspace, isRootWorkspacePackageJson } from "../helpers/bun-workspace.mjs";
+import { getObjectPath, getPackageJsonRootNode } from "../helpers/iterate-dependencies.mjs";
+import fs from "node:fs";
+//#region src/rules/json-no-unused-catalog-item.ts
+const RULE_NAME = "json-no-unused-catalog-item";
+const FIELDS = [
+	"dependencies",
+	"devDependencies",
+	"peerDependencies",
+	"optionalDependencies",
+	"overrides",
+	"resolutions"
 ];
 function getProperty(node, key) {
-  return node?.properties?.find(
-    (property) => property.key.type === "JSONLiteral" && property.key.value === key
-  );
+	return node?.properties?.find((property) => property.key.type === "JSONLiteral" && property.key.value === key);
 }
 var json_no_unused_catalog_item_default = createRule({
-  name: RULE_NAME,
-  meta: {
-    type: "problem",
-    docs: {
-      description: "Disallow unused catalog items in the Bun workspace root `package.json`"
-    },
-    schema: [],
-    messages: {
-      unusedCatalogItem: 'Catalog item "{{catalogItem}}" is not used in any package.json.'
-    }
-  },
-  defaultOptions: [],
-  create(context) {
-    if (!isRootWorkspacePackageJson(context.filename)) {
-      return {};
-    }
-    let workspace2;
-    try {
-      workspace2 = getBunWorkspace();
-    } catch {
-      return {};
-    }
-    if (workspace2.hasChanged() || workspace2.hasQueue()) {
-      return {};
-    }
-    workspace2.setContent(context.sourceCode.text);
-    const root = getPackageJsonRootNode(context);
-    if (!root) {
-      return {};
-    }
-    const topCatalog = getProperty(root, "catalog");
-    const topCatalogs = getProperty(root, "catalogs");
-    const workspaces = getProperty(root, "workspaces");
-    const workspacesCatalog = workspaces?.value?.type === "JSONObjectExpression" ? getProperty(workspaces.value, "catalog") : void 0;
-    const workspacesCatalogs = workspaces?.value?.type === "JSONObjectExpression" ? getProperty(workspaces.value, "catalogs") : void 0;
-    const catalogNode = topCatalog ?? workspacesCatalog;
-    const catalogsNode = topCatalogs ?? workspacesCatalogs;
-    const entries = /* @__PURE__ */ new Map();
-    if (catalogNode?.value?.type === "JSONObjectExpression") {
-      for (const property of catalogNode.value.properties || []) {
-        entries.set(`${String(property.key.value)}:default`, property);
-      }
-    }
-    if (catalogsNode?.value?.type === "JSONObjectExpression") {
-      for (const named of catalogsNode.value.properties || []) {
-        if (named.value.type !== "JSONObjectExpression") {
-          continue;
-        }
-        const catalogName = String(named.key.value);
-        for (const property of named.value.properties || []) {
-          entries.set(`${String(property.key.value)}:${catalogName}`, property);
-        }
-      }
-    }
-    if (entries.size === 0) {
-      return {};
-    }
-    const packages = collectWorkspacePackageJsonPaths(workspace2);
-    for (const path of packages) {
-      const pkg = JSON.parse(fs.readFileSync(path, "utf8"));
-      for (const field of FIELDS) {
-        const map = getObjectPath(pkg, field.split("."));
-        if (!map) {
-          continue;
-        }
-        for (const [name, value] of Object.entries(map)) {
-          if (typeof value !== "string" || !value.startsWith("catalog:")) {
-            continue;
-          }
-          const catalogName = value.slice(8) || "default";
-          entries.delete(`${name}:${catalogName}`);
-        }
-      }
-    }
-    if (entries.size > 0) {
-      for (const [key, property] of Array.from(entries.entries()).sort(
-        (a, b) => a[0].localeCompare(b[0])
-      )) {
-        context.report({
-          node: property.value,
-          messageId: "unusedCatalogItem",
-          data: { catalogItem: key }
-        });
-      }
-    }
-    return {};
-  }
+	name: RULE_NAME,
+	meta: {
+		type: "problem",
+		docs: { description: "Disallow unused catalog items in the Bun workspace root `package.json`" },
+		schema: [],
+		messages: { unusedCatalogItem: "Catalog item \"{{catalogItem}}\" is not used in any package.json." }
+	},
+	defaultOptions: [],
+	create(context) {
+		if (!isRootWorkspacePackageJson(context.filename)) return {};
+		let workspace;
+		try {
+			workspace = getBunWorkspace();
+		} catch {
+			return {};
+		}
+		if (workspace.hasChanged() || workspace.hasQueue()) return {};
+		workspace.setContent(context.sourceCode.text);
+		const root = getPackageJsonRootNode(context);
+		if (!root) return {};
+		const topCatalog = getProperty(root, "catalog");
+		const topCatalogs = getProperty(root, "catalogs");
+		const workspaces = getProperty(root, "workspaces");
+		const workspacesCatalog = workspaces?.value?.type === "JSONObjectExpression" ? getProperty(workspaces.value, "catalog") : void 0;
+		const workspacesCatalogs = workspaces?.value?.type === "JSONObjectExpression" ? getProperty(workspaces.value, "catalogs") : void 0;
+		const catalogNode = topCatalog ?? workspacesCatalog;
+		const catalogsNode = topCatalogs ?? workspacesCatalogs;
+		const entries = /* @__PURE__ */ new Map();
+		if (catalogNode?.value?.type === "JSONObjectExpression") for (const property of catalogNode.value.properties || []) entries.set(`${String(property.key.value)}:default`, property);
+		if (catalogsNode?.value?.type === "JSONObjectExpression") for (const named of catalogsNode.value.properties || []) {
+			if (named.value.type !== "JSONObjectExpression") continue;
+			const catalogName = String(named.key.value);
+			for (const property of named.value.properties || []) entries.set(`${String(property.key.value)}:${catalogName}`, property);
+		}
+		if (entries.size === 0) return {};
+		const packages = collectWorkspacePackageJsonPaths(workspace);
+		for (const path of packages) {
+			const pkg = JSON.parse(fs.readFileSync(path, "utf8"));
+			for (const field of FIELDS) {
+				const map = getObjectPath(pkg, field.split("."));
+				if (!map) continue;
+				for (const [name, value] of Object.entries(map)) {
+					if (typeof value !== "string" || !value.startsWith("catalog:")) continue;
+					const catalogName = value.slice(8) || "default";
+					entries.delete(`${name}:${catalogName}`);
+				}
+			}
+		}
+		if (entries.size > 0) for (const [key, property] of Array.from(entries.entries()).sort((a, b) => a[0].localeCompare(b[0]))) context.report({
+			node: property.value,
+			messageId: "unusedCatalogItem",
+			data: { catalogItem: key }
+		});
+		return {};
+	}
 });
-
+//#endregion
 export { json_no_unused_catalog_item_default as default };

package/dist/rules/json-valid-catalog.d.mts

@@ -0,0 +1,11 @@
+import { RuleModule } from "../helpers/create-rule.mjs";
+//#region src/rules/json-valid-catalog.d.ts
+type Options = [{
+  autoInsert?: boolean;
+  autoInsertDefaultSpecifier?: string;
+  autofix?: boolean;
+  fields?: string[];
+}];
+declare const _default: RuleModule<Options>;
+//#endregion
+export { _default as default };