Feat/add option/no colon list formatting #15
Closed
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
- Add an option to disable the colon + list formatting rule to reduce overly strict warnings - Add tests for enabling/disabling the new option in ai-tech-writing-guideline.test.ts
azu
reviewed
Jul 5, 2025
| @@ -19,6 +19,8 @@ export interface Options { | |||
| disableConsistencyGuidance?: boolean; | |||
| disableClarityGuidance?: boolean; | |||
| disableStructureGuidance?: boolean; | |||
| // Disable colon + list formatting checks (allows colon followed by bullet points) | |||
| "no-ai-colon-list-formatting"?: boolean; | |||
There was a problem hiding this comment.
I would like to align the name with other options and name it disableColonListFormatting.
There was a problem hiding this comment.
I have one question. This rule's name uses camelCase.
It's diffrent from other textlint rules name using kebab-case.
Is this new standard of new textlint rule set?
BTW, I change the name of options.
There was a problem hiding this comment.
This is option name, it is not rule name.
|
I thought the |
|
I think the above PR will solve the problem, so I will close this PR. Thanks for the PR! |
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.
✨ Overview
This PR introduces a new option
no-ai-colon-list-formattingto theai-tech-writing-guidelinerule. The motivation is to allow flexibility for users who prefer colon + list formats without receiving unnecessary warnings.By enabling this option, the rule will skip checks that flag colon-terminated sentences followed by bullet lists as mechanical.
🔧 Changes
List the key changes included in this PR:
ai-tech-writing-guideline.ts)📂 Related Issues
No related issues.
✅ Checklist
Please confirm the following before requesting review:
💬 Additional Notes
✅ Lint and test passed in local PR (#1)
Test cases were added to validate the behavior when the option is enabled or disabled. By default, colon + list still produces warnings, preserving current rule behavior.