docs: Add Custom Rules info #1674
Merged
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.
This pull request introduces comprehensive support for custom HTMLHint rules, including examples, documentation, and CLI enhancements. The changes aim to make it easier for users to create, configure, and use custom rules to extend HTMLHint's functionality.
Custom Rule Examples and Implementation:
examples/custom-rules/example-rule.js
: Added an example custom rule that checks for accessibility attributes on images and validates class names against a configurable pattern. The rule demonstrates integration with the HTML parser and reporter.examples/custom-rules/README.md
: Documented the example custom rule, including its purpose, usage, configuration, and testing instructions.Documentation Updates:
website/src/content/docs/usage/custom-rules.mdx
: Created a detailed guide on creating, using, and organizing custom rules, including best practices, examples, and troubleshooting tips.website/src/content/docs/usage/cli.md
: Expanded the CLI documentation for the--rulesdir
flag, showing how to load custom rules from files or directories.website/src/content/docs/usage/options.md
: Added documentation for therulesdir
option, with usage examples and details on directory loading behavior.