https://github.com/textlint-rule/textlint-rule-unexpanded-acronym

textlint rule that check unexpanded acronym.
https://github.com/textlint-rule/textlint-rule-unexpanded-acronym

Last synced: about 2 months ago
JSON representation

textlint rule that check unexpanded acronym.

• Host: GitHub
• URL: https://github.com/textlint-rule/textlint-rule-unexpanded-acronym
• Owner: textlint-rule
• License: mit
• Created: 2016-01-06T14:50:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-07T15:45:19.000Z (over 2 years ago)
• Last Synced: 2024-07-28T12:08:38.124Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 121 KB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# textlint-rule-unexpanded-acronym [![Build Status](https://travis-ci.org/textlint-rule/textlint-rule-unexpanded-acronym.svg?branch=master)](https://travis-ci.org/textlint-rule/textlint-rule-unexpanded-acronym)

[textlint](https://github.com/textlint/textlint "textlint") rule that found Unexpanded Acronym.

That is, if there exists an acronym ABC in the document, then there must also exist a sequence of capitalized words such as Axxx Bxx Cxxx.

OK:

```

ABC can stand form the Australian Broadcasting Commission.

```

NG:

```

I like ABC.

(What does ABC stand for ???)

```

## Installation

    npm install textlint-rule-unexpanded-acronym

## Usage

Via CLI

    npm install textlint textlint-rule-unexpanded-acronym -D

    $(npm bin)/textlint --rule unexpanded-acronym README.md

Via `.textlintrc`

```json

{

    "rules": {

        "unexpanded-acronym" : {

            "min_acronym_len" : 3

        }

    }

}

```

### Options

- `min_acronym_len`(default:`3`): Minimum size for the acronym

- `max_acronym_len`(default:`5`): Maximum size for the acronym

- `ignore_acronyms`(default:`[]`): Ignoring acronym List.

```

{

    "rules": {

        "unexpanded-acronym" : {

            // AB is ignore, ABC is recognized.

            "min_acronym_len" : 3,

            // GREEEEEEN is ignore

            "max_acronym_len" : 5,

            // OSS is ignore

            "ignore_acronyms" : ["OSS"]

        }

    }

}

```

## Tests

    npm test

## Reference

- [UnexpandedAcronym](http://redpen.cc/docs/latest/index.html#unexpandedacronym "UnexpandedAcronym")

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## License

MIT