https://github.com/aborazmeh/textlint-rule-no-mixed-punctuations

https://github.com/aborazmeh/textlint-rule-no-mixed-punctuations

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/aborazmeh/textlint-rule-no-mixed-punctuations
• Owner: aborazmeh
• License: mit
• Created: 2024-07-08T02:05:37.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-08T12:24:45.000Z (10 months ago)
• Last Synced: 2025-01-24T09:16:52.406Z (3 months ago)
• Language: TypeScript
• Size: 48.8 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-mixed-punctuations [![Actions Status: test](https://github.com/aborazmeh/textlint-rule-no-mixed-punctuations/workflows/test/badge.svg)](https://github.com/aborazmeh/textlint-rule-no-mixed-punctuations/actions?query=workflow%3A"test") [![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)

prevents the mixing of LTR and RTL punctuations

## Install

Install with [npm](https://www.npmjs.com/):

    npm install textlint-rule-no-mixed-punctuations

## Fixable

[![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) 

```

textlint --rule no-mixed-punctuations --fix README.md

```

## Example

> "After a long, arduous journey through the dense forest، filled with towering trees and echoing sounds of wildlife؛ how did they finally find their way to the hidden, mystical waterfall, cascading down into a tranquil pool؟"

> "After a long, arduous journey through the dense forest, filled with towering trees and echoing sounds of wildlife; how did they finally find their way to the hidden, mystical waterfall, cascading down into a tranquil pool?"

## Usage

Via `.textlintrc.json`(Recommended)

```jsonc

{

    "rules": {

        "no-mixed-punctuations": {

          "language": "english"  // choices: 'arabic', 'english

        }

    }

}

```

Via CLI

```

textlint --rule no-mixed-punctuations 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