Skip to content

Commit 62be3a1

Browse files
committed
add readme
1 parent 4ad5c6c commit 62be3a1

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# textlint-rule-spacing
2+
3+
[textlint](https://textlint.github.io/)のスペース関連のmonorepoです。
4+
全角文字と半角文字の間にスペースをいれるかどうかなどのルールを提供します。
5+
6+
## ルール
7+
8+
### [textlint-rule-ja-no-space-between-half-and-full-width](./packages/textlint-rule-ja-no-space-between-half-and-full-width)
9+
10+
半角文字と全角文字の間にスペースを入れないようにするルール
11+
12+
### [textlint-rule-ja-space-around-code](./packages/textlint-rule-ja-space-around-code)
13+
14+
インラインコードの周りをスペースで囲むかどうかを決めるルール
15+
16+
### Pull Request待ちのルール
17+
18+
全角文字同士の間のスペース
19+
20+
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.1.2.js
21+
22+
カタカナ語間のスペース
23+
24+
半角 または 中黒
25+
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.2.js
26+
27+
かっこの外側、内側のスペース
28+
29+
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.3.js
30+
31+
感嘆符後のスペース
32+
33+
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/4.2.1.js
34+
35+
疑問符後のスペース
36+
37+
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/4.2.2.js
38+
39+
40+
## Tests
41+
42+
以下のコマンドで全てのルールのテストを実行できます。
43+
44+
npm i -d && npm test
45+
46+
## Contributing
47+
48+
1. Fork it!
49+
2. Create your feature branch: `git checkout -b my-new-feature`
50+
3. Commit your changes: `git commit -am 'Add some feature'`
51+
4. Push to the branch: `git push origin my-new-feature`
52+
5. Submit a pull request :D
53+
54+
## License
55+
56+
MIT

0 commit comments

Comments
 (0)