Support a user-defined function for --path-rule-doc option
#502
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
bmish
changed the title
--path-rule-doc option
bmish
reviewed
Nov 13, 2023
test/lib/generate/file-paths-test.ts
Outdated
| it('generates the documentation using a function for pathRuleDoc', async function () { | ||
| await generate('.', { | ||
| pathRuleDoc: (ruleName) => join('rules', ruleName, `${ruleName}.md`), | ||
| pathRuleList: join('rules', 'list.md'), |
There was a problem hiding this comment.
Let's remove pathRuleList from this test as it's not relevant.
| @@ -182,7 +182,7 @@ There's also a `postprocess` option that's only available via a [config file](#c | |||
| | `--ignore-config` | Config to ignore from being displayed. Often used for an `all` config. Option can be repeated. | | | |||
| | `--ignore-deprecated-rules` | Whether to ignore deprecated rules from being checked, displayed, or updated. | `false` | | |||
| | `--init-rule-docs` | Whether to create rule doc files if they don't yet exist. | `false` | | |||
| | `--path-rule-doc` | Path to markdown file for each rule doc. Use `{name}` placeholder for the rule name. | `docs/rules/{name}.md` | | |||
| | `--path-rule-doc` | Path to markdown file for each rule doc. Use `{name}` placeholder for the rule name. A function can also be provided for this option via a [config file](#configuration-file). | `docs/rules/{name}.md` | | |||
There was a problem hiding this comment.
Can you add an example of the function to the "Configuration file" section in the readme, similar to how we have examples of the other option functions in that section?
`pathRuleDoc` and `urlRuleDoc` functions.
Thank you very much for your suggestions too |
12 tasks
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.
close #501
If I missed or messed up something, please let me know and I will correct it ASAP.