Initial commit

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: test
+on: [push, pull_request]
+env:
+  CI: true
+jobs:
+  test:
+    name: "Test on Node.js ${{ matrix.node-version }}"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [ 18.19, 20 ]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install
+        run: yarn install
+      - name: Test
+        run: yarn test

.gitignore

@@ -0,0 +1,35 @@
+### https://raw.github.com/github/gitignore/608690d6b9a78c2a003affc792e49a84905b3118/Node.gitignore
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
+node_modules
+
+# Debug log from npm
+npm-debug.log
+
+# Publish src/ instead lib/
+/lib

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 aborazmeh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,77 @@
+# textlint-rule-arabic-diacritics [![Actions Status: test](https://github.com/aborazmeh/textlint-rule-arabic-diacritics/workflows/test/badge.svg)](https://github.com/aborazmeh/textlint-rule-arabic-diacritics/actions?query=workflow%3A"test") [![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)
+
+rules for Arabic diacritics issues
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+    npm install textlint-rule-arabic-diacritics
+
+## Fixable
+
+[![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) 
+
+```
+textlint --rule no-kasheeda --fix README.md
+```
+
+## Examples
+
+### Loose Diacritics
+
+    أهلا ً وسهلا ً بكم
+
+Only diacritics will be removed and there likely to be an extra space
+
+    أهلا  وسهلا  بكم
+
+## Usage
+
+Via `.textlintrc.json`(Recommended)
+
+```json
+{
+    "rules": {
+        "arabic-diacritics": {
+          "remove_loose_diacritics": true
+        }
+    }
+}
+```
+
+Via CLI
+
+```
+textlint --rule arabic-diacritics 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
+
+## TODO
+
+- No diacritics or Tanween on Alef without Hamza except Tanween Al-Nasb
+- No middle Tanween
+- No consecutive five Harakat 
+- No consecutive three Sokoon
+- Twneen on Alef or the letter before
+- No Madda with Shadda
+- No Tanween *and* Haraka on the same letter
+- No Haraka *and* Sukun on the same letter
+- No Sukun on the first letter of the word
+
+## License
+
+MIT © aborazmeh