JoshuaKGoldbergESLint Fix Utils
Utilities for ESLint rule fixers and suggestions. π§βπ§
Usage
If you're working on an ESLint plugin, install this as a dependency:
npm i eslint-fix-utilsYou'll then be able to use any of its exported utilities in your rules.
Fixer APIs
fixRemoveArrayElement
Version of removeArrayElement that can be passed directly as a fix property.
import { fixRemoveArrayElement } from "eslint-fix-utils";
// ...
export function report(index: number, node: ESTree.ArrayExpression) {
context.report({
fix: fixRemoveArrayElement(context, index, node.elements),
messageId,
node: node.elements[index],
});
}fixRemoveObjectProperty
Version of removeObjectProperty that can be passed directly as a fix property.
import { fixRemoveObjectProperty } from "eslint-fix-utils";
// ...
export function report(index: number, node: ESTree.ObjectExpression) {
context.report({
fix: fixRemoveObjectProperty(context, node.properties[index]),
messageId,
node: node.properties[index],
});
}Full APIs
removeArrayElement
Removes an element from an array expression, along with any commas that are no longer necessary.
Parameters:
contextfixerelementOrIndex: the child expression, spread element, or a numeric index of the childparentOrElements: the array expression node, or its.elementsarray
import { removeArrayElement } from "eslint-fix-utils";
// ...
export function report(index: number, node: ESTree.ArrayExpression) {
context.report({
fix(fixer) {
// Removes the last element of the array:
return removeArrayElement(context, fixer, index, node.elements);
},
messageId,
node: node.elements[index],
});
}[
'a',
- 'b',
- 'c'
+ 'b'
]Trailing commas are removed so that the fixed code will work regardless of whether the language and location allows them.
removeObjectProperty
Removes a property from an object expression, along with any commas that are no longer necessary.
Parameters:
contextfixerproperty: the property node
import { removeObjectProperty } from "eslint-fix-utils";
// ...
export function report(index: number, node: ESTree.ObjectExpression) {
context.report({
fix(fixer) {
// Removes the last property of the object:
return removeObjectProperty(context, fixer, node.properties[index]);
},
messageId,
node: node.properties[index],
});
}{
a: 1,
- b: 2,
- c: 3,
+ b: 2
}Trailing commas are removed so that the fixed code will work regardless of whether the language and location allows them.
Development
See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md.
Thanks! π§
Contributors
 Azat S. π€ |
 Josh Goldberg β¨ π» π π π€ π π§ π β οΈ π§ π |
 michael faith π» π π π€ π π§ π β οΈ π§ |
π This package was templated with
create-typescript-appusing the Bingo engine.