Skip to content

Commit d5bb0d9

Browse files
committed
docs(readme): Update README
1 parent 78cc3e1 commit d5bb0d9

File tree

5 files changed

+45
-11
lines changed

5 files changed

+45
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
### [textlint-rule-ja-space-around-code](./packages/textlint-rule-ja-space-around-code)
1515

16-
インラインコードの周りをスペースで囲むかどうかを決めるルール
16+
インラインコードの周りにスペースでを入れるかを決めるルール
1717

1818
### [textlint-rule-ja-no-space-between-full-width](./packages/textlint-rule-ja-no-space-between-full-width)
1919

@@ -25,27 +25,26 @@
2525
カタカナ語間の区切り文字についてのtextlintルール。
2626
カタカナ語間は中黒または半角スペースを用いてカタカナ語を区切ります。
2727

28+
### [textlint-rule-ja-no-space-around-parentheses](packages/textlint-rule-ja-no-space-around-parentheses)
2829

29-
### Pull Request待ちのルール
30+
かっこの外側、内側ともにスペースを入れないようにするルール
3031

31-
かっこの外側、内側のスペース
32+
### [textlint-rule-ja-space-after-exclamation](packages/textlint-rule-ja-space-after-exclamation)
3233

33-
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/3.3.js
34+
文末に感嘆符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。
35+
文中に感嘆符を使用する場合はスペースを挿入しません
3436

35-
感嘆符後のスペース
37+
### [textlint-rule-ja-space-after-question](packages/textlint-rule-ja-space-after-question)
3638

37-
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/4.2.1.js
38-
39-
疑問符後のスペース
40-
41-
https://github.com/azu/textlint-rule-preset-JTF-style/blob/master/src/4.2.2.js
39+
文末に疑問符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。
40+
文中に疑問符を使用する場合はスペースを挿入しません。
4241

4342
## 開発フロー
4443

4544
1. [packages](./packages)に作成ルール名でディレクトリを作成
4645
2. 作成したディレクトリに通常のnpmモジュール作成と同一のフローで作成
4746

48-
その後、`packages`全体について操作した場合は`lerna`を使う
47+
その後、`packages`全体について操作したい場合は`lerna`を使います
4948

5049
- [Lerna · A tool for managing JavaScript projects with multiple packages.](https://lernajs.io/ "Lerna · A tool for managing JavaScript projects with multiple packages.")
5150

packages/textlint-rule-ja-no-space-around-parentheses/README.md

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

33
かっこ類と隣接する文字のスペースについてのtextlintルール
44

5+
かっこの外側、内側ともにスペースを入れません。
6+
7+
OK: 「良いですね」
8+
NG: 「 ダメですね 」
9+
10+
かっことして次の記号を扱います。
11+
12+
> []()[]「」『』
13+
514
## Install
615

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

packages/textlint-rule-ja-space-after-exclamation/README.md

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

33
感嘆符前後のスペースについてのtexlintルール
44

5+
文末に感嘆符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。
6+
文中に感嘆符を使用する場合はスペースを挿入しません
7+
8+
OK: 驚きの速さ! これが新製品のキャッチコピーでした。
9+
NG: 驚きの速さ! これが新製品のキャッチコピーでした。
10+
511
## Install
612

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

packages/textlint-rule-ja-space-after-question/README.md

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

33
疑問符の直後のスペースについてのtexlintルール
44

5+
文末に疑問符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。
6+
文中に疑問符を使用する場合はスペースを挿入しません。
7+
8+
OK: 驚きの速さ!? これが新製品のキャッチコピーでした?
9+
OK: どう操作したらよいのか?というユーザーの疑問に答えます。
10+
11+
NG: 驚きの速さ!? これが新製品のキャッチコピーでした?
12+
NG: どう操作したらよいのか? というユーザーの疑問に答えます。
13+
514
## Install
615

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

packages/textlint-rule-ja-space-after-question/test/index-test.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ tester.run("疑問符(?)", rule, {
2121
column: 8
2222
}
2323
]
24+
},
25+
{
26+
text: "どう操作したらよいのか? というユーザーの疑問に答えます。",
27+
output: "どう操作したらよいのか? というユーザーの疑問に答えます。",
28+
errors: [
29+
{
30+
message: "文末に感嘆符を使用し、後に別の文が続く場合は、直後に全角スペースを挿入します。",
31+
line: 1,
32+
column: 13
33+
}
34+
]
2435
}
2536
]
2637
});

0 commit comments

Comments
 (0)