-
Notifications
You must be signed in to change notification settings - Fork 177
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
docs: translate static-type-checking.md #179
docs: translate static-type-checking.md #179
Conversation
Deploy preview for ja-reactjs ready! Built with commit a5651d4 |
@Naturalclar |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
一旦 221 行目まで見ました。
表記揺れ修正などいくつかあるので、それ含めて修正お願いします!
あとは今日の夜か明日みます
@Naturalclar 👆🙏 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
大部分は細かいこだわりみたいなものですので適宜採用したりしなかったりしてください。
全体的な話ですが、"type annotation" に対して「型記法」「型定義」「記法」などの訳語が混在してしまっています。個人的には「型注釈」もアリだと思いますが、いずれにせよ統一が望ましいと思います。
content/docs/static-type-checking.md
Outdated
|
||
## Flow {#flow} | ||
|
||
[Flow](https://flow.org/) is a static type checker for your JavaScript code. It is developed at Facebook and is often used with React. It lets you annotate the variables, functions, and React components with a special type syntax, and catch mistakes early. You can read an [introduction to Flow](https://flow.org/en/docs/getting-started/) to learn its basics. | ||
[Flow](https://flow.org/) は JavaScript 用の型チェック機能です。Facebook で開発されており、React と一緒に使われることが多いです。変数、関数や React コンポーネントに型を足すことができ、型不整合を早期に発見できるようになります。[はじめての Flow](https://flow.org/en/docs/getting-started/) に基本情報が記載されているので、それを読むと良いでしょう。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Flow](https://flow.org/) は JavaScript 用の型チェック機能です。Facebook で開発されており、React と一緒に使われることが多いです。変数、関数や React コンポーネントに型を足すことができ、型不整合を早期に発見できるようになります。[はじめての Flow](https://flow.org/en/docs/getting-started/) に基本情報が記載されているので、それを読むと良いでしょう。 | |
[Flow](https://flow.org/) は JavaScript 用の静的型チェッカです。Facebook で開発されており、React と一緒に使われることが多いです。変数、関数や React コンポーネントに型を足すことができ、型不整合を早期に発見できるようになります。[はじめての Flow](https://flow.org/en/docs/getting-started/) に基本情報が記載されているので、それを読むと良いでしょう。 |
すぐ上との訳語統一です。「チェッカー」になるかも
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How to contributeや
Type-checking with PropTypes等、他のドキュメントで「型チェック機能」と訳されているので、そちらの方によせた方が良いのかなと個人的に思いましたがどうでしょう?
すぐ上の「型チェッカ(ー)」はFlowと言う「機能」とTypeScriptという「言語」をあわせたものとして例外的に「チェッカ(ー)」の方が適切と感じます。
content/docs/static-type-checking.md
Outdated
* Add Flow to your project as a dependency. | ||
* Ensure that Flow syntax is stripped from the compiled code. | ||
* Add type annotations and run Flow to check them. | ||
* Flow をプロジェクトの Dependency に入れる。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Flow をプロジェクトの Dependency に入れる。 | |
* Flow をプロジェクトの dependency に追加する。 |
content/docs/static-type-checking.md
Outdated
* Ensure that Flow syntax is stripped from the compiled code. | ||
* Add type annotations and run Flow to check them. | ||
* Flow をプロジェクトの Dependency に入れる。 | ||
* Flow の記法をコンパイル時にコードから剥がす。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Flow の記法をコンパイル時にコードから剥がす。 | |
* Flow の記法をコンパイル時にコードから剥がすように設定する。 |
この時点では Flow のトランスパイルが動くよう設定するだけで、実際に Flow を使って開発をするのは次以降のステップ…という書き方なので ensure は訳出したほうがよい気がします
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
同意です!ありがとうございます
content/docs/static-type-checking.md
Outdated
|
||
```bash | ||
npm run flow init | ||
``` | ||
|
||
This command will create a Flow configuration file that you will need to commit. | ||
このコマンドで Flow の設定ファイルを生成することができます。この設定ファイルは Git 管理しましょう。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
このコマンドで Flow の設定ファイルを生成することができます。この設定ファイルは Git 管理しましょう。 | |
このコマンドで Flow の設定ファイルを生成することができます。この設定ファイルはバージョン管理しましょう。 |
Gitを前提としないようにしました
content/docs/static-type-checking.md
Outdated
|
||
Flow extends the JavaScript language with a special syntax for type annotations. However, browsers aren't aware of this syntax, so we need to make sure it doesn't end up in the compiled JavaScript bundle that is sent to the browser. | ||
Flow は JavaScript の拡張機能として、型定義の為の特殊な記法を使います。しかし、ブラウザはその記法について知らない為、コンパイル後の JavasScript バンドルに含まれないようにしなければいけません。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Flow は JavaScript の拡張機能として、型定義の為の特殊な記法を使います。しかし、ブラウザはその記法について知らない為、コンパイル後の JavasScript バンドルに含まれないようにしなければいけません。 | |
Flow は JavaScript 言語を拡張し、型定義のための特殊な記法を使えるようにします。しかし、ブラウザはその記法について知らないため、ブラウザに送信されるコンパイル後の JavaScript バンドルにその記法が含まれないようにしなければいけません。 |
- 「為」→「ため」、「JavasScript」→「JavaScript」
content/docs/static-type-checking.md
Outdated
|
||
There are two main ways to get declarations for a library: | ||
__Bundled__ - これはライブラリ自体が型宣言ファイルを所有している場合です。この場合、ライブラリをインストールするだけでそのまま使用することができます。ライブラリが型宣言ファイルを所有しているかどうかは、プロジェクトに `index.d.ts` ファイルがあるかどうかを確認します。一部のライブラリは `package.json` の `typings`、または `types` の下に型宣言ファイルのパスを指定しています。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
__Bundled__ - これはライブラリ自体が型宣言ファイルを所有している場合です。この場合、ライブラリをインストールするだけでそのまま使用することができます。ライブラリが型宣言ファイルを所有しているかどうかは、プロジェクトに `index.d.ts` ファイルがあるかどうかを確認します。一部のライブラリは `package.json` の `typings`、または `types` の下に型宣言ファイルのパスを指定しています。 | |
__Bundled__ - これはライブラリ自体が型宣言ファイルを所有している場合です。この場合、ライブラリをインストールするだけでそのまま使用することができます。ライブラリが型宣言ファイルを所有しているかどうか確認するには、プロジェクトに `index.d.ts` ファイルがあるかどうかを見ます。一部のライブラリは `package.json` の `typings`、または `types` の下に型宣言ファイルのパスを指定しています。 |
content/docs/static-type-checking.md
Outdated
__Bundled__ - The library bundles its own declaration file. This is great for us, since all we need to do is install the library, and we can use it right away. To check if a library has bundled types, look for an `index.d.ts` file in the project. Some libraries will have it specified in their `package.json` under the `typings` or `types` field. | ||
|
||
__[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)__ - DefinitelyTyped is a huge repository of declarations for libraries that don't bundle a declaration file. The declarations are crowd-sourced and managed by Microsoft and open source contributors. React for example doesn't bundle its own declaration file. Instead we can get it from DefinitelyTyped. To do so enter this command in your terminal. | ||
__[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)__ - DefinitelyTyped には様々な型宣言ファイルが含まれていないライブラリの型定義が用意されています。これらの型定義はクラウドソースにより Microsoft とオープンソースのコントリビュータが管理しています。例えば、React には型宣言ファイルが含まれておりませんが、DefinitelyTyped から取得することができます。取得するにはターミナルに以下のコマンドを入力してください。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
__[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)__ - DefinitelyTyped には様々な型宣言ファイルが含まれていないライブラリの型定義が用意されています。これらの型定義はクラウドソースにより Microsoft とオープンソースのコントリビュータが管理しています。例えば、React には型宣言ファイルが含まれておりませんが、DefinitelyTyped から取得することができます。取得するにはターミナルに以下のコマンドを入力してください。 | |
__[DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped)__ - DefinitelyTyped には型宣言ファイルがバンドルされていない様々なライブラリのための型定義が用意されています。これらの型定義はクラウドソースにより Microsoft とオープンソースのコントリビュータが管理しています。例えば、React には型宣言ファイルが含まれておりませんが、DefinitelyTyped から取得することができます。取得するにはターミナルに以下のコマンドを入力してください。 |
「様々な」の語順調整
content/docs/static-type-checking.md
Outdated
__Local Declarations__ | ||
Sometimes the package that you want to use doesn't bundle declarations nor is it available on DefinitelyTyped. In that case, we can have a local declaration file. To do this, create a `declarations.d.ts` file in the root of your source directory. A simple declaration could look like this: | ||
__ローカル型定義__ | ||
もし、使用しているライブラリに型宣言ファイルが含まれておらず、DefinitelyTyped にも該当する型宣言ファイルが無い場合、自前で型宣言ファイルを作成することができます。それを行うには `declarations.d.ts` をソースディレクトリのルートに作成します。型宣言は以下の様に行なえます。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
もし、使用しているライブラリに型宣言ファイルが含まれておらず、DefinitelyTyped にも該当する型宣言ファイルが無い場合、自前で型宣言ファイルを作成することができます。それを行うには `declarations.d.ts` をソースディレクトリのルートに作成します。型宣言は以下の様に行なえます。 | |
もし、使用しているライブラリに型宣言ファイルが含まれておらず、DefinitelyTyped にも該当する型宣言ファイルがない場合、自前で型宣言ファイルを作成することができます。それを行うには `declarations.d.ts` をソースディレクトリのルートに作成します。型宣言は以下のように行なえます。 |
content/docs/static-type-checking.md
Outdated
|
||
Note there are other statically typed languages that compile to JavaScript and are thus React compatible. For example, [F#/Fable](https://fable.io/) with [elmish-react](https://elmish.github.io/react). Check out their respective sites for more information, and feel free to add more statically typed languages that work with React to this page! | ||
JavaScript にコンパイルされ、React にも活用できる静的型言語は他にも存在します。例えば、[F#/Fable](https://fable.io/) と [elmish-react](https://elmish.github.io/react) の活用です。詳細はそれぞれのサイトを確認してください。他にも React を活用できる静的型言語があれば、ぜひこのページに追記してください! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JavaScript にコンパイルされ、React にも活用できる静的型言語は他にも存在します。例えば、[F#/Fable](https://fable.io/) と [elmish-react](https://elmish.github.io/react) の活用です。詳細はそれぞれのサイトを確認してください。他にも React を活用できる静的型言語があれば、ぜひこのページに追記してください! | |
JavaScript にコンパイルされ、React にも活用できる静的型言語は他にも存在します。例えば、[F#/Fable](https://fable.io/) と [elmish-react](https://elmish.github.io/react) の組み合わせです。詳細はそれぞれのサイトを確認してください。他にも React を活用できる静的型言語があれば、ぜひこのページに追記してください! |
ありがとうございました! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Naturalclar
遅くなりましたがこれ OK なやつでした🙇
ありがとうございました!
This PR is part of #4
I've trasnlated
static-type-checking.md
to Japanese.Sorry for the delay!