Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,43 +1,15 @@
import { createRule } from '../../../utils/create-rule';
import { HtmlNode } from '../../../parsers/html/html-node';
import { createClassUpdateRule } from '../../../utils/create-class-update-rule';

export const name = 'no-deprecated-btn-rg';

// Type: RuleModule<"uppercase", ...>
export default createRule({
export default createClassUpdateRule({
name,
meta: {
docs: {
dir: 'html',
description:
'Flags deprecated "btn-rg" class and suggests removal or replacement with "btn-sm".',
},
messages: {
deprecatedBtnRg:
'The "btn-rg" class is deprecated. Please remove it or replace it with "btn-sm".',
},
type: 'suggestion',
fixable: 'code',
schema: [],
type:'suggestion',
description: 'Flags deprecated "btn-rg" class and suggests removal or replacement with "btn-sm".',
messages: {
deprecatedBtnRg: 'The "btn-rg" class is deprecated. Please remove it or replace it with "btn-sm".',
},
defaultOptions: [],
create(context) {
return {
tag(node: HtmlNode) {
if (node.name && ['button', 'input', 'a'].includes(node.name)) {
const $node = node.toCheerio();
if ($node.hasClass('btn-rg')) {
context.report({
messageId: 'deprecatedBtnRg',
loc: node.loc,
fix(fixer) {
const fixedNode = $node.removeClass('btn-rg').addClass('btn-sm');
return fixer.replaceTextRange(node.range, fixedNode.toString());
},
});
}
}
},
};
mutations: {
deprecatedBtnRg: ['btn-rg', 'btn-sm']
},
});
50 changes: 50 additions & 0 deletions packages/eslint/src/utils/create-class-update-rule.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import { createRule } from './create-rule';
import { HtmlNode } from '../parsers/html/html-node';
import { Rule } from 'eslint';

interface RuleConfig<T>{
name: string;
description: string;
messages: T;
mutations: Record<keyof T, [string] | [string, string]>;
type?: Rule.RuleMetaData['type'];
}

export const createClassUpdateRule = <T extends Record<string, string>>(
config: RuleConfig<T>
) => createRule({
name: config.name,
meta: {
docs: {
dir: 'html',
description: config.description,
},
messages: config.messages,
type: config.type || 'problem',
fixable: 'code',
schema: [],
},
defaultOptions: [],
create(context) {
return {
tag(node: HtmlNode) {
const $node = node.toCheerio();

Object.entries(config.mutations).forEach(([messageId, [oldClass, newClass]]) => {
if ($node.hasClass(oldClass)) {
context.report({
messageId,
loc: node.loc,
... newClass ? {
fix(fixer) {
const fixedNode = $node.removeClass(oldClass).addClass(newClass);
return fixer.replaceTextRange(node.range, fixedNode.toString());
}
} : {},
});
}
});
},
};
},
});