Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aborazmeh committed Jul 7, 2024
0 parents commit 4fd476d
Show file tree
Hide file tree
Showing 8 changed files with 5,651 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -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: [ 16, 18, 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
35 changes: 35 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# textlint-rule-no-kasheeda [![Actions Status: test](https://github.com/aborazmeh/textlint-rule-no-kasheeda/workflows/test/badge.svg)](https://github.com/aborazmeh/textlint-rule-no-kasheeda/actions?query=workflow%3A"test") [![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](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

## Install

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

npm install textlint-rule-no-kasheeda

## Usage

Via `.textlintrc.json`(Recommended)

```json
{
"rules": {
"no-kasheeda": true
}
}
```

Via CLI

```
textlint --rule no-kasheeda README.md
```

## Fixable

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

`textlint --fix` "[يـولد جميع الناس أحراراً ومتـــســـاوين في الكرامة والحقوق](https://github.com/textlint/textlint/blob/master/docs/rule-fixer.md)"


## Example

> يـولد جميع الناس أحراراً ومتـــســـاوين في الكرامة والحقوق
> يـولد جميع الناس أحراراً ومتساوين في الكرامة والحقوق
### 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
Loading

0 comments on commit 4fd476d

Please sign in to comment.