diff --git a/docs/rules/check-access.md b/docs/rules/check-access.md index 83cf4731..06f58bd5 100644 --- a/docs/rules/check-access.md +++ b/docs/rules/check-access.md @@ -36,7 +36,7 @@ Also reports: The following patterns are considered problems: -````js +````ts /** * @access foo */ @@ -145,7 +145,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/check-alignment.md b/docs/rules/check-alignment.md index e5345b64..22f21988 100644 --- a/docs/rules/check-alignment.md +++ b/docs/rules/check-alignment.md @@ -32,7 +32,7 @@ Fixes alignment. The following patterns are considered problems: -````js +````ts /** * @param {Number} foo */ @@ -120,7 +120,7 @@ class Foo { The following patterns are not considered problems: -````js +````ts /** * Desc * diff --git a/docs/rules/check-examples.md b/docs/rules/check-examples.md index ce76493b..eb4060dd 100644 --- a/docs/rules/check-examples.md +++ b/docs/rules/check-examples.md @@ -220,7 +220,7 @@ expression-oriented rules will be used by default as well: The following patterns are considered problems: -````js +````ts /** * @example alert('hello') */ @@ -563,7 +563,7 @@ const functionName = function (paramOne, paramTwo, The following patterns are not considered problems: -````js +````ts /** * @example ```js alert('hello'); diff --git a/docs/rules/check-indentation.md b/docs/rules/check-indentation.md index 2396a14d..77eb2208 100644 --- a/docs/rules/check-indentation.md +++ b/docs/rules/check-indentation.md @@ -72,7 +72,7 @@ report a padding issue: The following patterns are considered problems: -````js +````ts /** foo */ function quux () { @@ -188,7 +188,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * foo * diff --git a/docs/rules/check-line-alignment.md b/docs/rules/check-line-alignment.md index 1293f647..283352fd 100644 --- a/docs/rules/check-line-alignment.md +++ b/docs/rules/check-line-alignment.md @@ -97,7 +97,7 @@ Disables `wrapIndent`; existing wrap indentation is preserved without changes. The following patterns are considered problems: -````js +````ts /** * Function description. * @@ -582,7 +582,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * Function description. * diff --git a/docs/rules/check-param-names.md b/docs/rules/check-param-names.md index f6b70030..10db0799 100644 --- a/docs/rules/check-param-names.md +++ b/docs/rules/check-param-names.md @@ -141,7 +141,7 @@ Whether to avoid checks for missing `@param` definitions. Defaults to `false`. C The following patterns are considered problems: -````js +````ts /** * @param Foo */ @@ -691,7 +691,7 @@ export function fn(...[type, arg]: FnArgs): void { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/check-property-names.md b/docs/rules/check-property-names.md index 77f97d7b..5d8c0e94 100644 --- a/docs/rules/check-property-names.md +++ b/docs/rules/check-property-names.md @@ -52,7 +52,7 @@ be removed even if it has a different type or description). The following patterns are considered problems: -````js +````ts /** * @typedef (SomeType) SomeTypedef * @property Foo.Bar @@ -175,7 +175,7 @@ function quux ({foo, bar}, baz) { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/check-syntax.md b/docs/rules/check-syntax.md index 45677653..ca1a187b 100644 --- a/docs/rules/check-syntax.md +++ b/docs/rules/check-syntax.md @@ -36,7 +36,7 @@ rule is enforced (except under "permissive" and "closure" modes). The following patterns are considered problems: -````js +````ts /** * @param {string=} foo */ @@ -54,7 +54,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @param {string=} foo */ diff --git a/docs/rules/check-tag-names.md b/docs/rules/check-tag-names.md index ab45c968..7c0cfccd 100644 --- a/docs/rules/check-tag-names.md +++ b/docs/rules/check-tag-names.md @@ -322,7 +322,7 @@ this The following patterns are considered problems: -````js +````ts /** @type {string} */let a; // "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}] // Message: '@type' is redundant when using a type system. @@ -775,7 +775,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** @default 0 */ let a; // "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}] diff --git a/docs/rules/check-types.md b/docs/rules/check-types.md index 5e3224cf..fa1e6097 100644 --- a/docs/rules/check-types.md +++ b/docs/rules/check-types.md @@ -192,7 +192,7 @@ permitted. The following patterns are considered problems: -````js +````ts /** * @param {abc} foo */ @@ -856,7 +856,7 @@ function a () {} The following patterns are not considered problems: -````js +````ts /** * @param {number} foo * @param {Bar} bar diff --git a/docs/rules/check-values.md b/docs/rules/check-values.md index be6adf92..7a9d9694 100644 --- a/docs/rules/check-values.md +++ b/docs/rules/check-values.md @@ -88,7 +88,7 @@ Whether to enable validation that `@variation` must be a number. Defaults to The following patterns are considered problems: -````js +````ts /** * @version */ @@ -270,7 +270,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @version 3.4.1 */ diff --git a/docs/rules/convert-to-jsdoc-comments.md b/docs/rules/convert-to-jsdoc-comments.md index 40b8ed73..01d87fbe 100644 --- a/docs/rules/convert-to-jsdoc-comments.md +++ b/docs/rules/convert-to-jsdoc-comments.md @@ -100,7 +100,7 @@ Defaults to `VariableDeclarator`, `TSPropertySignature`, `PropertyDefinition`. The following patterns are considered problems: -````js +````ts // A single line comment function quux () {} // "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}] @@ -211,7 +211,7 @@ var a = []; // Test comment The following patterns are not considered problems: -````js +````ts /** A single line comment */ function quux () {} // "jsdoc/convert-to-jsdoc-comments": ["error"|"warn", {"enforceJsdocLineStyle":"single"}] diff --git a/docs/rules/empty-tags.md b/docs/rules/empty-tags.md index 123fdabd..a827c359 100644 --- a/docs/rules/empty-tags.md +++ b/docs/rules/empty-tags.md @@ -75,7 +75,7 @@ add them within this option. The following patterns are considered problems: -````js +````ts /** * @abstract extra text */ @@ -153,7 +153,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * @abstract */ diff --git a/docs/rules/implements-on-classes.md b/docs/rules/implements-on-classes.md index 4c6556ab..45e984d8 100644 --- a/docs/rules/implements-on-classes.md +++ b/docs/rules/implements-on-classes.md @@ -55,7 +55,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @implements {SomeClass} */ @@ -136,7 +136,7 @@ class Foo { The following patterns are not considered problems: -````js +````ts /** * @implements {SomeClass} * @class diff --git a/docs/rules/imports-as-dependencies.md b/docs/rules/imports-as-dependencies.md index f59540a7..c7fbcbc1 100644 --- a/docs/rules/imports-as-dependencies.md +++ b/docs/rules/imports-as-dependencies.md @@ -19,7 +19,7 @@ which is not listed in `dependencies` or `devDependencies`. The following patterns are considered problems: -````js +````ts /** * @type {null|import('sth').SomeApi} */ @@ -50,7 +50,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * @type {null|import('eslint').ESLint} */ diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md index e90cd330..d6268260 100644 --- a/docs/rules/informative-docs.md +++ b/docs/rules/informative-docs.md @@ -102,7 +102,7 @@ The default `uselessWords` option is: The following patterns are considered problems: -````js +````ts /** the */ let myValue = 3; // Message: This description only repeats the name it describes. @@ -300,7 +300,7 @@ export default function packageNameFromPath(path) { The following patterns are not considered problems: -````js +````ts /** */ let myValue = 3; diff --git a/docs/rules/match-description.md b/docs/rules/match-description.md index 3f2f797a..665e9a21 100644 --- a/docs/rules/match-description.md +++ b/docs/rules/match-description.md @@ -216,7 +216,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * foo. */ @@ -633,7 +633,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/match-name.md b/docs/rules/match-name.md index 991a8453..8c223f7e 100644 --- a/docs/rules/match-name.md +++ b/docs/rules/match-name.md @@ -82,7 +82,7 @@ be applied, however. The following patterns are considered problems: -````js +````ts /** * @param opt_a * @param opt_b @@ -194,7 +194,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * @param opt_a * @param opt_b diff --git a/docs/rules/multiline-blocks.md b/docs/rules/multiline-blocks.md index 9bfa0a4d..7913017e 100644 --- a/docs/rules/multiline-blocks.md +++ b/docs/rules/multiline-blocks.md @@ -128,7 +128,7 @@ cannot be reliably added after the tag either). The following patterns are considered problems: -````js +````ts /** Reported up here * because the rest is multiline */ @@ -293,7 +293,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** Not reported */ /** diff --git a/docs/rules/no-bad-blocks.md b/docs/rules/no-bad-blocks.md index be4e8b70..898c8c68 100644 --- a/docs/rules/no-bad-blocks.md +++ b/docs/rules/no-bad-blocks.md @@ -57,7 +57,7 @@ apparent tag content. The following patterns are considered problems: -````js +````ts /* * @param foo */ @@ -117,7 +117,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @property foo */ diff --git a/docs/rules/no-blank-block-descriptions.md b/docs/rules/no-blank-block-descriptions.md index da762028..4ed4b47c 100644 --- a/docs/rules/no-blank-block-descriptions.md +++ b/docs/rules/no-blank-block-descriptions.md @@ -34,7 +34,7 @@ in the block description. The following patterns are considered problems: -````js +````ts /** * * @param {number} x @@ -58,7 +58,7 @@ function functionWithClearName() {} The following patterns are not considered problems: -````js +````ts /** * Non-empty description * @param {number} x diff --git a/docs/rules/no-blank-blocks.md b/docs/rules/no-blank-blocks.md index e133fdbe..c5bc6eb2 100644 --- a/docs/rules/no-blank-blocks.md +++ b/docs/rules/no-blank-blocks.md @@ -39,7 +39,7 @@ Whether or not to auto-remove the blank block. Defaults to `false`. The following patterns are considered problems: -````js +````ts /** */ // "jsdoc/no-blank-blocks": ["error"|"warn", {"enableFixer":true}] // Message: No empty blocks @@ -84,7 +84,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** @tag */ /** diff --git a/docs/rules/no-defaults.md b/docs/rules/no-defaults.md index 5e240d2c..7d0cdcdc 100644 --- a/docs/rules/no-defaults.md +++ b/docs/rules/no-defaults.md @@ -76,7 +76,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @param {number} [foo="7"] */ @@ -160,7 +160,7 @@ const a = {}; The following patterns are not considered problems: -````js +````ts /** * @param foo */ diff --git a/docs/rules/no-missing-syntax.md b/docs/rules/no-missing-syntax.md index 6608f9a8..4a539a13 100644 --- a/docs/rules/no-missing-syntax.md +++ b/docs/rules/no-missing-syntax.md @@ -86,7 +86,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @implements {Bar|Foo} */ @@ -205,7 +205,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * @implements {Bar|Foo} */ diff --git a/docs/rules/no-multi-asterisks.md b/docs/rules/no-multi-asterisks.md index ac48654f..88f2e71b 100644 --- a/docs/rules/no-multi-asterisks.md +++ b/docs/rules/no-multi-asterisks.md @@ -76,7 +76,7 @@ Prevent the likes of this: The following patterns are considered problems: -````js +````ts /** * ** @@ -182,7 +182,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * * Desc. *** diff --git a/docs/rules/no-restricted-syntax.md b/docs/rules/no-restricted-syntax.md index d8f7ec24..4544e634 100644 --- a/docs/rules/no-restricted-syntax.md +++ b/docs/rules/no-restricted-syntax.md @@ -62,7 +62,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * */ @@ -271,7 +271,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/no-types.md b/docs/rules/no-types.md index 8d4777dd..f5fe302d 100644 --- a/docs/rules/no-types.md +++ b/docs/rules/no-types.md @@ -58,7 +58,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @param {number} foo */ @@ -147,7 +147,7 @@ export interface B { The following patterns are not considered problems: -````js +````ts /** * @param foo */ diff --git a/docs/rules/no-undefined-types.md b/docs/rules/no-undefined-types.md index 6c7e5573..608a4f25 100644 --- a/docs/rules/no-undefined-types.md +++ b/docs/rules/no-undefined-types.md @@ -89,7 +89,7 @@ An option object may have the following keys: The following patterns are considered problems: -````js +````ts /** * @param {HerType} baz - Foo. */ @@ -347,7 +347,7 @@ const a = new Todo(); The following patterns are not considered problems: -````js +````ts /** * @param {string} foo - Bar. */ diff --git a/docs/rules/require-asterisk-prefix.md b/docs/rules/require-asterisk-prefix.md index 597bde3a..baf6d9ea 100644 --- a/docs/rules/require-asterisk-prefix.md +++ b/docs/rules/require-asterisk-prefix.md @@ -61,7 +61,7 @@ which applies to the main jsdoc block description. The following patterns are considered problems: -````js +````ts /** @param {Number} foo @@ -186,7 +186,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * Desc * diff --git a/docs/rules/require-description-complete-sentence.md b/docs/rules/require-description-complete-sentence.md index 3b8461ed..1476e009 100644 --- a/docs/rules/require-description-complete-sentence.md +++ b/docs/rules/require-description-complete-sentence.md @@ -98,7 +98,7 @@ nouns, for example). The following patterns are considered problems: -````js +````ts /** * foo. */ @@ -438,7 +438,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * @param foo - Foo. */ diff --git a/docs/rules/require-description.md b/docs/rules/require-description.md index aec75da2..0cc80713 100644 --- a/docs/rules/require-description.md +++ b/docs/rules/require-description.md @@ -62,7 +62,7 @@ An options object may have any of the following properties: The following patterns are considered problems: -````js +````ts /** * */ @@ -360,7 +360,7 @@ this.treeViewSelection = []; The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-example.md b/docs/rules/require-example.md index 62c32028..b6ff4497 100644 --- a/docs/rules/require-example.md +++ b/docs/rules/require-example.md @@ -107,7 +107,7 @@ Defaults to `true`. The following patterns are considered problems: -````js +````ts /** * */ @@ -244,7 +244,7 @@ function quux (someParam) { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-file-overview.md b/docs/rules/require-file-overview.md index 731ae22a..ce4f028d 100644 --- a/docs/rules/require-file-overview.md +++ b/docs/rules/require-file-overview.md @@ -98,7 +98,7 @@ will be checked, but you must use `file` on the configuration object). The following patterns are considered problems: -````js +````ts // Message: Missing @file @@ -246,7 +246,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * @file */ diff --git a/docs/rules/require-hyphen-before-param-description.md b/docs/rules/require-hyphen-before-param-description.md index 033ab061..7382eb2b 100644 --- a/docs/rules/require-hyphen-before-param-description.md +++ b/docs/rules/require-hyphen-before-param-description.md @@ -56,7 +56,7 @@ other tags besides the `@param` tag (or the `@arg` tag if so set): The following patterns are considered problems: -````js +````ts /** * @param foo Foo. */ @@ -203,7 +203,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * @param foo - Foo. */ diff --git a/docs/rules/require-jsdoc.md b/docs/rules/require-jsdoc.md index fcdced17..744803d4 100644 --- a/docs/rules/require-jsdoc.md +++ b/docs/rules/require-jsdoc.md @@ -174,7 +174,7 @@ empty string. The following patterns are considered problems: -````js +````ts /** This is comment */ export interface Foo { /** This is comment x2 */ @@ -1030,7 +1030,7 @@ export type LoginOptions = CmdOptions<{ The following patterns are not considered problems: -````js +````ts interface FooBar { fooBar: string; } diff --git a/docs/rules/require-param-description.md b/docs/rules/require-param-description.md index ec29ce3e..05aa99de 100644 --- a/docs/rules/require-param-description.md +++ b/docs/rules/require-param-description.md @@ -73,7 +73,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @param foo */ @@ -174,7 +174,7 @@ function quux (foo, {bar}, baz) { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-param-name.md b/docs/rules/require-param-name.md index 86878b91..5a3636e0 100644 --- a/docs/rules/require-param-name.md +++ b/docs/rules/require-param-name.md @@ -52,7 +52,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @param */ @@ -110,7 +110,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @param foo */ diff --git a/docs/rules/require-param-type.md b/docs/rules/require-param-type.md index 2630efb5..bea20608 100644 --- a/docs/rules/require-param-type.md +++ b/docs/rules/require-param-type.md @@ -72,7 +72,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @param foo */ @@ -171,7 +171,7 @@ function quux (foo, {bar}, baz) { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-param.md b/docs/rules/require-param.md index b6e6dcb1..eb5eb271 100644 --- a/docs/rules/require-param.md +++ b/docs/rules/require-param.md @@ -456,7 +456,7 @@ supplied as default values. Defaults to `false`. The following patterns are considered problems: -````js +````ts /** * */ @@ -1172,7 +1172,7 @@ class A { The following patterns are not considered problems: -````js +````ts /** * @param foo */ diff --git a/docs/rules/require-property-description.md b/docs/rules/require-property-description.md index b47a6610..9da7aa9d 100644 --- a/docs/rules/require-property-description.md +++ b/docs/rules/require-property-description.md @@ -26,7 +26,7 @@ Requires that each `@property` tag has a `description` value. The following patterns are considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef * @property foo @@ -56,7 +56,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef */ diff --git a/docs/rules/require-property-name.md b/docs/rules/require-property-name.md index d38230db..a02329bd 100644 --- a/docs/rules/require-property-name.md +++ b/docs/rules/require-property-name.md @@ -26,7 +26,7 @@ Requires that all `@property` tags have names. The following patterns are considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef * @property @@ -55,7 +55,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef * @property foo diff --git a/docs/rules/require-property-type.md b/docs/rules/require-property-type.md index 0206adcf..8b3d002e 100644 --- a/docs/rules/require-property-type.md +++ b/docs/rules/require-property-type.md @@ -26,7 +26,7 @@ Requires that each `@property` tag has a type value (within curly brackets). The following patterns are considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef * @property foo @@ -56,7 +56,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * @typedef {SomeType} SomeTypedef */ diff --git a/docs/rules/require-property.md b/docs/rules/require-property.md index 225d553f..6d463fbc 100644 --- a/docs/rules/require-property.md +++ b/docs/rules/require-property.md @@ -36,7 +36,7 @@ The fixer for `require-property` will add an empty `@property`. The following patterns are considered problems: -````js +````ts /** * @typedef {object} SomeTypedef */ @@ -70,7 +70,7 @@ class Test { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-returns-check.md b/docs/rules/require-returns-check.md index 8b3f3d63..2ff2b6c1 100644 --- a/docs/rules/require-returns-check.md +++ b/docs/rules/require-returns-check.md @@ -63,7 +63,7 @@ Will also report if multiple `@returns` tags are present. The following patterns are considered problems: -````js +````ts /** * @returns */ @@ -391,7 +391,7 @@ function foo() { The following patterns are not considered problems: -````js +````ts /** * @returns Foo. */ diff --git a/docs/rules/require-returns-description.md b/docs/rules/require-returns-description.md index 97628b2c..b42c5247 100644 --- a/docs/rules/require-returns-description.md +++ b/docs/rules/require-returns-description.md @@ -50,7 +50,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @returns */ @@ -117,7 +117,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * */ diff --git a/docs/rules/require-returns-type.md b/docs/rules/require-returns-type.md index 66077f8f..8c081343 100644 --- a/docs/rules/require-returns-type.md +++ b/docs/rules/require-returns-type.md @@ -48,7 +48,7 @@ section of our README for more on the expected format. The following patterns are considered problems: -````js +````ts /** * @returns */ @@ -115,7 +115,7 @@ function quux () { The following patterns are not considered problems: -````js +````ts /** * @returns {number} */ diff --git a/docs/rules/require-returns.md b/docs/rules/require-returns.md index 6e65be6e..5d959529 100644 --- a/docs/rules/require-returns.md +++ b/docs/rules/require-returns.md @@ -73,7 +73,7 @@ Will also report if multiple `@returns` tags are present. The following patterns are considered problems: -````js +````ts /** * */ @@ -723,7 +723,7 @@ window.quux = function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @returns Foo. */ diff --git a/docs/rules/require-template.md b/docs/rules/require-template.md index df907df9..e968bc2c 100644 --- a/docs/rules/require-template.md +++ b/docs/rules/require-template.md @@ -58,7 +58,7 @@ Defaults to `false`. The following patterns are considered problems: -````js +````ts /** * */ @@ -221,7 +221,7 @@ export default class { The following patterns are not considered problems: -````js +````ts /** * @template D * @template V diff --git a/docs/rules/require-throws.md b/docs/rules/require-throws.md index 20d3d9f9..d81ceba5 100644 --- a/docs/rules/require-throws.md +++ b/docs/rules/require-throws.md @@ -58,7 +58,7 @@ on why TypeScript doesn't offer such a feature. The following patterns are considered problems: -````js +````ts /** * */ @@ -249,7 +249,7 @@ function quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @throws An error. */ diff --git a/docs/rules/require-yields-check.md b/docs/rules/require-yields-check.md index 243639c3..40ec2655 100644 --- a/docs/rules/require-yields-check.md +++ b/docs/rules/require-yields-check.md @@ -62,7 +62,7 @@ Will also report if multiple `@yields` tags are present. The following patterns are considered problems: -````js +````ts /** * @yields */ @@ -221,7 +221,7 @@ function * quux (foo) { The following patterns are not considered problems: -````js +````ts /** * @yields Foo. */ diff --git a/docs/rules/require-yields.md b/docs/rules/require-yields.md index b6814b43..e98c2a30 100644 --- a/docs/rules/require-yields.md +++ b/docs/rules/require-yields.md @@ -84,7 +84,7 @@ option to expect a non-standard `@next` tag. The following patterns are considered problems: -````js +````ts /** * */ @@ -486,7 +486,7 @@ function * quux () { The following patterns are not considered problems: -````js +````ts /** * @yields Foo. */ diff --git a/docs/rules/sort-tags.md b/docs/rules/sort-tags.md index d3df1deb..d3d57486 100644 --- a/docs/rules/sort-tags.md +++ b/docs/rules/sort-tags.md @@ -281,7 +281,7 @@ such tags. Do not use with `true` if you are using `tag-lines` and `always`. The following patterns are considered problems: -````js +````ts /** * @returns {string} * @param b @@ -529,7 +529,7 @@ function quux () {} The following patterns are not considered problems: -````js +````ts /** * @param b * @param a diff --git a/docs/rules/tag-lines.md b/docs/rules/tag-lines.md index b9c8fbd4..e201eeb7 100644 --- a/docs/rules/tag-lines.md +++ b/docs/rules/tag-lines.md @@ -102,7 +102,7 @@ following keys: The following patterns are considered problems: -````js +````ts /** * Some description * @param {string} a @@ -315,7 +315,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * Some description * @param {string} a diff --git a/docs/rules/text-escaping.md b/docs/rules/text-escaping.md index a879f6ce..99d79ab9 100644 --- a/docs/rules/text-escaping.md +++ b/docs/rules/text-escaping.md @@ -60,7 +60,7 @@ This option escapes the first backtick (`` ` ``) in a paired sequence. The following patterns are considered problems: -````js +````ts /** * Some things to escape: and > and `test` */ @@ -127,7 +127,7 @@ The following patterns are considered problems: The following patterns are not considered problems: -````js +````ts /** * Some things to escape: <a> and > and `test` */ diff --git a/docs/rules/valid-types.md b/docs/rules/valid-types.md index 2f89e0d9..82c1b36a 100644 --- a/docs/rules/valid-types.md +++ b/docs/rules/valid-types.md @@ -120,7 +120,7 @@ value). See the setting for more details. The following patterns are considered problems: -````js +````ts /** * @param {Array} foo */ diff --git a/src/bin/generateDocs.js b/src/bin/generateDocs.js index e66ea576..641b7e78 100644 --- a/src/bin/generateDocs.js +++ b/src/bin/generateDocs.js @@ -180,9 +180,9 @@ const generateDocs = async () => { } return passingFailing === 'failing' ? - 'The following patterns are considered problems:\n\n````js\n' + + 'The following patterns are considered problems:\n\n````ts\n' + ruleAssertions.invalid.join('\n\n') + '\n````\n\n' : - 'The following patterns are not considered problems:\n\n````js\n' + + 'The following patterns are not considered problems:\n\n````ts\n' + ruleAssertions.valid.join('\n\n') + '\n````\n'; }, // Allow relative paths in source for #902 but generate compiled file in