eslint-fix-utils 0.2.0 → 0.3.0

package/README.md

@@ -8,13 +8,13 @@
 <p align="center">
 	<!-- prettier-ignore-start -->
 	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 2" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-2-21bb42.svg" /></a>
+	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 3" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-3-21bb42.svg" /></a>
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 	<!-- prettier-ignore-end -->
 	<a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
 	<a href="https://codecov.io/gh/JoshuaKGoldberg/eslint-fix-utils" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/eslint-fix-utils?label=%F0%9F%A7%AA%20coverage" /></a>
-	<a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
-	<a href="http://npmjs.com/package/eslint-fix-utils"><img alt="📦 npm version" src="https://img.shields.io/npm/v/eslint-fix-utils?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
+	<a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg" /></a>
+	<a href="http://npmjs.com/package/eslint-fix-utils" target="_blank"><img alt="📦 npm version" src="https://img.shields.io/npm/v/eslint-fix-utils?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
 	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
 </p>
 
@@ -148,7 +148,7 @@ Trailing commas are removed so that the fixed code will work regardless of wheth
 ## Development
 
 See [`.github/CONTRIBUTING.md`](./.github/CONTRIBUTING.md), then [`.github/DEVELOPMENT.md`](./.github/DEVELOPMENT.md).
-Thanks! 💖
+Thanks! 🔧
 
 ## Contributors
 
@@ -159,6 +159,7 @@ Thanks! 💖
 <table>
   <tbody>
     <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://azat.io"><img src="https://avatars.githubusercontent.com/u/5698350?v=4?s=100" width="100px;" alt="Azat S."/><br /><sub><b>Azat S.</b></sub></a><br /><a href="#ideas-azat-io" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a> <a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=JoshuaKGoldberg" title="Tests">⚠️</a> <a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a> <a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/issues?q=author%3AJoshuaKGoldberg" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/michaelfaith"><img src="https://avatars.githubusercontent.com/u/8071845?v=4?s=100" width="100px;" alt="michael faith"/><br /><sub><b>michael faith</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=michaelfaith" title="Code">💻</a> <a href="#content-michaelfaith" title="Content">🖋</a> <a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=michaelfaith" title="Documentation">📖</a> <a href="#ideas-michaelfaith" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-michaelfaith" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-michaelfaith" title="Maintenance">🚧</a> <a href="#projectManagement-michaelfaith" title="Project Management">📆</a> <a href="https://github.com/JoshuaKGoldberg/eslint-fix-utils/commits?author=michaelfaith" title="Tests">⚠️</a> <a href="#tool-michaelfaith" title="Tools">🔧</a></td>
     </tr>
@@ -171,6 +172,4 @@ Thanks! 💖
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 <!-- spellchecker: enable -->
 
-<!-- You can remove this notice if you don't want it 🙂 no worries! -->
-
-> 💝 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [`create` engine](https://create.bingo).
+> 💝 This package was templated with [`create-typescript-app`](https://github.com/JoshuaKGoldberg/create-typescript-app) using the [Bingo engine](https://create.bingo).

package/lib/index.cjs

@@ -1,87 +1,91 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  fixRemoveArrayElement: () => fixRemoveArrayElement,
-  fixRemoveObjectProperty: () => fixRemoveObjectProperty,
-  removeArrayElement: () => removeArrayElement,
-  removeObjectProperty: () => removeObjectProperty
-});
-module.exports = __toCommonJS(index_exports);
-
-// src/removeArrayElement.ts
+//#region src/removeArrayElement.ts
+/**
+* Given an ArrayExpression or the list of elements an ArrayExpression has,
+* the index or node within that array that you want to remove, and a rule fixer,
+* this function yields removals for the node itself, as well as any trailing
+* commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
 function* removeArrayElement(context, fixer, elementOrIndex, parentOrElements) {
-  const elements = Array.isArray(parentOrElements) ? parentOrElements : parentOrElements.elements;
-  const [element, index] = getElementAndIndex(elements, elementOrIndex);
-  if (!element) {
-    throw new Error("Cannot remove a null (blank) array element.");
-  }
-  const tokenAfter = context.sourceCode.getTokenAfter(element);
-  const tokenBefore = context.sourceCode.getTokenBefore(element);
-  if (index > 0 && tokenAfter?.value !== "," && tokenBefore?.value === ",") {
-    yield fixer.remove(tokenBefore);
-  }
-  yield fixer.remove(element);
-  if (tokenAfter?.value === ",") {
-    yield fixer.remove(tokenAfter);
-  }
+	const elements = Array.isArray(parentOrElements) ? parentOrElements : parentOrElements.elements;
+	const [element, index] = getElementAndIndex(elements, elementOrIndex);
+	if (!element) throw new Error("Cannot remove a null (blank) array element.");
+	const tokenAfter = context.sourceCode.getTokenAfter(element);
+	const tokenBefore = context.sourceCode.getTokenBefore(element);
+	if (index > 0 && tokenAfter?.value !== "," && tokenBefore?.value === ",") yield fixer.remove(tokenBefore);
+	yield fixer.remove(element);
+	if (tokenAfter?.value === ",") yield fixer.remove(tokenAfter);
 }
 function getElementAndIndex(elements, elementOrIndex) {
-  if (typeof elementOrIndex === "number") {
-    return [elements[elementOrIndex], elementOrIndex];
-  }
-  const index = elements.indexOf(elementOrIndex);
-  if (index === -1) {
-    throw new Error("Node is not a child of the parent array.");
-  }
-  return [elements[index], index];
+	if (typeof elementOrIndex === "number") return [elements[elementOrIndex], elementOrIndex];
+	const index = elements.indexOf(elementOrIndex);
+	if (index === -1) throw new Error("Node is not a child of the parent array.");
+	return [elements[index], index];
 }
 
-// src/fixRemoveArrayElement.ts
-function fixRemoveArrayElement(context, elementOrIndex, parentOrElements) {
-  return (fixer) => removeArrayElement(context, fixer, elementOrIndex, parentOrElements);
-}
+//#endregion
+//#region src/fixRemoveArrayElement.ts
+/**
+* Given an ArrayExpression or the list of elements an ArrayExpression has, and
+* the index or node within that array that you want to remove, this function
+* returns a fixer function that you can provide to a report descriptor that
+* will remove that node along with any trailing comma.
+* @param context ESLint Rule Context
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes an element from an array expression, along with any commas that are
+* no longer necessary.
+*/
+const fixRemoveArrayElement = (context, elementOrIndex, parentOrElements) => {
+	return (fixer) => removeArrayElement(context, fixer, elementOrIndex, parentOrElements);
+};
 
