Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore check-examples for ESLint 8+ #928

Closed
brettz9 opened this issue Oct 26, 2022 · 7 comments · Fixed by #1275 · 4 remaining pull requests
Closed

Restore check-examples for ESLint 8+ #928

brettz9 opened this issue Oct 26, 2022 · 7 comments · Fixed by #1275 · 4 remaining pull requests

Comments

@brettz9
Copy link
Collaborator

brettz9 commented Oct 26, 2022

Expected behavior

check-examples should run on ESLint 8+.

Waiting on eslint/eslint#14745

Actual behavior

check-examples won't run on ESLint 8+.

ESLint Config

jsdoc/check-examples: ['error']

ESLint sample

N/A

Environment

  • Node version: 16.14.2
  • ESLint version: 8.26.0
  • eslint-plugin-jsdoc version: 39.3.25
@Jsmithrud37
Copy link

Bump. This is valuable functionality.

@brettz9
Copy link
Collaborator Author

brettz9 commented Dec 18, 2023

As per the OP, we are dependent upon eslint/eslint#14745 .

@JounQin
Copy link

JounQin commented Jan 17, 2024

I don't quite understand what's the root block here, we've already have text + nested virtual filenames, maybe you can show more complex example. I'd like to help to implement this feature here.

@brettz9
Copy link
Collaborator Author

brettz9 commented Jan 17, 2024

@JounQin : Maybe you could help by summarizing the state of affairs, as I don't recall where things are at, except that the ESLint issue is not yet marked as resolved, and my energy at the moment is not great to go through the issue. Is it just that the feature is undocumented but not yet approved by an RFC? If so, a PR would be most welcome.

@JounQin
Copy link

JounQin commented Jan 17, 2024

Is it just that the feature is undocumented but not yet approved by an RFC?

Yes

If so, a PR would be most welcome.

OK

brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Jul 27, 2024
Copy link

🎉 This issue has been resolved in version 48.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@brettz9
Copy link
Collaborator Author

brettz9 commented Jul 29, 2024

@Jsmithrud37 : New docs are available to explain the new alternative for the old jsdoc/check-examples rule. It is now implemented as a processor. @JounQin : If you may find some free time, your review of the implementation would be appreciated (especially on why such errors don't seem to show in VSCode), but I think I've at least gotten the essentials working.

This was referenced Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment