Skip to content

Commit def1d2e

Browse files
committed
Add textlint rule preset-ja-technical-writing
1 parent e4c7f6a commit def1d2e

34 files changed

+1068
-224
lines changed

.textlintrc.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"aws-service-name": true,
1515
"no-mixed-zenkaku-and-hankaku-alphabet": true,
1616
"no-todo": true,
17-
"period-in-list-item": true
17+
"period-in-list-item": true,
18+
"preset-ja-technical-writing": true
1819
}
1920
}

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@
4646
"textlint-rule-aws-service-name": "^1.4.0",
4747
"textlint-rule-no-mixed-zenkaku-and-hankaku-alphabet": "^1.0.1",
4848
"textlint-rule-no-todo": "^2.0.1",
49-
"textlint-rule-period-in-list-item": "^1.0.1"
49+
"textlint-rule-period-in-list-item": "^1.0.1",
50+
"textlint-rule-preset-ja-technical-writing": "^7.0.0"
5051
},
5152
"prettier": {
5253
"singleQuote": true

public/0f4109c425165f5011df.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ https://github.com/hashicorp/terraform/issues/27264#issuecomment-743389837
5454

5555
## 実行環境の追加
5656

57-
私は `terraform init` 実行時に差分が生じ今回の事象に気づきましたが、実行環境の追加が予め予定されている場合、以下コマンドで実行予定のプラットフォームを追加することができます
57+
私は `terraform init` 実行時に差分が生じ今回の事象に気づきましたが、実行環境の追加が予め予定されている場合、以下コマンドで実行予定のプラットフォームを追加できます
5858

5959
下記は、 `darwin_arm64` 環境での実行を予定している場合の例
6060

public/122c789bac1ffadbc973.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ https://github.com/hashicorp/packer/issues/10728#issuecomment-793199077
2424

2525
### Before
2626

27-
下記のように定義された JSON ファイルに対して `packer hcl2_upgrade` を実行すると...
27+
下記のように定義された JSON ファイルに対して `packer hcl2_upgrade` を実行すると..
2828

2929
```json:sample_packer_template.json
3030
{
@@ -47,7 +47,7 @@ source "amazon-ebs" "autogenerated_1" {
4747

4848
### After
4949

50-
記述を変更し `packer hcl2_upgrade` を実行すると...
50+
記述を変更し `packer hcl2_upgrade` を実行すると..
5151

5252
```json:sample_packer_template.json
5353
{

public/238dbd6c0cfdc8600ef5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ https://bugs.ruby-lang.org/issues/17837
9191
https://github.com/ruby/ruby/pull/5703
9292

9393
`Regexp.timeout=` は Ruby 3.2 から利用出来るようになった global な設定です
94-
`Regexp.timeout=` を設定する方法は 2 種類あり、 global に適用指定場合は `Regexp.timeout=` のように記述し、 特定の条件の下のみ timeout を `Regexp.new(/^(a|a)*$/, timeout: 1.0)` のようにも設定することができます
94+
`Regexp.timeout=` を設定する方法は 2 種類あり、 global に適用指定場合は `Regexp.timeout=` のように記述し、 特定の条件の下のみ timeout を `Regexp.new(/^(a|a)*$/, timeout: 1.0)` のようにも設定できます
9595

9696
```ruby
9797
# グローバルに定義したい場合

public/2e7f5cd2dba59f0b5a30.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ https://docs.rubocop.org/rubocop/1.10/configuration.html#inheriting-configuratio
2525

2626
## `inherit_mode` を指定する
2727

28-
Inheritance で複数設定を参照しつつ、定義が重複したときにどのように振る舞うか設定を `inherit_mode` で定義することができます
29-
`inherit_mode``override``merge` を設定することができデフォルトは `override` になっています
28+
Inheritance で複数設定を参照しつつ、定義が重複したときにどのように振る舞うか設定を `inherit_mode` で定義できます
29+
`inherit_mode``override``merge` を設定できデフォルトは `override` になっています
3030

3131
以下は `.rubocop.yml``.rubocop_todo.yml` の各ルールで定義されている Exclude 条件を merge する場合に利用します
3232

public/4abe7a67b0f81f0ba952.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Resources:
6363
### AWS Native の場合
6464

6565
AWS Native Packege を利用している場合は
66-
`getAccountId` を利用することで アカウント ID を取得することができます
66+
`getAccountId` を利用することで アカウント ID を取得できます
6767

6868
```ts:index.ts
6969
import * as pulumi from "@pulumi/pulumi"

public/544171512504b2fbf530.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ iOS, Android ともに、`〓` から ナビゲーションを開き、 Settings
3737

3838
### vCard をダウンロードする
3939

40-
PagerDuty の アプリを利用していない場合は、以下 URL から vCard をダウンロードすることができます
40+
PagerDuty の アプリを利用していない場合は、以下 URL から vCard をダウンロードできます
4141

4242
https://support.pagerduty.com/docs/notification-phone-numbers#update-the-vcard-via-web-download
4343

public/92219f8d4184108a1298.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Orb に対する詳しい説明は以下を参照してください。
8787
https://circleci.com/docs/ja/2.0/orb-intro/
8888

8989
簡単に説明すると、後述する `pulumi/login`を実行出来るよう、設定等を読み込むための設定です。
90-
定義しない場合、 `pulumi/login` 等実行することができません
90+
定義しない場合、 `pulumi/login` 等実行できません
9191

9292
```yml
9393
orbs:

public/a71a300ea8d4ebb69e14.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ RUN case ${TARGETPLATFORM} in \
9393
## `docker-compose.yml` を作成する
9494

9595
実行の度に docker コマンドを打つのはとても面倒なので `docker-compose.yml` を作成します
96-
作成後は `docker compose run --rm terraform` で実行することができます
96+
作成後は `docker compose run --rm terraform` で実行できます
9797

9898
```yml:docker-compose.yml
9999
version: "3"

0 commit comments

Comments
 (0)