@alextheman/eslint-plugin 5.2.3 → 5.4.0

package/dist/utility/index.js

@@ -0,0 +1,176 @@
+import { AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { DataError, camelToKebab, omitProperties } from "@alextheman/utility";
+import z from "zod";
+
+//#region src/utility/public/checkCallExpression.ts
+/**
+* Checks if a given node matches the expected object and property names.
+*
+* @category Utility
+*
+* @param node - The node to check.
+* @param objectName - The object name to compare against the node.
+* @param propertyName - The property name to compare against the node.
+*
+* @returns A value of `true` if the given `objectName` and `propertyName` matches those of the node, and `false` otherwise.
+*/
+function checkCallExpression(node, objectName, propertyName) {
+	return node.callee.type === AST_NODE_TYPES.MemberExpression && node.callee.object.type === AST_NODE_TYPES.Identifier && node.callee.object.name === objectName && node.callee.property.type === AST_NODE_TYPES.Identifier && node.callee.property.name === propertyName;
+}
+var checkCallExpression_default = checkCallExpression;
+
+//#endregion
+//#region src/utility/public/combineRestrictedImports.ts
+/**
+* Combines multiple option groups for the native ESLint `no-restricted-imports` rule, without overwriting previous configurations.
+*
+* @category Utility
+*
+* @param groups - Option groups to combine, applied in the order provided.
+*
+* @returns A new object combining all paths and patterns from the given groups, suitable as an option to pass to `no-restricted-imports`.
+*/
+function combineRestrictedImports(...groups) {
+	const paths = [];
+	const patterns = [];
+	for (const group of groups) {
+		if (group.paths) paths.push(...group.paths);
+		if (group.patterns) patterns.push(...group.patterns);
+	}
+	const combinedGroup = {
+		paths,
+		patterns
+	};
+	if (combinedGroup.paths.length === 0) return omitProperties(combinedGroup, "paths");
+	if (combinedGroup.patterns.length === 0) return omitProperties(combinedGroup, "patterns");
+	return combinedGroup;
+}
+var combineRestrictedImports_default = combineRestrictedImports;
+
+//#endregion
+//#region src/utility/public/createRuleSchemaFromZodSchema.ts
+/**
+* Converts a Zod schema to a JSON schema for usage in an ESLint rule.
+*
+* @category Utility
+*
+* @param schema - The Zod schema to convert.
+*
+* @returns An array containing the resulting JSON Schema, formatted for ESLint rule schema compatibility.
+*/
+function createRuleSchemaFromZodSchema(schema) {
+	return [omitProperties(z.toJSONSchema(schema), "$schema")];
+}
+var createRuleSchemaFromZodSchema_default = createRuleSchemaFromZodSchema;
+
+//#endregion
+//#region src/utility/public/fixOnCondition.ts
+/**
+* Returns a rule fixer function to run based on a given condition
+*
+* @category Utility
+*
+* @param fixable - Whether the rule should be treated as fixable or not, and therefore whether the fixer should run.
+* @param fix - The rule fixer function to run.
+*
+* @returns The rule fixer function invoked with the fixer, provided the fixable condition is met.
+*/
+function fixOnCondition(fixable, fix) {
+	return (fixer) => {
+		if (!fixable) return null;
+		return fix(fixer);
+	};
+}
+var fixOnCondition_default = fixOnCondition;
+
+//#endregion
+//#region src/utility/private/camelToKebab.ts
+function camelToKebab$1(string) {
+	if (string[0] === string[0].toUpperCase()) throw new DataError(string, "CAMEL_TO_KEBAB_CONVERSION_ERROR", "camelCase string must start with a lowercase letter.");
+	return camelToKebab(string, { preserveConsecutiveCapitals: false });
+}
+var camelToKebab_default = camelToKebab$1;
+
+//#endregion
+//#region src/utility/private/createConfigGroup.ts
+function createConfigGroup(group, configs) {
+	const newConfigs = {};
+	for (const key in configs) newConfigs[`${camelToKebab_default(group)}/${camelToKebab_default(key)}`] = configs[key];
+	return newConfigs;
+}
+var createConfigGroup_default = createConfigGroup;
+
+//#endregion
+//#region src/utility/public/flattenConfigs.ts
+/**
+* Takes in a nested group of configs, and returns them flattened according to ESLint config naming conventions.
+*
+* @category Utility
+*
+* @template ConfigObject - The type of the input config object.
+*
+* @param config - A doubly-nested config object to pass in, where the key of the top-level object is the config group name, and the key of the nested object is the name of the config within the group (e.g. `groupName.configName`).
+*
+* @returns A single-layered object with the key flattened down to be `group-name/config-name`.
+*
+* @example
+*      flattenConfigs<AlexPluginConfigGroup>({
+*          general: {
+*              typeScript: generalTypeScriptConfig,
+*              javaScript: generalJavaScriptConfig,
+*              react: generalReactConfig,
+*              // ...
+*          }
+*          plugin: {
+*              base: pluginBaseConfig,
+*              tests: pluginTestsConfig,
+*              // ...
+*          }
+*      })
+*
+*      // Returns:
+*      {
+*          "general/typescript": generalTypeScriptConfig,
+*          "general/javascript": generalJavaScriptConfig,
+*          "general/react": generalReactConfig,
+*          // ...,
+*          "plugin/base": pluginBaseConfig,
+*          "plugin/tests": pluginTestsConfig
+*          // ...
+*      }
+*/
+function flattenConfigs(config) {
+	const allConfigs = {};
+	for (const configGroupEntries of Object.entries(config)) Object.assign(allConfigs, createConfigGroup_default(...configGroupEntries));
+	return allConfigs;
+}
+var flattenConfigs_default = flattenConfigs;
+
+//#endregion
+//#region src/utility/public/getImportSpecifiersAfterRemoving.ts
+/**
+* Returns a comma-separated string of import specifiers, excluding the specified import.
+*
+* Useful for auto-fixable rules that remove a specific import from an import statement.
+*
+* @category Utility
+*
+* @template RuleOptions - The type of the RuleOptions from the given context.
+*
+* @param context - The current ESLint rule context.
+* @param specifiers - Array of import clause nodes.
+* @param importToRemove - The import name to remove from the list.
+*
+* @returns A comma-separated string of import specifiers after removing the specified import.
+*/
+function getImportSpecifiersAfterRemoving(context, specifiers, importToRemove) {
+	return specifiers.filter((specifier) => {
+		return !(specifier.imported.name === importToRemove);
+	}).map((specifier) => {
+		return context.sourceCode.getText(specifier);
+	}).join(", ");
+}
+var getImportSpecifiersAfterRemoving_default = getImportSpecifiersAfterRemoving;
+
+//#endregion
+export { checkCallExpression_default as checkCallExpression, combineRestrictedImports_default as combineRestrictedImports, createRuleSchemaFromZodSchema_default as createRuleSchemaFromZodSchema, fixOnCondition_default as fixOnCondition, flattenConfigs_default as flattenConfigs, getImportSpecifiersAfterRemoving_default as getImportSpecifiersAfterRemoving };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/eslint-plugin",
-  "version": "5.2.3",
+  "version": "5.4.0",
   "description": "A package to provide custom ESLint rules and configs",
   "repository": {
     "type": "git",
@@ -9,6 +9,20 @@
   "license": "MIT",
   "author": "alextheman",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./utility": {
+      "types": "./dist/utility/index.d.ts",
+      "import": "./dist/utility/index.js",
+      "require": "./dist/utility/index.cjs",
+      "default": "./dist/utility/index.js"
+    }
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -75,13 +89,14 @@
     "eslint-plugin-react-refresh": ">=0.4.0",
     "typedoc": ">=0.28.15",
     "typedoc-plugin-markdown": ">=4.9.0",
-    "typedoc-rhineai-theme": "^1.2.0",
+    "typedoc-rhineai-theme": ">=1.2.0",
     "typescript-eslint": ">=8.0.0",
     "vite-tsconfig-paths": ">=5.1.4",
     "vitest": ">=4.0.13"
   },
   "scripts": {
     "build": "tsdown",
+    "create-feature-docs": "typedoc",
     "create-local-package": "pnpm run build && rm -f alextheman-eslint-plugin-*.tgz && pnpm pack",
     "create-release-note-major": "git pull origin main && alex-c-line create-release-note major",
     "create-release-note-minor": "git pull origin main && alex-c-line create-release-note minor",