@angular-eslint/eslint-plugin
Version:
ESLint plugin for Angular applications, following https://angular.dev/style-guide
73 lines (72 loc) • 3.25 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
const utils_1 = require("@angular-eslint/utils");
const create_eslint_rule_1 = require("../utils/create-eslint-rule");
exports.RULE_NAME = 'no-empty-lifecycle-method';
exports.default = (0, create_eslint_rule_1.createESLintRule)({
name: exports.RULE_NAME,
meta: {
type: 'suggestion',
docs: {
description: 'Disallows declaring empty lifecycle methods',
recommended: 'recommended',
},
hasSuggestions: true,
schema: [],
messages: {
noEmptyLifecycleMethod: 'Lifecycle methods should not be empty',
suggestRemoveLifecycleMethod: 'Remove lifecycle method',
},
},
defaultOptions: [],
create(context) {
const sourceCode = context.sourceCode;
const angularDecoratorsPattern = (0, utils_1.toPattern)([
'Component',
'Directive',
'Injectable',
'NgModule',
'Pipe',
]);
const angularLifecycleMethodsPattern = (0, utils_1.toPattern)([
...utils_1.ASTUtils.ANGULAR_LIFECYCLE_METHODS,
]);
return {
[`${utils_1.Selectors.decoratorDefinition(angularDecoratorsPattern)} > ClassBody > ${utils_1.Selectors.methodDefinition(angularLifecycleMethodsPattern)}[value.body.body.length=0]`](node) {
context.report({
node,
messageId: 'noEmptyLifecycleMethod',
suggest: [
{
messageId: 'suggestRemoveLifecycleMethod',
fix: (fixer) => {
const importDeclarations = utils_1.ASTUtils.getImportDeclarations(node, '@angular/core') ?? [];
const interfaceName = utils_1.ASTUtils.getRawText(node).replace(/^ng+/, '');
const text = sourceCode.getText();
const totalInterfaceOccurrences = getTotalInterfaceOccurrences(text, interfaceName);
const totalInterfaceOccurrencesSafeForRemoval = 2;
return [
fixer.remove(node),
utils_1.RuleFixes.getImplementsRemoveFix(sourceCode, node.parent.parent, interfaceName, fixer),
totalInterfaceOccurrences <=
totalInterfaceOccurrencesSafeForRemoval
? utils_1.RuleFixes.getImportRemoveFix(sourceCode, importDeclarations, interfaceName, fixer)
: null,
].filter(utils_1.isNotNullOrUndefined);
},
},
],
});
},
};
},
});
function stripSpecialCharacters(text) {
return text.replace(/[\W]/g, '');
}
function getTotalInterfaceOccurrences(text, interfaceName) {
return text
.split(' ')
.filter((item) => stripSpecialCharacters(item) === interfaceName).length;
}