Skip to content

Commit

Permalink
docs: mention in rule message current alternative to check-examples
Browse files Browse the repository at this point in the history
… rule
  • Loading branch information
brettz9 committed Jul 29, 2024
1 parent f0f5e18 commit df43df9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
5 changes: 2 additions & 3 deletions src/rules/checkExamples.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,8 @@ export default iterateJsdoc(({
}) => {
if (semver.gte(ESLint.version, '8.0.0')) {
report(
'This rule cannot yet be supported for ESLint 8; you ' +
'should either downgrade to ESLint 7 or disable this rule. The ' +
'possibility for ESLint 8 support is being tracked at https://github.com/eslint/eslint/issues/14745',
'This rule does not work for ESLint 8+; you should disable this rule and use' +
'the processor mentioned in the docs.',
null,
{
column: 1,
Expand Down
3 changes: 1 addition & 2 deletions test/rules/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ const main = async () => {

for (const ruleName of process.env.npm_config_rule ? process.env.npm_config_rule.split(',') : ruleNames) {
if (semver.gte(ESLint.version, '8.0.0') && ruleName === 'check-examples') {
// TODO: This rule cannot yet be supported for ESLint 8;
// The possibility for ESLint 8 support is being tracked at https://github.com/eslint/eslint/issues/14745
// Uses the processor instead for higher versions
continue;
}

Expand Down

0 comments on commit df43df9

Please sign in to comment.