-// src/removeObjectProperty.ts
+//#endregion
+//#region src/removeObjectProperty.ts
+/**
+* Given an ObjectProperty, and a rule fixer, this function yields removals for
+* the node itself, as well as any trailing commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param property The property node
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
 function* removeObjectProperty(context, fixer, property) {
-  const tokenAfter = context.sourceCode.getTokenAfter(property);
-  const tokenBefore = context.sourceCode.getTokenBefore(property);
-  if (tokenAfter?.value !== "," && tokenBefore?.value === ",") {
-    yield fixer.remove(tokenBefore);
-  }
-  yield fixer.remove(property);
-  if (tokenAfter?.value === ",") {
-    yield fixer.remove(tokenAfter);
-  }
+	const tokenAfter = context.sourceCode.getTokenAfter(property);
+	const tokenBefore = context.sourceCode.getTokenBefore(property);
+	if (tokenAfter?.value !== "," && tokenBefore?.value === ",") yield fixer.remove(tokenBefore);
+	yield fixer.remove(property);
+	if (tokenAfter?.value === ",") yield fixer.remove(tokenAfter);
 }
 
-// src/fixRemoveObjectProperty.ts
-function fixRemoveObjectProperty(context, property) {
-  return (fixer) => removeObjectProperty(context, fixer, property);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  fixRemoveArrayElement,
-  fixRemoveObjectProperty,
-  removeArrayElement,
-  removeObjectProperty
-});
-//# sourceMappingURL=index.cjs.map
+//#endregion
+//#region src/fixRemoveObjectProperty.ts
+/**
+* Given an ObjectProperty, this function returns a fixer function that you can
+* provide to a report descriptor that will remove that node along with any
+* trailing comma.
+* @param context ESLint Rule Context
+* @param property The property node
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes a property from an object expression, along with any commas that
+* are no longer necessary.
+*/
+const fixRemoveObjectProperty = (context, property) => {
+	return (fixer) => removeObjectProperty(context, fixer, property);
+};
+
+//#endregion
+exports.fixRemoveArrayElement = fixRemoveArrayElement;
+exports.fixRemoveObjectProperty = fixRemoveObjectProperty;
+exports.removeArrayElement = removeArrayElement;
+exports.removeObjectProperty = removeObjectProperty;

package/lib/index.d.cts

@@ -1,60 +1,66 @@
-import { Rule } from 'eslint';
-import * as ESTree from 'estree';
+import { Rule } from "eslint";
+import * as ESTree$1 from "estree";
+import * as ESTree from "estree";
 
-type ArrayElement = ESTree.Expression | ESTree.SpreadElement;
-type ArrayElementsOrParent = ESTree.ArrayExpression | ESTree.ArrayExpression["elements"];
+//#region src/removeArrayElement.d.ts
+type ArrayElement = ESTree$1.Expression | ESTree$1.SpreadElement;
+type ArrayElementsOrParent = ESTree$1.ArrayExpression | ESTree$1.ArrayExpression["elements"];
 /**
- * Given an ArrayExpression or the list of elements an ArrayExpression has,
- * the index or node within that array that you want to remove, and a rule fixer,
- * this function yields removals for the node itself, as well as any trailing
- * commas that are no longer necessary.
- * @param context ESLint Rule Context
- * @param fixer Rule fixer
- * @param elementOrIndex The child expression, spread element, or a numeric
- * index of the child
- * @param parentOrElements The array expression node, or its `.elements` array
- * @yields fixer removals for the node itself, as well as any trailing commas
- * that are no longer necessary.
- */
-declare function removeArrayElement(context: Rule.RuleContext, fixer: Rule.RuleFixer, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): Generator<Rule.Fix, void, unknown>;
-
+* Given an ArrayExpression or the list of elements an ArrayExpression has,
+* the index or node within that array that you want to remove, and a rule fixer,
+* this function yields removals for the node itself, as well as any trailing
+* commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
+declare function removeArrayElement(context: Rule.RuleContext, fixer: Rule.RuleFixer, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): Generator<Rule.Fix, void>;
+//#endregion
+//#region src/fixRemoveArrayElement.d.ts
 /**
- * Given an ArrayExpression or the list of elements an ArrayExpression has, and
- * the index or node within that array that you want to remove, this function
- * returns a fixer function that you can provide to a report descriptor that
- * will remove that node along with any trailing comma.
- * @param context ESLint Rule Context
- * @param elementOrIndex The child expression, spread element, or a numeric
- * index of the child
- * @param parentOrElements The array expression node, or its `.elements` array
- * @returns a fixer function that you can provide to a report descriptor, that
- * removes an element from an array expression, along with any commas that are
- * no longer necessary.
- */
-declare function fixRemoveArrayElement(context: Rule.RuleContext, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): (fixer: Rule.RuleFixer) => Generator<Rule.Fix, void, unknown>;
-
+* Given an ArrayExpression or the list of elements an ArrayExpression has, and
+* the index or node within that array that you want to remove, this function
+* returns a fixer function that you can provide to a report descriptor that
+* will remove that node along with any trailing comma.
+* @param context ESLint Rule Context
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes an element from an array expression, along with any commas that are
+* no longer necessary.
+*/
+declare const fixRemoveArrayElement: (context: Rule.RuleContext, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent) => ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>);
+//#endregion
+//#region src/removeObjectProperty.d.ts
 type ObjectProperty = ESTree.Property | ESTree.SpreadElement;
 /**
- * Given an ObjectProperty, and a rule fixer, this function yields removals for
- * the node itself, as well as any trailing commas that are no longer necessary.
- * @param context ESLint Rule Context
- * @param fixer Rule fixer
- * @param property The property node
- * @yields fixer removals for the node itself, as well as any trailing commas
- * that are no longer necessary.
- */
-declare function removeObjectProperty(context: Rule.RuleContext, fixer: Rule.RuleFixer, property: ObjectProperty): Generator<Rule.Fix, void, unknown>;
-
+* Given an ObjectProperty, and a rule fixer, this function yields removals for
+* the node itself, as well as any trailing commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param property The property node
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
+declare function removeObjectProperty(context: Rule.RuleContext, fixer: Rule.RuleFixer, property: ObjectProperty): Generator<Rule.Fix, void>;
+//#endregion
+//#region src/fixRemoveObjectProperty.d.ts
 /**
- * Given an ObjectProperty, this function returns a fixer function that you can
- * provide to a report descriptor that will remove that node along with any
- * trailing comma.
- * @param context ESLint Rule Context
- * @param property The property node
- * @returns a fixer function that you can provide to a report descriptor, that
- * removes a property from an object expression, along with any commas that
- * are no longer necessary.
- */
-declare function fixRemoveObjectProperty(context: Rule.RuleContext, property: ObjectProperty): (fixer: Rule.RuleFixer) => Generator<Rule.Fix, void, unknown>;
-
-export { type ArrayElement, type ArrayElementsOrParent, type ObjectProperty, fixRemoveArrayElement, fixRemoveObjectProperty, removeArrayElement, removeObjectProperty };
+* Given an ObjectProperty, this function returns a fixer function that you can
+* provide to a report descriptor that will remove that node along with any
+* trailing comma.
+* @param context ESLint Rule Context
+* @param property The property node
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes a property from an object expression, along with any commas that
+* are no longer necessary.
+*/
+declare const fixRemoveObjectProperty: (context: Rule.RuleContext, property: ObjectProperty) => ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>);
+//#endregion
+export { ArrayElement, ArrayElementsOrParent, ObjectProperty, fixRemoveArrayElement, fixRemoveObjectProperty, removeArrayElement, removeObjectProperty };
+//# sourceMappingURL=index.d.cts.map

