@@ -78,13 +78,11 @@ export type GetRuleModuleMessageIds<TRule> =
78
78
export type GetRuleModuleOptions < TRule > =
79
79
TRule extends RuleModule < infer _ , infer Options > ? Options : never
80
80
81
- /* eslint-disable prettier/prettier -- See also https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/241 */
82
81
/**
83
82
* Type helper to build {@link TSESLintRuleTester.run} test parameters from a
84
83
* given {@link RuleModule}
85
84
*
86
85
* @example
87
- * ```ts
88
86
* const COMMON_TESTS: RunTests<typeof rule> = {
89
87
* valid: [
90
88
* {
@@ -96,26 +94,23 @@ export type GetRuleModuleOptions<TRule> =
96
94
* {
97
95
* code: "import Foo from 'Foo';",
98
96
* options: ['prefer-top-level'],
99
- * errors: []
97
+ * errors: [],
100
98
* },
101
- * ]
102
- * ```
99
+ * ],
100
+ * }
103
101
*/
104
- /* eslint-enable prettier/prettier */
105
102
export type RuleRunTests <
106
103
TRule extends RuleModule < string , readonly unknown [ ] > ,
107
104
TRuleType extends GetRuleModuleTypes < TRule > = GetRuleModuleTypes < TRule > ,
108
105
> = TSESLintRunTests < TRuleType [ 'messageIds' ] , TRuleType [ 'options' ] >
109
106
110
- /* eslint-disable prettier/prettier */
111
107
/**
112
108
* Create two functions that can be used to create both valid and invalid test
113
109
* case to be provided to {@link TSESLintRuleTester}. This function accepts one
114
110
* type parameter that should extend a {@link RuleModule} to be able to provide
115
111
* the result with typed `MessageIds` and `Options` properties
116
112
*
117
113
* @example
118
- * ```ts
119
114
* import { createRuleTestCaseFunction } from '../utils'
120
115
*
121
116
* const ruleTester = new TSESLintRuleTester()
@@ -132,16 +127,14 @@ export type RuleRunTests<
132
127
* tInvalid({
133
128
* code: '...',
134
129
* }),
135
- * ]
130
+ * ],
136
131
* })
137
- * ```
138
132
*
139
133
* @param defaultOptions If you have a specific set of options that need to be
140
134
* passed to each test case you can supply them directly to this function.
141
135
*
142
136
* If the `TRule` parameter is omitted default types are used.
143
137
*/
144
- /* eslint-enable prettier/prettier */
145
138
export function createRuleTestCaseFunctions <
146
139
TRule extends RuleModule < string , unknown [ ] > ,
147
140
TData extends GetRuleModuleTypes < TRule > = GetRuleModuleTypes < TRule > ,
0 commit comments