search

azu / textlint-rule-abbr-within-parentheses

textlint rule check if write abbreviations within parentheses.
MIT License
3 stars 1 forks source link

Force to expand abbr when detecting no explanation #2

Open donganzh-zz opened 5 years ago

donganzh-zz commented 5 years ago

Hi, @azu, I would like to propose this feature to the rule. When textlint encounters an abbr alone in the document, i.e. does not detect parentheses after it, textlint should report a message to force the user to expand it into the correct format. This should only be done at the first appearance of this abbr in the document, similar to this rule.

After implementing this feature, we could add the following configuration option

"rules": {
        "abbr-within-parentheses": {
             // allow common acronyms that do not need to be expanded
             "ignore_Acronym": []
         }
    }

Let me know how you think about this new feature, it would be very beneficial to our organization.