package/lib/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":["context: Rule.RuleContext","fixer: Rule.RuleFixer","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","context: Rule.RuleContext","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","fixer: Rule.RuleFixer","context: Rule.RuleContext","fixer: Rule.RuleFixer","property: ObjectProperty","context: Rule.RuleContext","property: ObjectProperty","fixer: Rule.RuleFixer"],"sources":["../src/removeArrayElement.ts","../src/fixRemoveArrayElement.ts","../src/removeObjectProperty.ts","../src/fixRemoveObjectProperty.ts"],"sourcesContent":[],"mappings":";;;;;KAGY,YAAA,GAAe,QAAA,CAAO,aAAa,QAAA,CAAO;KAE1C,qBAAA,GACT,QAAA,CAAO,kBACP,QAAA,CAAO;;AAJV;;;;AAAsD;AAEtD;;;;AAEU;AAeV;;AACU,iBADO,kBAAA,CACF,OAAA,EAAL,IAAA,CAAK,WAAA,EAAA,KAAA,EACP,IAAA,CAAK,SADE,EAAA,cAAA,EAEE,YAFF,GAAA,MAAA,EAAA,gBAAA,EAGI,qBAHJ,CAAA,EAIZ,SAJY,CAIF,IAAA,CAAK,GAJH,EAAA,IAAA,CAAA;;;;;;AApBf;;;;AAAsD;AAEtD;;;;AAEU;AAeO,cCDJ,qBDCI,EAAA,CAAA,OAAA,ECAP,IAAA,CAAK,WDAE,EAAA,cAAA,ECCA,YDDA,GAAA,MAAA,EAAA,gBAAA,ECEE,qBDFF,EAAA,GAAA,CAAA,CAAA,KAAA,ECGL,IAAA,CAAK,SDHA,EAAA,GCGc,SDHd,CCGwB,IAAA,CAAK,GDH7B,EAAA,IAAA,CAAA,CAAA;;;KEnBL,cAAA,GAAiB,MAAA,CAAO,WAAW,MAAA,CAAO;;;AFAtD;;;;AAAsD;AAEtD;;AACG,iBEQc,oBAAA,CFRP,OAAA,EESA,IAAA,CAAK,WFTL,EAAA,KAAA,EEUF,IAAA,CAAK,SFVH,EAAA,QAAA,EEWC,cFXD,CAAA,EEYP,SFZO,CEYG,IAAA,CAAK,GFZR,EAAA,IAAA,CAAA;;;;;;AAHV;;;;AAAsD;AAEtD;;AACG,cGWU,uBHXH,EAAA,CAAA,OAAA,EGYA,IAAA,CAAK,WHZL,EAAA,QAAA,EGaC,cHbD,EAAA,GAAA,CAAA,CAAA,KAAA,EGcE,IAAA,CAAK,SHdP,EAAA,GGcqB,SHdrB,CGc+B,IAAA,CAAK,GHdpC,EAAA,IAAA,CAAA,CAAA"}

package/lib/index.d.ts

@@ -1,60 +1,66 @@
-import { Rule } from 'eslint';
-import * as ESTree from 'estree';
+import { Rule } from "eslint";
+import * as ESTree$1 from "estree";
+import * as ESTree from "estree";
 
