Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

型の表記ゆれを統一しました。(例:「文字列型」→「string型」) #714

Merged
merged 6 commits into from
Jun 2, 2023

Conversation

jamashita
Copy link
Contributor

どの用語に統一したかは #704 を見てください。

やったこと

  • textlintのルール(prhっていうの?)を制定して一括置換しました
  • その中であえて残しておくべきものを精査し <!-- textlint-disable prh --> を使い置換しないようにしました

close #704

@vercel
Copy link

vercel bot commented May 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
book ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 2, 2023 11:38am

Copy link
Contributor

@suin suin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

レビューしました!😊

@@ -213,7 +213,7 @@ HaskellやMLなどの関数型プログラミング(FP)の経験がある学習
| [Everyday Types](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html) | 日常的に使用するあらゆる型についての説明 |
| [Narrowing](https://www.typescriptlang.org/docs/handbook/2/narrowing.html) | 型の絞り込みについての説明 |
| [More on Functions](https://www.typescriptlang.org/docs/handbook/2/functions.html) | 関数の型についての詳細説明 |
| [Object Types](https://www.typescriptlang.org/docs/handbook/2/objects.html) | オブジェクト型についての詳細説明 |
| [Object Types](https://www.typescriptlang.org/docs/handbook/2/objects.html) | object型についての詳細説明 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「Object Types」は「オブジェクト型」ではなく「オブジェクトの型」についてだと思うので、object型ではないと思われます。

@@ -47,7 +47,7 @@ const bar = ([a, b]) => {};

## 分割代入引数の型注釈

TypeScriptでオブジェクトを分割代入する場合、分割代入引数の右にオブジェクト型の型注釈を書きます
TypeScriptでオブジェクトを分割代入する場合、分割代入引数の右にobject型の型注釈を書きます
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

objectという型注釈があって、object型とオブジェクト型は違う意味なので、「オブジェクトの型」と表現したほうが、書籍全般通じて読者にとって誤解が少ないかと思います。

@@ -54,15 +54,15 @@ function func({ x, y, z }) {

## Options Objectパターンの型注釈

TypeScriptでOptions Objectパターンを使うときには、引数の型注釈が必要になります。型注釈はオブジェクト型を書きます
TypeScriptでOptions Objectパターンを使うときには、引数の型注釈が必要になります。型注釈はobject型を書きます
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型」

@@ -106,9 +106,9 @@ function isNumberArray(value: unknown): value is number[] {
}
```

### unknown型をオブジェクト型に絞り込む
### unknown型をobject型に絞り込む
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型」

@@ -16,7 +16,7 @@ const keys1 = ["a", "b", "c"];
const keys2 = Object.keys(obj); // keys1より保守性が高い
```

上は変数の再利用の例です。TypeScriptには変数の再利用の型バージョンがあります。それが型の再利用です。たとえば、あるオブジェクト型からキーの型を導き出すことができます
上は変数の再利用の例です。TypeScriptには変数の再利用の型バージョンがあります。それが型の再利用です。たとえば、あるobject型からキーの型を導き出すことができます
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型」

@@ -23,7 +23,7 @@ box = { width: "1080", height: 720 };
box = { width: 1080 };
```

プロパティの区切り文字には、オブジェクトリテラルのようにカンマ`,`も使えますが、セミコロン`;`を用いるほうを推奨します。理由は、コード整形ツール[Prettier](/tutorials/prettier)がオブジェクト型注釈を直すとき、カンマをセミコロンに置き換えるためです。
プロパティの区切り文字には、オブジェクトリテラルのようにカンマ`,`も使えますが、セミコロン`;`を用いるほうを推奨します。理由は、コード整形ツール[Prettier](/tutorials/prettier)がobject型注釈を直すとき、カンマをセミコロンに置き換えるためです。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

もともと誤字で、「の」が抜けてました。ただしくは「オブジェクトの型注釈」

@@ -97,7 +97,7 @@ calculator;

## `Record<Keys, Type>`

連想配列のようなキーバリューのオブジェクト型を定義する場合、ユーティリティ型の`Record`を使う方法もあります。
連想配列のようなキーバリューのobject型を定義する場合、ユーティリティ型の`Record`を使う方法もあります。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型」

@@ -1073,7 +1073,7 @@ function isDuck(animal: Animal): animal is Duck {

### `keyof` keyof型演算子 (keyof) ![ts]

オブジェクト型からプロパティ名を型として返す型演算子です
object型からプロパティ名を型として返す型演算子です
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型」

@@ -9,7 +9,7 @@

- 事実: TypeScriptでは、interfaceとtype aliasのどちらでもオブジェクトの型を定義できる。
- 見解: 書籍のサンプルコードはどちらかに統一するのが好ましい。
- 論点: サンプルコードにおいて、オブジェクト型の型定義には、interfaceとtype aliasどちらを選択するか?
- 論点: サンプルコードにおいて、object型の型定義には、interfaceとtype aliasどちらを選択するか?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「オブジェクトの型定義」

- expected: object型
patterns:
- Object型
- オブジェクト型
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boolean, Number, BigInt, String, Objectはラッパーオブジェクトがあるため、それらを説明しようとしたときに小文字に直されるのは執筆事故になりそうなので、パターンからは除外したほうがいいかもしれません

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ラッパーオブジェクトを削除しました!

@jamashita jamashita marked this pull request as ready for review June 2, 2023 11:44
@jamashita jamashita merged commit 88669b5 into master Jun 2, 2023
@jamashita jamashita deleted the feature/704 branch June 2, 2023 11:44
@suin suin changed the title docs: ✏️ 型の表記を統一しました 型の表記ゆれを統一しました。(例:「文字列型」→「string型」) Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

型名称の表記揺れを統一したい
2 participants