chore: add optional RULE_DOCS_EXTENSION export for extended rule rationale #1229
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
☁️ Nx Cloud ReportCI is running/has finished running commands for commit ada6cd4. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 7 targets
Sent with 💌 from NxCloud. |
Codecov Report
@@ Coverage Diff @@
## main #1229 +/- ##
=======================================
Coverage 88.07% 88.08%
=======================================
Files 162 162
Lines 3145 3146 +1
Branches 508 508
=======================================
+ Hits 2770 2771 +1
Misses 261 261
Partials 114 114
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's a real strength that we generate our rule documentation from both the rule implementations and unit tests. However, ESLint has a limited concept of rule documentation within the rule implementation itself - only a concise description is intended to be stored there.
Therefore, this PR introduces a simple
RULE_DOCS_EXTENSIONwhich a rule implementation file can optionally export and which will be used to generated a more extended rule rationaleCloses #1226