-type ArrayElement = ESTree.Expression | ESTree.SpreadElement;
-type ArrayElementsOrParent = ESTree.ArrayExpression | ESTree.ArrayExpression["elements"];
+//#region src/removeArrayElement.d.ts
+type ArrayElement = ESTree$1.Expression | ESTree$1.SpreadElement;
+type ArrayElementsOrParent = ESTree$1.ArrayExpression | ESTree$1.ArrayExpression["elements"];
 /**
- * Given an ArrayExpression or the list of elements an ArrayExpression has,
- * the index or node within that array that you want to remove, and a rule fixer,
- * this function yields removals for the node itself, as well as any trailing
- * commas that are no longer necessary.
- * @param context ESLint Rule Context
- * @param fixer Rule fixer
- * @param elementOrIndex The child expression, spread element, or a numeric
- * index of the child
- * @param parentOrElements The array expression node, or its `.elements` array
- * @yields fixer removals for the node itself, as well as any trailing commas
- * that are no longer necessary.
- */
-declare function removeArrayElement(context: Rule.RuleContext, fixer: Rule.RuleFixer, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): Generator<Rule.Fix, void, unknown>;
-
+* Given an ArrayExpression or the list of elements an ArrayExpression has,
+* the index or node within that array that you want to remove, and a rule fixer,
+* this function yields removals for the node itself, as well as any trailing
+* commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
+declare function removeArrayElement(context: Rule.RuleContext, fixer: Rule.RuleFixer, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): Generator<Rule.Fix, void>;
+//#endregion
+//#region src/fixRemoveArrayElement.d.ts
 /**
- * Given an ArrayExpression or the list of elements an ArrayExpression has, and
- * the index or node within that array that you want to remove, this function
- * returns a fixer function that you can provide to a report descriptor that
- * will remove that node along with any trailing comma.
- * @param context ESLint Rule Context
- * @param elementOrIndex The child expression, spread element, or a numeric
- * index of the child
- * @param parentOrElements The array expression node, or its `.elements` array
- * @returns a fixer function that you can provide to a report descriptor, that
- * removes an element from an array expression, along with any commas that are
- * no longer necessary.
- */
-declare function fixRemoveArrayElement(context: Rule.RuleContext, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent): (fixer: Rule.RuleFixer) => Generator<Rule.Fix, void, unknown>;
-
+* Given an ArrayExpression or the list of elements an ArrayExpression has, and
+* the index or node within that array that you want to remove, this function
+* returns a fixer function that you can provide to a report descriptor that
+* will remove that node along with any trailing comma.
+* @param context ESLint Rule Context
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes an element from an array expression, along with any commas that are
+* no longer necessary.
+*/
+declare const fixRemoveArrayElement: (context: Rule.RuleContext, elementOrIndex: ArrayElement | number, parentOrElements: ArrayElementsOrParent) => ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>);
+//#endregion
+//#region src/removeObjectProperty.d.ts
 type ObjectProperty = ESTree.Property | ESTree.SpreadElement;
 /**
- * Given an ObjectProperty, and a rule fixer, this function yields removals for
- * the node itself, as well as any trailing commas that are no longer necessary.
- * @param context ESLint Rule Context
- * @param fixer Rule fixer
- * @param property The property node
- * @yields fixer removals for the node itself, as well as any trailing commas
- * that are no longer necessary.
- */
-declare function removeObjectProperty(context: Rule.RuleContext, fixer: Rule.RuleFixer, property: ObjectProperty): Generator<Rule.Fix, void, unknown>;
-
+* Given an ObjectProperty, and a rule fixer, this function yields removals for
+* the node itself, as well as any trailing commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param property The property node
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
+declare function removeObjectProperty(context: Rule.RuleContext, fixer: Rule.RuleFixer, property: ObjectProperty): Generator<Rule.Fix, void>;
+//#endregion
+//#region src/fixRemoveObjectProperty.d.ts
 /**
- * Given an ObjectProperty, this function returns a fixer function that you can
- * provide to a report descriptor that will remove that node along with any
- * trailing comma.
- * @param context ESLint Rule Context
- * @param property The property node
- * @returns a fixer function that you can provide to a report descriptor, that
- * removes a property from an object expression, along with any commas that
- * are no longer necessary.
- */
-declare function fixRemoveObjectProperty(context: Rule.RuleContext, property: ObjectProperty): (fixer: Rule.RuleFixer) => Generator<Rule.Fix, void, unknown>;
-
-export { type ArrayElement, type ArrayElementsOrParent, type ObjectProperty, fixRemoveArrayElement, fixRemoveObjectProperty, removeArrayElement, removeObjectProperty };
+* Given an ObjectProperty, this function returns a fixer function that you can
+* provide to a report descriptor that will remove that node along with any
+* trailing comma.
+* @param context ESLint Rule Context
+* @param property The property node
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes a property from an object expression, along with any commas that
+* are no longer necessary.
+*/
+declare const fixRemoveObjectProperty: (context: Rule.RuleContext, property: ObjectProperty) => ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>);
+//#endregion
+export { ArrayElement, ArrayElementsOrParent, ObjectProperty, fixRemoveArrayElement, fixRemoveObjectProperty, removeArrayElement, removeObjectProperty };
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["context: Rule.RuleContext","fixer: Rule.RuleFixer","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","context: Rule.RuleContext","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","fixer: Rule.RuleFixer","context: Rule.RuleContext","fixer: Rule.RuleFixer","property: ObjectProperty","context: Rule.RuleContext","property: ObjectProperty","fixer: Rule.RuleFixer"],"sources":["../src/removeArrayElement.ts","../src/fixRemoveArrayElement.ts","../src/removeObjectProperty.ts","../src/fixRemoveObjectProperty.ts"],"sourcesContent":[],"mappings":";;;;;KAGY,YAAA,GAAe,QAAA,CAAO,aAAa,QAAA,CAAO;KAE1C,qBAAA,GACT,QAAA,CAAO,kBACP,QAAA,CAAO;;AAJV;;;;AAAsD;AAEtD;;;;AAEU;AAeV;;AACU,iBADO,kBAAA,CACF,OAAA,EAAL,IAAA,CAAK,WAAA,EAAA,KAAA,EACP,IAAA,CAAK,SADE,EAAA,cAAA,EAEE,YAFF,GAAA,MAAA,EAAA,gBAAA,EAGI,qBAHJ,CAAA,EAIZ,SAJY,CAIF,IAAA,CAAK,GAJH,EAAA,IAAA,CAAA;;;;;;AApBf;;;;AAAsD;AAEtD;;;;AAEU;AAeO,cCDJ,qBDCI,EAAA,CAAA,OAAA,ECAP,IAAA,CAAK,WDAE,EAAA,cAAA,ECCA,YDDA,GAAA,MAAA,EAAA,gBAAA,ECEE,qBDFF,EAAA,GAAA,CAAA,CAAA,KAAA,ECGL,IAAA,CAAK,SDHA,EAAA,GCGc,SDHd,CCGwB,IAAA,CAAK,GDH7B,EAAA,IAAA,CAAA,CAAA;;;KEnBL,cAAA,GAAiB,MAAA,CAAO,WAAW,MAAA,CAAO;;;AFAtD;;;;AAAsD;AAEtD;;AACG,iBEQc,oBAAA,CFRP,OAAA,EESA,IAAA,CAAK,WFTL,EAAA,KAAA,EEUF,IAAA,CAAK,SFVH,EAAA,QAAA,EEWC,cFXD,CAAA,EEYP,SFZO,CEYG,IAAA,CAAK,GFZR,EAAA,IAAA,CAAA;;;;;;AAHV;;;;AAAsD;AAEtD;;AACG,cGWU,uBHXH,EAAA,CAAA,OAAA,EGYA,IAAA,CAAK,WHZL,EAAA,QAAA,EGaC,cHbD,EAAA,GAAA,CAAA,CAAA,KAAA,EGcE,IAAA,CAAK,SHdP,EAAA,GGcqB,SHdrB,CGc+B,IAAA,CAAK,GHdpC,EAAA,IAAA,CAAA,CAAA"}

package/lib/index.js

@@ -1,57 +1,88 @@
-// src/removeArrayElement.ts
+//#region src/removeArrayElement.ts
+/**
+* Given an ArrayExpression or the list of elements an ArrayExpression has,
+* the index or node within that array that you want to remove, and a rule fixer,
+* this function yields removals for the node itself, as well as any trailing
+* commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
 function* removeArrayElement(context, fixer, elementOrIndex, parentOrElements) {
-  const elements = Array.isArray(parentOrElements) ? parentOrElements : parentOrElements.elements;
-  const [element, index] = getElementAndIndex(elements, elementOrIndex);
-  if (!element) {
-    throw new Error("Cannot remove a null (blank) array element.");
-  }
-  const tokenAfter = context.sourceCode.getTokenAfter(element);
-  const tokenBefore = context.sourceCode.getTokenBefore(element);
-  if (index > 0 && tokenAfter?.value !== "," && tokenBefore?.value === ",") {
-    yield fixer.remove(tokenBefore);
-  }
-  yield fixer.remove(element);
-  if (tokenAfter?.value === ",") {
-    yield fixer.remove(tokenAfter);
-  }
+	const elements = Array.isArray(parentOrElements) ? parentOrElements : parentOrElements.elements;
+	const [element, index] = getElementAndIndex(elements, elementOrIndex);
+	if (!element) throw new Error("Cannot remove a null (blank) array element.");
+	const tokenAfter = context.sourceCode.getTokenAfter(element);
+	const tokenBefore = context.sourceCode.getTokenBefore(element);
+	if (index > 0 && tokenAfter?.value !== "," && tokenBefore?.value === ",") yield fixer.remove(tokenBefore);
+	yield fixer.remove(element);
+	if (tokenAfter?.value === ",") yield fixer.remove(tokenAfter);
 }
 function getElementAndIndex(elements, elementOrIndex) {
-  if (typeof elementOrIndex === "number") {
-    return [elements[elementOrIndex], elementOrIndex];
-  }
-  const index = elements.indexOf(elementOrIndex);
-  if (index === -1) {
-    throw new Error("Node is not a child of the parent array.");
-  }
-  return [elements[index], index];
+	if (typeof elementOrIndex === "number") return [elements[elementOrIndex], elementOrIndex];
+	const index = elements.indexOf(elementOrIndex);
+	if (index === -1) throw new Error("Node is not a child of the parent array.");
+	return [elements[index], index];
 }
 
-// src/fixRemoveArrayElement.ts
-function fixRemoveArrayElement(context, elementOrIndex, parentOrElements) {
-  return (fixer) => removeArrayElement(context, fixer, elementOrIndex, parentOrElements);
-}
+//#endregion
+//#region src/fixRemoveArrayElement.ts
+/**
+* Given an ArrayExpression or the list of elements an ArrayExpression has, and
+* the index or node within that array that you want to remove, this function
+* returns a fixer function that you can provide to a report descriptor that
+* will remove that node along with any trailing comma.
+* @param context ESLint Rule Context
+* @param elementOrIndex The child expression, spread element, or a numeric
+* index of the child
+* @param parentOrElements The array expression node, or its `.elements` array
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes an element from an array expression, along with any commas that are
+* no longer necessary.
+*/
+const fixRemoveArrayElement = (context, elementOrIndex, parentOrElements) => {
+	return (fixer) => removeArrayElement(context, fixer, elementOrIndex, parentOrElements);
+};
 
-// src/removeObjectProperty.ts
+//#endregion
+//#region src/removeObjectProperty.ts
+/**
+* Given an ObjectProperty, and a rule fixer, this function yields removals for
+* the node itself, as well as any trailing commas that are no longer necessary.
+* @param context ESLint Rule Context
+* @param fixer Rule fixer
+* @param property The property node
+* @yields fixer removals for the node itself, as well as any trailing commas
+* that are no longer necessary.
+*/
 function* removeObjectProperty(context, fixer, property) {
-  const tokenAfter = context.sourceCode.getTokenAfter(property);
-  const tokenBefore = context.sourceCode.getTokenBefore(property);
-  if (tokenAfter?.value !== "," && tokenBefore?.value === ",") {
-    yield fixer.remove(tokenBefore);
-  }
-  yield fixer.remove(property);
-  if (tokenAfter?.value === ",") {
-    yield fixer.remove(tokenAfter);
-  }
+	const tokenAfter = context.sourceCode.getTokenAfter(property);
+	const tokenBefore = context.sourceCode.getTokenBefore(property);
+	if (tokenAfter?.value !== "," && tokenBefore?.value === ",") yield fixer.remove(tokenBefore);
+	yield fixer.remove(property);
+	if (tokenAfter?.value === ",") yield fixer.remove(tokenAfter);
 }
 
