Skip to content

Commit 1fb8bd5

Browse files
committed
Remove noDefaults from match-description, require-jsdoc
1 parent baa166a commit 1fb8bd5

File tree

4 files changed

+9
-27
lines changed

4 files changed

+9
-27
lines changed

.README/rules/match-description.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,18 +73,13 @@ it by setting it to `false`.
7373

7474
Set this to a string or array of strings representing the AST context
7575
where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
76-
77-
##### `noDefaults`
78-
79-
By default, `contexts` will permit `ArrowFunctionExpression`,
80-
`FunctionDeclaration`, and `FunctionExpression`. Set this instead to `true` to
81-
have `contexts` override these.
76+
Overrides the defaults.
8277

8378
|||
8479
|---|---|
8580
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
8681
|Tags|N/A by default but see `tags` options|
8782
|Settings||
88-
|Options|`contexts`, `noDefaults`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return'), `matchDescription`|
83+
|Options|`contexts`, `tags` (allows for 'param', 'arg', 'argument', 'returns', 'return'), `matchDescription`|
8984

9085
<!-- assertions matchDescription -->

.README/rules/require-jsdoc.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ be checked by the rule.
3636

3737
- `contexts` - Set this to a string or array of strings representing the additional
3838
AST context where you wish the rule to be applied (e.g., `Property` for properties).
39-
Note that unlike `require-description` and `match-description`, this rule has no
40-
`noDefaults` option because its defaults are instead set up by `require`.
4139

4240
|||
4341
|---|---|

src/rules/matchDescription.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,6 @@ export default iterateJsdoc(({
9898
format: 'regex',
9999
type: 'string'
100100
},
101-
noDefaults: {
102-
default: false,
103-
type: 'boolean'
104-
},
105101
tags: {
106102
patternProperties: {
107103
'.*': {

test/rules/assertions/matchDescription.js

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -459,8 +459,7 @@ export default {
459459
{
460460
contexts: [
461461
'ClassDeclaration'
462-
],
463-
noDefaults: true
462+
]
464463
}
465464
]
466465
},
@@ -483,8 +482,7 @@ export default {
483482
{
484483
contexts: [
485484
'ClassProperty'
486-
],
487-
noDefaults: true
485+
]
488486
}
489487
],
490488
parser: require.resolve('@typescript-eslint/parser')
@@ -508,8 +506,7 @@ export default {
508506
{
509507
contexts: [
510508
'TSInterfaceDeclaration'
511-
],
512-
noDefaults: true
509+
]
513510
}
514511
],
515512
parser: require.resolve('@typescript-eslint/parser')
@@ -533,8 +530,7 @@ export default {
533530
{
534531
contexts: [
535532
'Property'
536-
],
537-
noDefaults: true
533+
]
538534
}
539535
]
540536
}
@@ -776,8 +772,7 @@ export default {
776772
{
777773
contexts: [
778774
'ClassProperty'
779-
],
780-
noDefaults: true
775+
]
781776
}
782777
],
783778
parser: require.resolve('@typescript-eslint/parser')
@@ -795,8 +790,7 @@ export default {
795790
{
796791
contexts: [
797792
'TSInterfaceDeclaration'
798-
],
799-
noDefaults: true
793+
]
800794
}
801795
],
802796
parser: require.resolve('@typescript-eslint/parser')
@@ -813,8 +807,7 @@ export default {
813807
options: [
814808
{
815809
contexts: [
816-
],
817-
noDefaults: true
810+
]
818811
}
819812
]
820813
},

0 commit comments

Comments
 (0)