Skip to content

Commit 95dd356

Browse files
authored
chore: use correct code @example (#302)
1 parent f37e138 commit 95dd356

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

test/utils.ts

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,11 @@ export type GetRuleModuleMessageIds<TRule> =
7878
export type GetRuleModuleOptions<TRule> =
7979
TRule extends RuleModule<infer _, infer Options> ? Options : never
8080

81-
/* eslint-disable prettier/prettier -- See also https://github.com/hosseinmd/prettier-plugin-jsdoc/issues/241 */
8281
/**
8382
* Type helper to build {@link TSESLintRuleTester.run} test parameters from a
8483
* given {@link RuleModule}
8584
*
8685
* @example
87-
* ```ts
8886
* const COMMON_TESTS: RunTests<typeof rule> = {
8987
* valid: [
9088
* {
@@ -96,26 +94,23 @@ export type GetRuleModuleOptions<TRule> =
9694
* {
9795
* code: "import Foo from 'Foo';",
9896
* options: ['prefer-top-level'],
99-
* errors: []
97+
* errors: [],
10098
* },
101-
* ]
102-
* ```
99+
* ],
100+
* }
103101
*/
104-
/* eslint-enable prettier/prettier */
105102
export type RuleRunTests<
106103
TRule extends RuleModule<string, readonly unknown[]>,
107104
TRuleType extends GetRuleModuleTypes<TRule> = GetRuleModuleTypes<TRule>,
108105
> = TSESLintRunTests<TRuleType['messageIds'], TRuleType['options']>
109106

110-
/* eslint-disable prettier/prettier */
111107
/**
112108
* Create two functions that can be used to create both valid and invalid test
113109
* case to be provided to {@link TSESLintRuleTester}. This function accepts one
114110
* type parameter that should extend a {@link RuleModule} to be able to provide
115111
* the result with typed `MessageIds` and `Options` properties
116112
*
117113
* @example
118-
* ```ts
119114
* import { createRuleTestCaseFunction } from '../utils'
120115
*
121116
* const ruleTester = new TSESLintRuleTester()
@@ -132,16 +127,14 @@ export type RuleRunTests<
132127
* tInvalid({
133128
* code: '...',
134129
* }),
135-
* ]
130+
* ],
136131
* })
137-
* ```
138132
*
139133
* @param defaultOptions If you have a specific set of options that need to be
140134
* passed to each test case you can supply them directly to this function.
141135
*
142136
* If the `TRule` parameter is omitted default types are used.
143137
*/
144-
/* eslint-enable prettier/prettier */
145138
export function createRuleTestCaseFunctions<
146139
TRule extends RuleModule<string, unknown[]>,
147140
TData extends GetRuleModuleTypes<TRule> = GetRuleModuleTypes<TRule>,

0 commit comments

Comments
 (0)