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

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

@@ -0,0 +1,14 @@
+import { RuleModule } from "../helpers/create-rule.mjs";
+//#region src/rules/json-enforce-catalog.d.ts
+type Options = [{
+  allowedProtocols?: string[];
+  autofix?: boolean;
+  defaultCatalog?: string;
+  reuseExistingCatalog?: boolean;
+  conflicts?: "new-catalog" | "overrides" | "error";
+  fields?: string[];
+  ignore?: string[];
+}];
+declare const _default: RuleModule<Options>;
+//#endregion
+export { _default as default };

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

@@ -1,447 +1,105 @@
-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-enforce-catalog.ts
-var RULE_NAME = "json-enforce-catalog";
-var DEFAULT_FIELDS = ["dependencies", "devDependencies"];
-var IGNORED_DEPENDENCIES = ["typescript"];
+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-enforce-catalog.ts
+const RULE_NAME = "json-enforce-catalog";
+const DEFAULT_FIELDS = ["dependencies", "devDependencies"];
+const IGNORED_DEPENDENCIES = ["typescript"];
 var json_enforce_catalog_default = createRule({
-  name: RULE_NAME,
-  meta: {
-    type: "layout",
-    docs: {
-      description: 'Enforce using "catalog:" in `package.json` and write versions to the Bun workspace root catalog'
-    },
-    fixable: "code",
-    schema: [
-      {
-        type: "object",
-        properties: {
-          allowedProtocols: {
-            type: "array",
-            description: "Allowed protocols in specifier to not be converted to catalog",
-            items: { type: "string" }
-          },
-          autofix: {
-            type: "boolean",
-            description: "Whether to autofix the linting error",
-            default: true
-          },
-          defaultCatalog: {
-            type: "string",
-            description: "Default catalog to use when moving version to catalog with autofix"
-          },
-          reuseExistingCatalog: {
-            type: "boolean",
-            description: "Whether to reuse existing catalog when moving version to catalog with autofix",
-            default: true
-          },
-          conflicts: {
-            type: "string",
-            description: "Strategy to handle conflicts when adding packages to catalogs",
-            enum: ["new-catalog", "overrides", "error"],
-            default: "new-catalog"
-          },
-          fields: {
-            type: "array",
-            description: "Fields to check for catalog",
-            items: { type: "string" },
-            default: DEFAULT_FIELDS
-          },
-          ignore: {
-            type: "array",
-            description: "A list of dependencies to ignore",
-            items: { type: "string" },
-            default: IGNORED_DEPENDENCIES
-          }
-        },
-        additionalProperties: false
-      }
-    ],
-    messages: {
-      expectCatalog: 'Expect to use catalog instead of plain specifier, got "{{specifier}}" for package "{{packageName}}".'
-    }
-  },
-  defaultOptions: [{}],
-  create(context, [options]) {
-    const {
-      allowedProtocols = ["workspace", "link", "file"],
-      defaultCatalog = "default",
-      autofix = true,
-      reuseExistingCatalog = true,
-      conflicts = "new-catalog",
-      fields = DEFAULT_FIELDS,
-      ignore = IGNORED_DEPENDENCIES
-    } = options || {};
-    for (const { packageName, specifier, property } of iterateDependencies(
-      context,
-      fields
-    )) {
-      if (ignore?.some((name) => name === packageName)) {
-        continue;
-      }
-      if (specifier.startsWith("catalog:")) {
-        continue;
-      }
-      if (allowedProtocols?.some((protocol) => specifier.startsWith(protocol))) {
-        continue;
-      }
-      let workspace2;
-      try {
-        workspace2 = getBunWorkspace();
-      } catch {
-        return {};
-      }
-      let targetCatalog = reuseExistingCatalog ? workspace2.getPackageCatalogs(packageName)[0] || defaultCatalog : defaultCatalog;
-      const resolvedConflicts = workspace2.hasSpecifierConflicts(
-        targetCatalog,
-        packageName,
-        specifier
-      );
-      let shouldFix = autofix;
-      if (conflicts === "error" && resolvedConflicts.conflicts) {
-        shouldFix = false;
-      }
-      if (conflicts === "new-catalog" && resolvedConflicts.conflicts) {
-        targetCatalog = resolvedConflicts.newCatalogName;
-      }
-      context.report({
-        node: property.value,
-        messageId: "expectCatalog",
-        data: {
-          specifier,
-          packageName
-        },
-        fix: shouldFix ? (fixer) => {
-          workspace2.queueChange(() => {
-            workspace2.setPackage(targetCatalog, packageName, specifier);
-          });
-          return fixer.replaceText(
-            property.value,
-            targetCatalog === "default" ? JSON.stringify("catalog:") : JSON.stringify(`catalog:${targetCatalog}`)
-          );
-        } : void 0
-      });
-    }
-    return {};
-  }
+	name: RULE_NAME,
+	meta: {
+		type: "layout",
+		docs: { description: "Enforce using \"catalog:\" in `package.json` and write versions to the Bun workspace root catalog" },
+		fixable: "code",
+		schema: [{
+			type: "object",
+			properties: {
+				allowedProtocols: {
+					type: "array",
+					description: "Allowed protocols in specifier to not be converted to catalog",
+					items: { type: "string" }
+				},
+				autofix: {
+					type: "boolean",
+					description: "Whether to autofix the linting error",
+					default: true
+				},
+				defaultCatalog: {
+					type: "string",
+					description: "Default catalog to use when moving version to catalog with autofix"
+				},
+				reuseExistingCatalog: {
+					type: "boolean",
+					description: "Whether to reuse existing catalog when moving version to catalog with autofix",
+					default: true
+				},
+				conflicts: {
+					type: "string",
+					description: "Strategy to handle conflicts when adding packages to catalogs",
+					enum: [
+						"new-catalog",
+						"overrides",
+						"error"
+					],
+					default: "new-catalog"
+				},
+				fields: {
+					type: "array",
+					description: "Fields to check for catalog",
+					items: { type: "string" },
+					default: DEFAULT_FIELDS
+				},
+				ignore: {
+					type: "array",
+					description: "A list of dependencies to ignore",
+					items: { type: "string" },
+					default: IGNORED_DEPENDENCIES
+				}
+			},
+			additionalProperties: false
+		}],
+		messages: { expectCatalog: "Expect to use catalog instead of plain specifier, got \"{{specifier}}\" for package \"{{packageName}}\"." }
+	},
+	defaultOptions: [{}],
+	create(context, [options]) {
+		const { allowedProtocols = [
+			"workspace",
+			"link",
+			"file"
+		], defaultCatalog = "default", autofix = true, reuseExistingCatalog = true, conflicts = "new-catalog", fields = DEFAULT_FIELDS, ignore = IGNORED_DEPENDENCIES } = options || {};
+		for (const { packageName, specifier, property } of iterateDependencies(context, fields)) {
+			if (ignore?.some((name) => name === packageName)) continue;
+			if (specifier.startsWith("catalog:")) continue;
+			if (allowedProtocols?.some((protocol) => specifier.startsWith(protocol))) continue;
+			let workspace;
+			try {
+				workspace = getBunWorkspace();
+			} catch {
+				return {};
+			}
+			let targetCatalog = reuseExistingCatalog ? workspace.getPackageCatalogs(packageName)[0] || defaultCatalog : defaultCatalog;
+			const resolvedConflicts = workspace.hasSpecifierConflicts(targetCatalog, packageName, specifier);
+			let shouldFix = autofix;
+			if (conflicts === "error" && resolvedConflicts.conflicts) shouldFix = false;
+			if (conflicts === "new-catalog" && resolvedConflicts.conflicts) targetCatalog = resolvedConflicts.newCatalogName;
+			if (conflicts === "overrides") {}
+			context.report({
+				node: property.value,
+				messageId: "expectCatalog",
+				data: {
+					specifier,
+					packageName
+				},
+				fix: shouldFix ? (fixer) => {
+					workspace.queueChange(() => {
+						workspace.setPackage(targetCatalog, packageName, specifier);
+					});
+					return fixer.replaceText(property.value, targetCatalog === "default" ? JSON.stringify("catalog:") : JSON.stringify(`catalog:${targetCatalog}`));
+				} : void 0
+			});
+		}
+		return {};
+	}
 });
-
+//#endregion
 export { json_enforce_catalog_default as default };

package/dist/rules/json-no-duplicate-catalog-item.d.mts

@@ -0,0 +1,8 @@
+import { RuleModule } from "../helpers/create-rule.mjs";
+//#region src/rules/json-no-duplicate-catalog-item.d.ts
+type Options = [{
+  allow?: string[];
+}];
+declare const _default: RuleModule<Options>;
+//#endregion
+export { _default as default };