https://github.com/aborazmeh/textlint-rule-no-kasheeda
https://github.com/aborazmeh/textlint-rule-no-kasheeda
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aborazmeh/textlint-rule-no-kasheeda
- Owner: aborazmeh
- License: mit
- Created: 2024-07-07T11:56:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-11T14:37:54.000Z (10 months ago)
- Last Synced: 2025-02-25T02:18:04.050Z (2 months ago)
- Language: TypeScript
- Size: 116 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-no-kasheeda [](https://github.com/aborazmeh/textlint-rule-no-kasheeda/actions?query=workflow%3A"test") [](https://textlint.github.io/)
textlint rule to prevents the usage of kasheeda (or Tatweel in Arabic) `ـ` U+0640 symbol in languages like Arabic and Farsi
## Fixable
[](https://textlint.github.io/)
```
textlint --rule no-kasheeda --fix README.md
```
## Example
> يـولد جميع الناس أحراراً ومتـــســـاوين في الكرامة والحقوق
> يـولد جميع الناس أحراراً ومتساوين في الكرامة والحقوق
Kasheedas usage is acceptable when it's not surrounded by letters on each sides:
> العام السابق 1445 هـ، والعام الحالي 1446 هـ
> خَرَجتَ من المُنى مثلَ الـ * * * ـحُمَيِّرِ غَرَّهُ وَتِدُه
> وعندما جاء إلى الـ«بيت» دخل الـ"غرفة" ولم يجد أحداً
## Install
Install with [npm](https://www.npmjs.com/):
npm install textlint-rule-no-kasheeda
## Usage
Via `.textlintrc.json`(Recommended)
```json
{
"rules": {
"no-kasheeda": {
"skip": ["Header"]
}
}
}
```
You can use skip array to define ignored blocks.
# مـقـدمـة
Via CLI
```
textlint --rule no-kasheeda README.md
```
### Build
Builds source codes for publish to the `lib` folder.
You can write ES2015+ source codes in `src/` folder.
npm run build
### Tests
Run test code in `test` folder.
Test textlint rule by [textlint-tester](https://github.com/textlint/textlint-tester).
npm test
## License
MIT © aborazmeh