|
| 1 | +import type { JSONSchema4 } from "@typescript-eslint/utils/json-schema"; |
| 2 | +import type { RuleContext } from "@typescript-eslint/utils/ts-eslint"; |
| 3 | +import { deepmerge } from "deepmerge-ts"; |
| 4 | + |
| 5 | +import { |
| 6 | + type IgnoreCodePatternOption, |
| 7 | + type IgnoreIdentifierPatternOption, |
| 8 | + ignoreCodePatternOptionSchema, |
| 9 | + ignoreIdentifierPatternOptionSchema, |
| 10 | + shouldIgnorePattern, |
| 11 | +} from "#/options"; |
| 12 | +import { ruleNameScope } from "#/utils/misc"; |
| 13 | +import type { ESClass } from "#/utils/node-types"; |
| 14 | +import { |
| 15 | + type NamedCreateRuleCustomMeta, |
| 16 | + type Rule, |
| 17 | + type RuleResult, |
| 18 | + createRule, |
| 19 | +} from "#/utils/rule"; |
| 20 | + |
| 21 | +/** |
| 22 | + * The name of this rule. |
| 23 | + */ |
| 24 | +export const name = "no-class-inheritance"; |
| 25 | + |
| 26 | +/** |
| 27 | + * The full name of this rule. |
| 28 | + */ |
| 29 | +export const fullName: `${typeof ruleNameScope}/${typeof name}` = `${ruleNameScope}/${name}`; |
| 30 | + |
| 31 | +/** |
| 32 | + * The options this rule can take. |
| 33 | + */ |
| 34 | +type Options = [IgnoreIdentifierPatternOption & IgnoreCodePatternOption]; |
| 35 | + |
| 36 | +/** |
| 37 | + * The schema for the rule options. |
| 38 | + */ |
| 39 | +const schema: JSONSchema4[] = [ |
| 40 | + { |
| 41 | + type: "object", |
| 42 | + properties: deepmerge( |
| 43 | + ignoreIdentifierPatternOptionSchema, |
| 44 | + ignoreCodePatternOptionSchema, |
| 45 | + ), |
| 46 | + additionalProperties: false, |
| 47 | + }, |
| 48 | +]; |
| 49 | + |
| 50 | +/** |
| 51 | + * The default options for the rule. |
| 52 | + */ |
| 53 | +const defaultOptions: Options = [{}]; |
| 54 | + |
| 55 | +/** |
| 56 | + * The possible error messages. |
| 57 | + */ |
| 58 | +const errorMessages = { |
| 59 | + abstract: "Unexpected abstract class.", |
| 60 | + extends: "Unexpected inheritance, use composition instead.", |
| 61 | +} as const; |
| 62 | + |
| 63 | +/** |
| 64 | + * The meta data for this rule. |
| 65 | + */ |
| 66 | +const meta: NamedCreateRuleCustomMeta<keyof typeof errorMessages> = { |
| 67 | + type: "suggestion", |
| 68 | + docs: { |
| 69 | + category: "No Other Paradigms", |
| 70 | + description: "Disallow inheritance in classes.", |
| 71 | + recommended: "recommended", |
| 72 | + recommendedSeverity: "error", |
| 73 | + requiresTypeChecking: false, |
| 74 | + }, |
| 75 | + messages: errorMessages, |
| 76 | + schema, |
| 77 | +}; |
| 78 | + |
| 79 | +/** |
| 80 | + * Check if the given class node violates this rule. |
| 81 | + */ |
| 82 | +function checkClass( |
| 83 | + node: ESClass, |
| 84 | + context: Readonly<RuleContext<keyof typeof errorMessages, Options>>, |
| 85 | + options: Readonly<Options>, |
| 86 | +): RuleResult<keyof typeof errorMessages, Options> { |
| 87 | + const [optionsObject] = options; |
| 88 | + const { ignoreIdentifierPattern, ignoreCodePattern } = optionsObject; |
| 89 | + |
| 90 | + const m_descriptors: Array< |
| 91 | + RuleResult<keyof typeof errorMessages, Options>["descriptors"][number] |
| 92 | + > = []; |
| 93 | + |
| 94 | + if ( |
| 95 | + !shouldIgnorePattern( |
| 96 | + node, |
| 97 | + context, |
| 98 | + ignoreIdentifierPattern, |
| 99 | + undefined, |
| 100 | + ignoreCodePattern, |
| 101 | + ) |
| 102 | + ) { |
| 103 | + if (node.abstract) { |
| 104 | + const nodeText = context.sourceCode.getText(node); |
| 105 | + const abstractRelativeIndex = nodeText.indexOf("abstract"); |
| 106 | + const abstractIndex = |
| 107 | + context.sourceCode.getIndexFromLoc(node.loc.start) + |
| 108 | + abstractRelativeIndex; |
| 109 | + const start = context.sourceCode.getLocFromIndex(abstractIndex); |
| 110 | + const end = context.sourceCode.getLocFromIndex( |
| 111 | + abstractIndex + "abstract".length, |
| 112 | + ); |
| 113 | + |
| 114 | + m_descriptors.push({ |
| 115 | + node, |
| 116 | + loc: { |
| 117 | + start, |
| 118 | + end, |
| 119 | + }, |
| 120 | + messageId: "abstract", |
| 121 | + }); |
| 122 | + } |
| 123 | + |
| 124 | + if (node.superClass !== null) { |
| 125 | + const nodeText = context.sourceCode.getText(node); |
| 126 | + const extendsRelativeIndex = nodeText.indexOf("extends"); |
| 127 | + const extendsIndex = |
| 128 | + context.sourceCode.getIndexFromLoc(node.loc.start) + |
| 129 | + extendsRelativeIndex; |
| 130 | + const start = context.sourceCode.getLocFromIndex(extendsIndex); |
| 131 | + const { end } = node.superClass.loc; |
| 132 | + |
| 133 | + m_descriptors.push({ |
| 134 | + node, |
| 135 | + loc: { |
| 136 | + start, |
| 137 | + end, |
| 138 | + }, |
| 139 | + messageId: "extends", |
| 140 | + }); |
| 141 | + } |
| 142 | + } |
| 143 | + |
| 144 | + return { |
| 145 | + context, |
| 146 | + descriptors: m_descriptors, |
| 147 | + }; |
| 148 | +} |
| 149 | + |
| 150 | +// Create the rule. |
| 151 | +export const rule: Rule<keyof typeof errorMessages, Options> = createRule< |
| 152 | + keyof typeof errorMessages, |
| 153 | + Options |
| 154 | +>(name, meta, defaultOptions, { |
| 155 | + ClassDeclaration: checkClass, |
| 156 | + ClassExpression: checkClass, |
| 157 | +}); |
0 commit comments