|
| 1 | +import type { RuleConfig } from '../rule-config'; |
| 2 | + |
| 3 | +/** |
| 4 | + * Accessibility Level. |
| 5 | + */ |
| 6 | +export type AccessibilityLevel = |
| 7 | + | 'explicit' // require an accessor (including public) |
| 8 | + | 'no-public' // don't require public |
| 9 | + | 'off'; // don't check |
| 10 | + |
| 11 | +/** |
| 12 | + * Option. |
| 13 | + */ |
| 14 | +export type ExplicitMemberAccessibilityOption = { |
| 15 | + /** |
| 16 | + * This rule in its default state requires no configuration and will enforce that every class member has an accessibility modifier. |
| 17 | + * |
| 18 | + * @default 'explicit' |
| 19 | + * |
| 20 | + * @see [accessibility](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md#accessibility) |
| 21 | + */ |
| 22 | + accessibility?: AccessibilityLevel; |
| 23 | + /** |
| 24 | + * @see [ignoredMethodNames](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md#except-specific-methods) |
| 25 | + */ |
| 26 | + ignoredMethodNames?: string[]; |
| 27 | + /** |
| 28 | + * @see [overrides](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md#overrides) |
| 29 | + */ |
| 30 | + overrides?: { |
| 31 | + accessors?: AccessibilityLevel; |
| 32 | + constructors?: AccessibilityLevel; |
| 33 | + methods?: AccessibilityLevel; |
| 34 | + properties?: AccessibilityLevel; |
| 35 | + parameterProperties?: AccessibilityLevel; |
| 36 | + }; |
| 37 | +}; |
| 38 | + |
| 39 | +/** |
| 40 | + * Options. |
| 41 | + */ |
| 42 | +export type ExplicitMemberAccessibilityOptions = [ExplicitMemberAccessibilityOption?]; |
| 43 | + |
| 44 | +/** |
| 45 | + * Require explicit accessibility modifiers on class properties and methods. |
| 46 | + * |
| 47 | + * @see [explicit-member-accessibility](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md) |
| 48 | + */ |
| 49 | +export type ExplicitMemberAccessibilityRuleConfig = RuleConfig<ExplicitMemberAccessibilityOptions>; |
| 50 | + |
| 51 | +/** |
| 52 | + * Require explicit accessibility modifiers on class properties and methods. |
| 53 | + * |
| 54 | + * @see [explicit-member-accessibility](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md) |
| 55 | + */ |
| 56 | +export interface ExplicitMemberAccessibilityRule { |
| 57 | + /** |
| 58 | + * Require explicit accessibility modifiers on class properties and methods. |
| 59 | + * |
| 60 | + * @see [explicit-member-accessibility](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/explicit-member-accessibility.md) |
| 61 | + */ |
| 62 | + '@typescript-eslint/explicit-member-accessibility': ExplicitMemberAccessibilityRuleConfig; |
| 63 | +} |
0 commit comments