-// src/fixRemoveObjectProperty.ts
-function fixRemoveObjectProperty(context, property) {
-  return (fixer) => removeObjectProperty(context, fixer, property);
-}
-export {
-  fixRemoveArrayElement,
-  fixRemoveObjectProperty,
-  removeArrayElement,
-  removeObjectProperty
+//#endregion
+//#region src/fixRemoveObjectProperty.ts
+/**
+* Given an ObjectProperty, this function returns a fixer function that you can
+* provide to a report descriptor that will remove that node along with any
+* trailing comma.
+* @param context ESLint Rule Context
+* @param property The property node
+* @returns a fixer function that you can provide to a report descriptor, that
+* removes a property from an object expression, along with any commas that
+* are no longer necessary.
+*/
+const fixRemoveObjectProperty = (context, property) => {
+	return (fixer) => removeObjectProperty(context, fixer, property);
 };
+
+//#endregion
+export { fixRemoveArrayElement, fixRemoveObjectProperty, removeArrayElement, removeObjectProperty };
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/removeArrayElement.ts","../src/fixRemoveArrayElement.ts","../src/removeObjectProperty.ts","../src/fixRemoveObjectProperty.ts"],"sourcesContent":["import { Rule } from \"eslint\";\nimport * as ESTree from \"estree\";\n\nexport type ArrayElement = ESTree.Expression | ESTree.SpreadElement;\n\nexport type ArrayElementsOrParent =\n\t| ESTree.ArrayExpression\n\t| ESTree.ArrayExpression[\"elements\"];\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has,\n * the index or node within that array that you want to remove, and a rule fixer,\n * this function yields removals for the node itself, as well as any trailing\n * commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeArrayElement(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n) {\n\tconst elements = Array.isArray(parentOrElements)\n\t\t? parentOrElements\n\t\t: parentOrElements.elements;\n\tconst [element, index] = getElementAndIndex(elements, elementOrIndex);\n\n\tif (!element) {\n\t\tthrow new Error(\"Cannot remove a null (blank) array element.\");\n\t}\n\n\tconst tokenAfter = context.sourceCode.getTokenAfter(element);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(element);\n\n\t// If this is the last line and it's not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (index > 0 && tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(element);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n\nfunction getElementAndIndex(\n\telements: (ArrayElement | null)[],\n\telementOrIndex: ArrayElement | number,\n) {\n\tif (typeof elementOrIndex === \"number\") {\n\t\treturn [elements[elementOrIndex], elementOrIndex] as const;\n\t}\n\n\tconst index = elements.indexOf(elementOrIndex);\n\n\tif (index === -1) {\n\t\tthrow new Error(\"Node is not a child of the parent array.\");\n\t}\n\n\treturn [elements[index], index] as const;\n}\n","import { Rule } from \"eslint\";\n\nimport {\n\tArrayElement,\n\tArrayElementsOrParent,\n\tremoveArrayElement,\n} from \"./removeArrayElement\";\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has, and\n * the index or node within that array that you want to remove, this function\n * returns a fixer function that you can provide to a report descriptor that\n * will remove that node along with any trailing comma.\n * @param context ESLint Rule Context\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes an element from an array expression, along with any commas that are\n * no longer necessary.\n */\nexport function fixRemoveArrayElement(\n\tcontext: Rule.RuleContext,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n) {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveArrayElement(context, fixer, elementOrIndex, parentOrElements);\n}\n","import { Rule } from \"eslint\";\nimport * as ESTree from \"estree\";\n\nexport type ObjectProperty = ESTree.Property | ESTree.SpreadElement;\n\n/**\n * Given an ObjectProperty, and a rule fixer, this function yields removals for\n * the node itself, as well as any trailing commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param property The property node\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeObjectProperty(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\tproperty: ObjectProperty,\n) {\n\tconst tokenAfter = context.sourceCode.getTokenAfter(property);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(property);\n\n\t// If this is not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(property);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n","import { Rule } from \"eslint\";\n\nimport { ObjectProperty, removeObjectProperty } from \"./removeObjectProperty\";\n\n/**\n * Given an ObjectProperty, this function returns a fixer function that you can\n * provide to a report descriptor that will remove that node along with any\n * trailing comma.\n * @param context ESLint Rule Context\n * @param property The property node\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes a property from an object expression, along with any commas that\n * are no longer necessary.\n */\nexport function fixRemoveObjectProperty(\n\tcontext: Rule.RuleContext,\n\tproperty: ObjectProperty,\n) {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveObjectProperty(context, fixer, property);\n}\n"],"mappings":";AAsBO,UAAU,mBAChB,SACA,OACA,gBACA,kBACC;AACD,QAAM,WAAW,MAAM,QAAQ,gBAAgB,IAC5C,mBACA,iBAAiB;AACpB,QAAM,CAAC,SAAS,KAAK,IAAI,mBAAmB,UAAU,cAAc;AAEpE,MAAI,CAAC,SAAS;AACb,UAAM,IAAI,MAAM,6CAA6C;AAAA,EAC9D;AAEA,QAAM,aAAa,QAAQ,WAAW,cAAc,OAAO;AAC3D,QAAM,cAAc,QAAQ,WAAW,eAAe,OAAO;AAI7D,MAAI,QAAQ,KAAK,YAAY,UAAU,OAAO,aAAa,UAAU,KAAK;AACzE,UAAM,MAAM,OAAO,WAAW;AAAA,EAC/B;AAEA,QAAM,MAAM,OAAO,OAAO;AAG1B,MAAI,YAAY,UAAU,KAAK;AAC9B,UAAM,MAAM,OAAO,UAAU;AAAA,EAC9B;AACD;AAEA,SAAS,mBACR,UACA,gBACC;AACD,MAAI,OAAO,mBAAmB,UAAU;AACvC,WAAO,CAAC,SAAS,cAAc,GAAG,cAAc;AAAA,EACjD;AAEA,QAAM,QAAQ,SAAS,QAAQ,cAAc;AAE7C,MAAI,UAAU,IAAI;AACjB,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC3D;AAEA,SAAO,CAAC,SAAS,KAAK,GAAG,KAAK;AAC/B;;;AChDO,SAAS,sBACf,SACA,gBACA,kBACC;AACD,SAAO,CAAC,UACP,mBAAmB,SAAS,OAAO,gBAAgB,gBAAgB;AACrE;;;ACdO,UAAU,qBAChB,SACA,OACA,UACC;AACD,QAAM,aAAa,QAAQ,WAAW,cAAc,QAAQ;AAC5D,QAAM,cAAc,QAAQ,WAAW,eAAe,QAAQ;AAI9D,MAAI,YAAY,UAAU,OAAO,aAAa,UAAU,KAAK;AAC5D,UAAM,MAAM,OAAO,WAAW;AAAA,EAC/B;AAEA,QAAM,MAAM,OAAO,QAAQ;AAG3B,MAAI,YAAY,UAAU,KAAK;AAC9B,UAAM,MAAM,OAAO,UAAU;AAAA,EAC9B;AACD;;;ACpBO,SAAS,wBACf,SACA,UACC;AACD,SAAO,CAAC,UACP,qBAAqB,SAAS,OAAO,QAAQ;AAC/C;","names":[]}
+{"version":3,"file":"index.js","names":["context: Rule.RuleContext","fixer: Rule.RuleFixer","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","elements: (ArrayElement | null)[]","context: Rule.RuleContext","elementOrIndex: ArrayElement | number","parentOrElements: ArrayElementsOrParent","fixer: Rule.RuleFixer","context: Rule.RuleContext","fixer: Rule.RuleFixer","property: ObjectProperty","context: Rule.RuleContext","property: ObjectProperty","fixer: Rule.RuleFixer"],"sources":["../src/removeArrayElement.ts","../src/fixRemoveArrayElement.ts","../src/removeObjectProperty.ts","../src/fixRemoveObjectProperty.ts"],"sourcesContent":["import type { Rule } from \"eslint\";\nimport type * as ESTree from \"estree\";\n\nexport type ArrayElement = ESTree.Expression | ESTree.SpreadElement;\n\nexport type ArrayElementsOrParent =\n\t| ESTree.ArrayExpression\n\t| ESTree.ArrayExpression[\"elements\"];\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has,\n * the index or node within that array that you want to remove, and a rule fixer,\n * this function yields removals for the node itself, as well as any trailing\n * commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeArrayElement(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n): Generator<Rule.Fix, void> {\n\tconst elements = Array.isArray(parentOrElements)\n\t\t? parentOrElements\n\t\t: parentOrElements.elements;\n\tconst [element, index] = getElementAndIndex(elements, elementOrIndex);\n\n\tif (!element) {\n\t\tthrow new Error(\"Cannot remove a null (blank) array element.\");\n\t}\n\n\tconst tokenAfter = context.sourceCode.getTokenAfter(element);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(element);\n\n\t// If this is the last line and it's not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (index > 0 && tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(element);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n\nfunction getElementAndIndex(\n\telements: (ArrayElement | null)[],\n\telementOrIndex: ArrayElement | number,\n) {\n\tif (typeof elementOrIndex === \"number\") {\n\t\treturn [elements[elementOrIndex], elementOrIndex] as const;\n\t}\n\n\tconst index = elements.indexOf(elementOrIndex);\n\n\tif (index === -1) {\n\t\tthrow new Error(\"Node is not a child of the parent array.\");\n\t}\n\n\treturn [elements[index], index] as const;\n}\n","import type { Rule } from \"eslint\";\n\nimport {\n\ttype ArrayElement,\n\ttype ArrayElementsOrParent,\n\tremoveArrayElement,\n} from \"./removeArrayElement\";\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has, and\n * the index or node within that array that you want to remove, this function\n * returns a fixer function that you can provide to a report descriptor that\n * will remove that node along with any trailing comma.\n * @param context ESLint Rule Context\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes an element from an array expression, along with any commas that are\n * no longer necessary.\n */\nexport const fixRemoveArrayElement = (\n\tcontext: Rule.RuleContext,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n): ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>) => {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveArrayElement(context, fixer, elementOrIndex, parentOrElements);\n};\n","import type { Rule } from \"eslint\";\nimport type * as ESTree from \"estree\";\n\nexport type ObjectProperty = ESTree.Property | ESTree.SpreadElement;\n\n/**\n * Given an ObjectProperty, and a rule fixer, this function yields removals for\n * the node itself, as well as any trailing commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param property The property node\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeObjectProperty(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\tproperty: ObjectProperty,\n): Generator<Rule.Fix, void> {\n\tconst tokenAfter = context.sourceCode.getTokenAfter(property);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(property);\n\n\t// If this is not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(property);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n","import type { Rule } from \"eslint\";\n\nimport {\n\ttype ObjectProperty,\n\tremoveObjectProperty,\n} from \"./removeObjectProperty\";\n\n/**\n * Given an ObjectProperty, this function returns a fixer function that you can\n * provide to a report descriptor that will remove that node along with any\n * trailing comma.\n * @param context ESLint Rule Context\n * @param property The property node\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes a property from an object expression, along with any commas that\n * are no longer necessary.\n */\nexport const fixRemoveObjectProperty = (\n\tcontext: Rule.RuleContext,\n\tproperty: ObjectProperty,\n): ((fixer: Rule.RuleFixer) => Generator<Rule.Fix, void>) => {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveObjectProperty(context, fixer, property);\n};\n"],"mappings":";;;;;;;;;;;;;;AAsBA,UAAiB,mBAChBA,SACAC,OACAC,gBACAC,kBAC4B;CAC5B,MAAM,WAAW,MAAM,QAAQ,iBAAiB,GAC7C,mBACA,iBAAiB;CACpB,MAAM,CAAC,SAAS,MAAM,GAAG,mBAAmB,UAAU,eAAe;AAErE,MAAK,QACJ,OAAM,IAAI,MAAM;CAGjB,MAAM,aAAa,QAAQ,WAAW,cAAc,QAAQ;CAC5D,MAAM,cAAc,QAAQ,WAAW,eAAe,QAAQ;AAI9D,KAAI,QAAQ,KAAK,YAAY,UAAU,OAAO,aAAa,UAAU,IACpE,OAAM,MAAM,OAAO,YAAY;AAGhC,OAAM,MAAM,OAAO,QAAQ;AAG3B,KAAI,YAAY,UAAU,IACzB,OAAM,MAAM,OAAO,WAAW;AAE/B;AAED,SAAS,mBACRC,UACAF,gBACC;AACD,YAAW,mBAAmB,SAC7B,QAAO,CAAC,SAAS,iBAAiB,cAAe;CAGlD,MAAM,QAAQ,SAAS,QAAQ,eAAe;AAE9C,KAAI,UAAU,GACb,OAAM,IAAI,MAAM;AAGjB,QAAO,CAAC,SAAS,QAAQ,KAAM;AAC/B;;;;;;;;;;;;;;;;;AChDD,MAAa,wBAAwB,CACpCG,SACAC,gBACAC,qBAC4D;AAC5D,QAAO,CAACC,UACP,mBAAmB,SAAS,OAAO,gBAAgB,iBAAiB;AACrE;;;;;;;;;;;;;ACdD,UAAiB,qBAChBC,SACAC,OACAC,UAC4B;CAC5B,MAAM,aAAa,QAAQ,WAAW,cAAc,SAAS;CAC7D,MAAM,cAAc,QAAQ,WAAW,eAAe,SAAS;AAI/D,KAAI,YAAY,UAAU,OAAO,aAAa,UAAU,IACvD,OAAM,MAAM,OAAO,YAAY;AAGhC,OAAM,MAAM,OAAO,SAAS;AAG5B,KAAI,YAAY,UAAU,IACzB,OAAM,MAAM,OAAO,WAAW;AAE/B;;;;;;;;;;;;;;ACjBD,MAAa,0BAA0B,CACtCC,SACAC,aAC4D;AAC5D,QAAO,CAACC,UACP,qBAAqB,SAAS,OAAO,SAAS;AAC/C"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-fix-utils",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"description": "Utilities for ESLint rule fixers and suggestions. 🧑‍🔧",
 	"repository": {
 		"type": "git",
@@ -32,7 +32,7 @@
 		"package.json"
 	],
 	"scripts": {
-		"build": "tsup",
+		"build": "tsdown",
 		"format": "prettier .",
 		"lint": "eslint . --max-warnings 0",
 		"lint:knip": "knip",
@@ -47,48 +47,54 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"devDependencies": {
-		"@eslint-community/eslint-plugin-eslint-comments": "4.4.1",
-		"@eslint/js": "9.18.0",
+		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
+		"@eslint/js": "9.28.0",
 		"@release-it/conventional-changelog": "10.0.0",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/estree": "1.0.6",
-		"@types/node": "22.10.2",
-		"@vitest/coverage-v8": "2.1.8",
-		"@vitest/eslint-plugin": "1.1.20",
+		"@types/node": "22.15.0",
+		"@vitest/coverage-v8": "3.2.0",
+		"@vitest/eslint-plugin": "1.2.0",
 		"console-fail-test": "0.5.0",
-		"cspell": "8.17.2",
-		"eslint": "9.18.0",
-		"eslint-plugin-jsdoc": "50.6.1",
-		"eslint-plugin-jsonc": "2.18.2",
+		"create-typescript-app": "2.42.0",
+		"cspell": "9.0.0",
+		"eslint": "9.28.0",
+		"eslint-plugin-jsdoc": "50.7.0",
+		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.0",
-		"eslint-plugin-n": "17.15.1",
-		"eslint-plugin-package-json": "0.19.0",
-		"eslint-plugin-perfectionist": "4.6.0",
-		"eslint-plugin-regexp": "2.7.0",
-		"eslint-plugin-yml": "1.16.0",
+		"eslint-plugin-n": "17.16.2",
+		"eslint-plugin-package-json": "0.33.0",
+		"eslint-plugin-perfectionist": "4.14.0",
+		"eslint-plugin-regexp": "2.8.0",
+		"eslint-plugin-yml": "1.18.0",
 		"husky": "9.1.7",
-		"knip": "5.42.2",
-		"lint-staged": "15.4.0",
-		"markdownlint": "0.37.2",
-		"markdownlint-cli": "0.43.0",
-		"prettier": "3.4.2",
+		"knip": "5.59.0",
+		"lint-staged": "16.1.0",
+		"markdownlint": "0.38.0",
+		"markdownlint-cli": "0.45.0",
+		"prettier": "3.5.3",
 		"prettier-plugin-curly": "0.3.1",
-		"prettier-plugin-packagejson": "2.5.6",
-		"prettier-plugin-sh": "0.14.0",
-		"release-it": "18.1.1",
+		"prettier-plugin-packagejson": "2.5.10",
+		"prettier-plugin-sh": "0.17.0",
+		"release-it": "19.0.1",
 		"sentences-per-line": "0.3.0",
-		"tsup": "8.3.5",
-		"typescript": "5.7.2",
-		"typescript-eslint": "8.20.0",
-		"vitest": "2.1.8"
+		"tsdown": "0.12.0",
+		"typescript": "5.8.2",
+		"typescript-eslint": "8.33.0",
+		"vitest": "3.2.0"
 	},
 	"peerDependencies": {
 		"@types/estree": ">=1",
 		"eslint": ">=8"
 	},
-	"packageManager": "pnpm@9.15.3",
+	"peerDependenciesMeta": {
+		"@types/estree": {
+			"optional": true
+		}
+	},
+	"packageManager": "pnpm@10.11.0",
 	"engines": {
-		"node": ">=18.3.0"
+		"node": "^20.19.0 || >=22.12.0"
 	},
 	"publishConfig": {
 		"provenance": true

package/lib/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.ts","../src/removeArrayElement.ts","../src/fixRemoveArrayElement.ts","../src/removeObjectProperty.ts","../src/fixRemoveObjectProperty.ts"],"sourcesContent":["export * from \"./fixRemoveArrayElement\";\nexport * from \"./fixRemoveObjectProperty\";\nexport * from \"./removeArrayElement\";\nexport * from \"./removeObjectProperty\";\n","import { Rule } from \"eslint\";\nimport * as ESTree from \"estree\";\n\nexport type ArrayElement = ESTree.Expression | ESTree.SpreadElement;\n\nexport type ArrayElementsOrParent =\n\t| ESTree.ArrayExpression\n\t| ESTree.ArrayExpression[\"elements\"];\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has,\n * the index or node within that array that you want to remove, and a rule fixer,\n * this function yields removals for the node itself, as well as any trailing\n * commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeArrayElement(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n) {\n\tconst elements = Array.isArray(parentOrElements)\n\t\t? parentOrElements\n\t\t: parentOrElements.elements;\n\tconst [element, index] = getElementAndIndex(elements, elementOrIndex);\n\n\tif (!element) {\n\t\tthrow new Error(\"Cannot remove a null (blank) array element.\");\n\t}\n\n\tconst tokenAfter = context.sourceCode.getTokenAfter(element);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(element);\n\n\t// If this is the last line and it's not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (index > 0 && tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(element);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n\nfunction getElementAndIndex(\n\telements: (ArrayElement | null)[],\n\telementOrIndex: ArrayElement | number,\n) {\n\tif (typeof elementOrIndex === \"number\") {\n\t\treturn [elements[elementOrIndex], elementOrIndex] as const;\n\t}\n\n\tconst index = elements.indexOf(elementOrIndex);\n\n\tif (index === -1) {\n\t\tthrow new Error(\"Node is not a child of the parent array.\");\n\t}\n\n\treturn [elements[index], index] as const;\n}\n","import { Rule } from \"eslint\";\n\nimport {\n\tArrayElement,\n\tArrayElementsOrParent,\n\tremoveArrayElement,\n} from \"./removeArrayElement\";\n\n/**\n * Given an ArrayExpression or the list of elements an ArrayExpression has, and\n * the index or node within that array that you want to remove, this function\n * returns a fixer function that you can provide to a report descriptor that\n * will remove that node along with any trailing comma.\n * @param context ESLint Rule Context\n * @param elementOrIndex The child expression, spread element, or a numeric\n * index of the child\n * @param parentOrElements The array expression node, or its `.elements` array\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes an element from an array expression, along with any commas that are\n * no longer necessary.\n */\nexport function fixRemoveArrayElement(\n\tcontext: Rule.RuleContext,\n\telementOrIndex: ArrayElement | number,\n\tparentOrElements: ArrayElementsOrParent,\n) {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveArrayElement(context, fixer, elementOrIndex, parentOrElements);\n}\n","import { Rule } from \"eslint\";\nimport * as ESTree from \"estree\";\n\nexport type ObjectProperty = ESTree.Property | ESTree.SpreadElement;\n\n/**\n * Given an ObjectProperty, and a rule fixer, this function yields removals for\n * the node itself, as well as any trailing commas that are no longer necessary.\n * @param context ESLint Rule Context\n * @param fixer Rule fixer\n * @param property The property node\n * @yields fixer removals for the node itself, as well as any trailing commas\n * that are no longer necessary.\n */\nexport function* removeObjectProperty(\n\tcontext: Rule.RuleContext,\n\tfixer: Rule.RuleFixer,\n\tproperty: ObjectProperty,\n) {\n\tconst tokenAfter = context.sourceCode.getTokenAfter(property);\n\tconst tokenBefore = context.sourceCode.getTokenBefore(property);\n\n\t// If this is not the only entry, then the line above this one\n\t// will become the last line, and should not have a trailing comma.\n\tif (tokenAfter?.value !== \",\" && tokenBefore?.value === \",\") {\n\t\tyield fixer.remove(tokenBefore);\n\t}\n\n\tyield fixer.remove(property);\n\n\t// If this is not the last entry, then we need to remove the comma from this line.\n\tif (tokenAfter?.value === \",\") {\n\t\tyield fixer.remove(tokenAfter);\n\t}\n}\n","import { Rule } from \"eslint\";\n\nimport { ObjectProperty, removeObjectProperty } from \"./removeObjectProperty\";\n\n/**\n * Given an ObjectProperty, this function returns a fixer function that you can\n * provide to a report descriptor that will remove that node along with any\n * trailing comma.\n * @param context ESLint Rule Context\n * @param property The property node\n * @returns a fixer function that you can provide to a report descriptor, that\n * removes a property from an object expression, along with any commas that\n * are no longer necessary.\n */\nexport function fixRemoveObjectProperty(\n\tcontext: Rule.RuleContext,\n\tproperty: ObjectProperty,\n) {\n\treturn (fixer: Rule.RuleFixer) =>\n\t\tremoveObjectProperty(context, fixer, property);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACsBO,UAAU,mBAChB,SACA,OACA,gBACA,kBACC;AACD,QAAM,WAAW,MAAM,QAAQ,gBAAgB,IAC5C,mBACA,iBAAiB;AACpB,QAAM,CAAC,SAAS,KAAK,IAAI,mBAAmB,UAAU,cAAc;AAEpE,MAAI,CAAC,SAAS;AACb,UAAM,IAAI,MAAM,6CAA6C;AAAA,EAC9D;AAEA,QAAM,aAAa,QAAQ,WAAW,cAAc,OAAO;AAC3D,QAAM,cAAc,QAAQ,WAAW,eAAe,OAAO;AAI7D,MAAI,QAAQ,KAAK,YAAY,UAAU,OAAO,aAAa,UAAU,KAAK;AACzE,UAAM,MAAM,OAAO,WAAW;AAAA,EAC/B;AAEA,QAAM,MAAM,OAAO,OAAO;AAG1B,MAAI,YAAY,UAAU,KAAK;AAC9B,UAAM,MAAM,OAAO,UAAU;AAAA,EAC9B;AACD;AAEA,SAAS,mBACR,UACA,gBACC;AACD,MAAI,OAAO,mBAAmB,UAAU;AACvC,WAAO,CAAC,SAAS,cAAc,GAAG,cAAc;AAAA,EACjD;AAEA,QAAM,QAAQ,SAAS,QAAQ,cAAc;AAE7C,MAAI,UAAU,IAAI;AACjB,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC3D;AAEA,SAAO,CAAC,SAAS,KAAK,GAAG,KAAK;AAC/B;;;AChDO,SAAS,sBACf,SACA,gBACA,kBACC;AACD,SAAO,CAAC,UACP,mBAAmB,SAAS,OAAO,gBAAgB,gBAAgB;AACrE;;;ACdO,UAAU,qBAChB,SACA,OACA,UACC;AACD,QAAM,aAAa,QAAQ,WAAW,cAAc,QAAQ;AAC5D,QAAM,cAAc,QAAQ,WAAW,eAAe,QAAQ;AAI9D,MAAI,YAAY,UAAU,OAAO,aAAa,UAAU,KAAK;AAC5D,UAAM,MAAM,OAAO,WAAW;AAAA,EAC/B;AAEA,QAAM,MAAM,OAAO,QAAQ;AAG3B,MAAI,YAAY,UAAU,KAAK;AAC9B,UAAM,MAAM,OAAO,UAAU;AAAA,EAC9B;AACD;;;ACpBO,SAAS,wBACf,SACA,UACC;AACD,SAAO,CAAC,UACP,qBAAqB,SAAS,OAAO,QAAQ;AAC/C;","names":[]}