docs: add filterRules parameter to TextlintKernelDescriptor #1668
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR adds the missing filterRules parameter to the TextlintKernelDescriptor constructor in the documentation. The change ensures the code example matches the actual API requirements where filterRules is a required parameter.
Key Changes
- Added
filterRules: []parameter to theTextlintKernelDescriptorconstructor example
| @@ -96,7 +96,8 @@ const customDescriptor = new TextlintKernelDescriptor({ | |||
| pluginId: "custom-plugin", | |||
| plugin: moduleInterop((await import("./custom-plugin")).default) | |||
| } | |||
| ] | |||
| ], | |||
| filterRules: [] | |||
There was a problem hiding this comment.
[nitpick] Consider adding a comment explaining what the filterRules parameter is for, or provide a more meaningful example than an empty array to help users understand its purpose.
Suggested change
| filterRules: [] | |
| // filterRules can be used to define rules that filter out specific text patterns or content during linting. | |
| filterRules: [ | |
| { | |
| ruleId: "filter-rule-example", | |
| rule: moduleInterop((await import("./filter-rule-example")).default) | |
| } | |
| ] |
Copilot uses AI. Check for mistakes.
Merged
azu
added a commit
that referenced
this pull request
Aug 20, 2025
<!-- Release notes generated using configuration in .github/release.yml at master --> ## What's Changed ### Bug Fixes * fix(textlint-tester): support empty string test cases by @kellyselden in #1698 ### Documentation * docs: add filterRules parameter to TextlintKernelDescriptor by @k35o in #1668 * docs: add GitHub Actions CI/CD integration examples by @azu in #1671 * docs: fix typos in README by @azu in #1681 * docs: clarify JSON comment support in configuration files by @azu in #1690 ### Maintenance * chore: Node.js maintenance updates by @azu in #1682 ### CI * chore(deps): update github/codeql-action action to v3.29.3 by @renovate[bot] in #1672 * chore(deps): update github/codeql-action action to v3.29.5 by @renovate[bot] in #1675 * chore(deps): update github/codeql-action action to v3.29.7 by @renovate[bot] in #1679 * chore(deps): update actions/checkout action to v4.3.0 by @renovate[bot] in #1695 * CI(create-release-pr): remove unneeded --yes by @azu in #1699 * chore(deps): update github/codeql-action action to v3.29.9 by @renovate[bot] in #1700 ### Dependency Updates * fix(deps): update dependency @modelcontextprotocol/sdk to ^1.16.0 by @renovate[bot] in #1665 * chore(deps): update dependency eslint-config-prettier to ^10.1.8 by @renovate[bot] in #1666 * chore(deps): update patch updates (patch) by @renovate[bot] in #1667 * chore(deps): update eslint to ^8.38.0 (patch) by @renovate[bot] in #1674 * fix(deps): update patch updates (patch) by @renovate[bot] in #1676 * chore(deps): update dependency @eslint/js to ^9.32.0 by @renovate[bot] in #1678 * fix(deps): update react monorepo to ^19.1.1 (patch) by @renovate[bot] in #1677 * fix(deps): update minor updates (minor) by @renovate[bot] in #1680 * chore(deps): update dependency lint-staged to ^16.1.4 by @renovate[bot] in #1683 * chore(deps): remove unused unique-concat dependency by @azu in #1687 * chore(deps): remove unused mkdirp dependency by @azu in #1688 * chore(deps): update eslint to ^8.39.0 (minor) by @renovate[bot] in #1691 * fix(deps): update dependency @modelcontextprotocol/sdk to ^1.17.2 by @renovate[bot] in #1692 * chore(deps): update dependency lint-staged to ^16.1.5 by @renovate[bot] in #1693 * chore(deps): update dependency @eslint/js to ^9.33.0 by @renovate[bot] in #1694 * chore(deps): update eslint to ^8.39.1 (patch) by @renovate[bot] in #1696 ### Other Changes * chore(deps): update node.js to v22.17.1 by @renovate[bot] in #1660 * feat(website): make the entire sidebar hideable by @JamBalaya56562 in #1669 ## New Contributors * @JamBalaya56562 made their first contribution in #1669 **Full Changelog**: v15.2.1...v15.2.2 Co-authored-by: azu <azu@users.noreply.github.com>
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.
Updated documentation to include
filterRulesparameter, which is required forTextlintKernelDescriptorconstructor.References
textlint/packages/@textlint/kernel/src/descriptor/TextlintKernelDescriptor.ts
Lines 17 to 23 in 3f0423b
textlint/packages/@textlint/kernel/src/descriptor/README.md
Lines 18 to 36 in 3f0423b