@@ -19,7 +19,6 @@ JSDoc linting rules for ESLint.
19
19
* [ Rules] ( #eslint-plugin-jsdoc-rules )
20
20
* [ ` check-alignment ` ] ( #eslint-plugin-jsdoc-rules-check-alignment )
21
21
* [ ` check-examples ` ] ( #eslint-plugin-jsdoc-rules-check-examples )
22
- * [ Options] ( #eslint-plugin-jsdoc-rules-options )
23
22
* [ ` check-indentation ` ] ( #eslint-plugin-jsdoc-rules-check-indentation )
24
23
* [ ` check-param-names ` ] ( #eslint-plugin-jsdoc-rules-check-param-names )
25
24
* [ ` check-syntax ` ] ( #eslint-plugin-jsdoc-rules-check-syntax )
@@ -427,22 +426,22 @@ function quux (foo) {}
427
426
428
427
Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
429
428
430
- <a name =" eslint-plugin-jsdoc-rules-options " ></a >
431
- ### Options
429
+ <a name =" eslint-plugin-jsdoc-rules-check-examples- options " ></a >
430
+ #### Options
432
431
433
432
The options below all default to no-op/` false ` except as noted.
434
433
435
- <a name =" eslint-plugin-jsdoc-rules-options-captionrequired " ></a >
436
- #### <code >captionRequired</code >
434
+ <a name =" eslint-plugin-jsdoc-rules-check-examples- options-captionrequired " ></a >
435
+ ##### <code >captionRequired</code >
437
436
438
437
JSDoc specs use of an optional ` <caption> ` element at the beginning of
439
438
` @example ` .
440
439
441
440
The option ` captionRequired ` insists on a ` <caption> ` being present at
442
441
the beginning of any ` @example ` .
443
442
444
- <a name =" eslint-plugin-jsdoc-rules-options-examplecoderegex-and-rejectexamplecoderegex " ></a >
445
- #### <code >exampleCodeRegex</code > and <code >rejectExampleCodeRegex</code >
443
+ <a name =" eslint-plugin-jsdoc-rules-check-examples- options-examplecoderegex-and-rejectexamplecoderegex " ></a >
444
+ ##### <code >exampleCodeRegex</code > and <code >rejectExampleCodeRegex</code >
446
445
447
446
JSDoc does not specify a formal means for delimiting code blocks within
448
447
` @example ` (it uses generic syntax highlighting techniques for its own
@@ -465,8 +464,8 @@ If neither is in use, all examples will be matched. Note also that even if
465
464
` captionRequired ` is not set, any initial ` <caption> ` will be stripped out
466
465
before doing the regex matching.
467
466
468
- <a name =" eslint-plugin-jsdoc-rules-options-paddedindent " ></a >
469
- #### <code >paddedIndent</code >
467
+ <a name =" eslint-plugin-jsdoc-rules-check-examples- options-paddedindent " ></a >
468
+ ##### <code >paddedIndent</code >
470
469
471
470
This integer property allows one to add a fixed amount of whitespace at the
472
471
beginning of the second or later lines of the example to be stripped so as
@@ -484,8 +483,8 @@ out before evaluation.
484
483
*/
485
484
```
486
485
487
- <a name =" eslint-plugin-jsdoc-rules-options-reportunuseddisabledirectives " ></a >
488
- #### <code >reportUnusedDisableDirectives</code >
486
+ <a name =" eslint-plugin-jsdoc-rules-check-examples- options-reportunuseddisabledirectives " ></a >
487
+ ##### <code >reportUnusedDisableDirectives</code >
489
488
490
489
If not set to ` false ` , ` reportUnusedDisableDirectives ` will report disabled
491
490
directives which are not used (and thus not needed). Defaults to ` true ` .
@@ -496,7 +495,7 @@ disabling of ESLint directives which are not needed by the resolved rules
496
495
will be reported as with the ESLint ` --report-unused-disable-directives `
497
496
command.
498
497
499
- <a name =" eslint-plugin-jsdoc-rules-options -options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig " ></a >
498
+ <a name =" eslint-plugin-jsdoc-rules-check-examples -options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig " ></a >
500
499
#### Options for Determining ESLint Rule Applicability (<code >allowInlineConfig</code >, <code >noDefaultExampleRules</code >, <code >matchingFileName</code >, <code >configFile</code >, <code >eslintrcForExamples</code >, and <code >baseConfig</code >)
501
500
502
501
The following options determine which individual ESLint rules will be
@@ -527,7 +526,7 @@ decreasing precedence:
527
526
* ` baseConfig ` - An object of rules with the same schema
528
527
as ` .eslintrc.* ` for defaults
529
528
530
- <a name =" eslint-plugin-jsdoc-rules-options -options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig-rules-disabled-by-default-unless-nodefaultexamplerules-is-set-to-true " ></a >
529
+ <a name =" eslint-plugin-jsdoc-rules-check-examples -options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig-rules-disabled-by-default-unless-nodefaultexamplerules-is-set-to-true " ></a >
531
530
##### Rules Disabled by Default Unless <code >noDefaultExampleRules</code > is Set to <code >true</code >
532
531
533
532
* ` eol-last ` - Insisting that a newline "always" be at the end is less likely
0 commit comments