Skip to content

Commit b010b2a

Browse files
committed
docs(readme): Update implemented rules
1 parent 6d4153d commit b010b2a

File tree

8 files changed

+41
-8
lines changed

8 files changed

+41
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,4 @@ jspm_packages
3838
# Optional REPL history
3939
.node_repl_history
4040

41+
lib

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,19 @@
1313

1414
インラインコードの周りをスペースで囲むかどうかを決めるルール
1515

16-
### Pull Request待ちのルール
16+
### [textlint-rule-ja-no-space-between-full-width](./packages/textlint-rule-ja-no-space-between-full-width)
17+
18+
全角文字同士の間のスペースについてのtextlintルール
19+
全角文字どうしの間にスペースを入れません。
1720

18-
全角文字同士の間のスペース
21+
### [textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana](packages/textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana)
1922

20-
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.1.2.js
23+
全角文字どうしの間にスペースを入れません。
24+
ただしカタカナ複合語の場合を除きます。
2125

22-
カタカナ語間のスペース
2326

24-
半角 または 中黒
25-
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.2.js
27+
28+
### Pull Request待ちのルール
2629

2730
かっこの外側、内側のスペース
2831

@@ -36,6 +39,19 @@
3639

3740
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/4.2.2.js
3841

42+
## 開発フロー
43+
44+
1. [packages](./packages)に作成ルール名でディレクトリを作成
45+
2. 作成したディレクトリに通常のnpmモジュール作成と同一のフローで作成
46+
47+
その後、`packages`全体について操作した場合は`lerna`を使う。
48+
49+
- [Lerna · A tool for managing JavaScript projects with multiple packages.](https://lernajs.io/ "Lerna · A tool for managing JavaScript projects with multiple packages.")
50+
51+
全てのpackagesの`npm install`:
52+
53+
npm run bootstrap
54+
3955

4056
## Tests
4157

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
"mocha": "^2.5.3"
77
},
88
"scripts": {
9+
"bootstrap": "lerna bootstrap",
10+
"postinstall": "npm run bootstrap",
911
"test": "mocha 'packages/*/test/*-test.js'"
1012
}
1113
}

packages/textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# textlint-rule-ja-nakaguro-or-halfwidth-space-between-katakana
22

33
カタカナ語間の区切り文字についてのtextlintルール
4+
カタカナ語間は中黒または半角スペースを用いてカタカナ語を区切ります。
5+
6+
OK: インターフェース・ブラウザ
7+
NG: インターフェース ブラウザ
48

59
## Install
610

packages/textlint-rule-ja-no-space-between-full-width/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
全角文字同士の間のスペースについてのtextlintルール
44

5+
全角文字どうしの間にスペースを入れません。
6+
ただしカタカナ複合語の場合を除きます。
7+
8+
OK: これは大丈夫。
9+
NG: これは ダメ
10+
511
## Install
612

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

packages/textlint-rule-ja-no-space-between-full-width/src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"use strict";
33
/*
44
全角文字と半角文字の間
5-
原則として、全角文字と半角文字の間にスペースを入れません
5+
全角文字どうしの間にスペースを入れません
66
ただしカタカナ複合語の場合を除きます。
77
*/
88
import {RuleHelper} from "textlint-rule-helper";

packages/textlint-rule-ja-no-space-between-half-and-full-width/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
半角文字と全角文字のスペースについてのtextlintルール
44

5+
全角文字と半角文字の間にスペースを入れません。
6+
7+
OK: これはUnicode
8+
NG: これは Unicode
9+
510
## Install
611

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

packages/textlint-rule-ja-no-space-between-half-and-full-width/src/index.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
/*
44
全角文字と半角文字の間
55
原則として、全角文字と半角文字の間にスペースを入れません。
6-
ただしカタカナ複合語の場合を除きます。
76
*/
87
import {RuleHelper} from "textlint-rule-helper";
98
import {matchCaptureGroupAll} from "match-index";

0 commit comments

Comments
 (0)