docs(ja): update Formatter in japanese #1076
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
chansuke
force-pushed
the
docs/update-formatter
branch
4 times, most recently
from
db7bf92
to
d056c2e
Compare
chansuke
force-pushed
the
docs/update-formatter
branch
3 times, most recently
from
1cac082
to
0e72d60
Compare
chansuke
commented
Dec 8, 2023
| @@ -8,7 +8,7 @@ import PackageManagerBiomeCommand from "@src/components/PackageManagerBiomeComma | |||
| Biomeは、スタイル関する議論に終止符を打つことを目的とした「opinionated」なformatterです。 | |||
| [Prettierと近い哲学](https://prettier.io/docs/en/option-philosophy.html)を持ち、 | |||
| スタイルに関する議論がBiomeのオプションに関する議論に発展するのを避けるために、いくつかのオプションのみをサポートしています。 | |||
| チーム内での[本質的でない議論](https://ja.wikipedia.org/wiki/パーキンソンの凡俗法則)を防ぎ、本当に重要なことに集中できるようにするために、[新しいオプションを意図的に追加しない](https://github.com/prettier/prettier/issues/40)ようにしています。 | |||
| チーム内での[些細な議論](https://ja.wikipedia.org/wiki/パーキンソンの凡俗法則)を防ぎ、本当に重要なことに集中できるようにするために、[新しいオプションを意図的に追加しない](https://github.com/prettier/prettier/issues/40)ようにしています。 | |||
There was a problem hiding this comment.
些細な議論 is meaningful and suitable than 自転車置き場の議論 IMHO
|
@unvalley |
nissy-dev
suggested changes
Dec 9, 2023
| description: 独断的なフォーマッターを設定する | ||
| --- | ||
|
|
||
| >💡 Biomeは、[Prettierのオプション哲学](https://prettier.io/docs/en/option-philosophy)と同様のアプローチを採用しています。formatに関する既存のオプションセットは安定しており、新しいオプションは考慮される可能性が低いです。 |
There was a problem hiding this comment.
Suggested change
| >💡 Biomeは、[Prettierのオプション哲学](https://prettier.io/docs/en/option-philosophy)と同様のアプローチを採用しています。formatに関する既存のオプションセットは安定しており、新しいオプションは考慮される可能性が低いです。 | |
| >💡 Biomeは、[Prettierのオプションに対する考え方](https://prettier.io/docs/en/option-philosophy)と同様のアプローチを採用しています。formatに関する既存のオプションセットは安定しており、新しいオプションが検討される可能性は低いです。 |
| @@ -0,0 +1,40 @@ | |||
| --- | |||
| title: Formatter Option Philosophy | |||
There was a problem hiding this comment.
Suggested change
| title: Formatter Option Philosophy | |
| title: Formatter オプションに対する考え方 |
|
|
||
| ## 言語ごとの設定 | ||
|
|
||
| 他のツールと違って、Biomeは、言語に属するオプションをその設定とは別の場所に配置します。 |
There was a problem hiding this comment.
Suggested change
| 他のツールと違って、Biomeは、言語に属するオプションをその設定とは別の場所に配置します。 | |
| 他のツールと違って、Biomeは言語ごとに関するオプションを設定することができます。 |
|
|
||
| >💡 Biomeは、[Prettierのオプション哲学](https://prettier.io/docs/en/option-philosophy)と同様のアプローチを採用しています。formatに関する既存のオプションセットは安定しており、新しいオプションは考慮される可能性が低いです。 | ||
| > | ||
| >この文書では、Biomeがどのようにして今日の位置に到達したか、その歴史と今後の展望について説明しています。 |
There was a problem hiding this comment.
Suggested change
| >この文書では、Biomeがどのようにして今日の位置に到達したか、その歴史と今後の展望について説明しています。 | |
| >この文書では、Biomeがどのようにして今日の考え方に至ったのか、その歴史と今後の展望について説明しています。 |
| > | ||
| >この文書では、Biomeがどのようにして今日の位置に到達したか、その歴史と今後の展望について説明しています。 | ||
|
|
||
| Biomeは*独断的なフォーマッター*です。理想では、Biomeは正しいformat方法が1つだけ存在し、そのスタイルを常に強制すると考えています。プロジェクトに関係なく、セットアップに関係なく、Biomeによってformatされたコードは常に同じように見えるでしょう。別の視点から見ると、Biomeは*自動スタイルガイド*であり、他のスタイルガイドを実装するためのツールではありません。 |
There was a problem hiding this comment.
Suggested change
| Biomeは*独断的なフォーマッター*です。理想では、Biomeは正しいformat方法が1つだけ存在し、そのスタイルを常に強制すると考えています。プロジェクトに関係なく、セットアップに関係なく、Biomeによってformatされたコードは常に同じように見えるでしょう。別の視点から見ると、Biomeは*自動スタイルガイド*であり、他のスタイルガイドを実装するためのツールではありません。 | |
| Biomeは*「opinionated」なフォーマッター*です。理想的には、コードをformatする正しい方法は 1 つしかないと想定し、常にそのスタイルを強制することを意味します。プロジェクトに関係なく、セットアップに関係なく、Biomeによってformatされたコードは常に同じように見えるでしょう。別の視点から見ると、Biomeは独自の*自動スタイルガイド*であり、他のスタイルガイドを実装するためのツールではありません。 |
There was a problem hiding this comment.
I' ve updated 「opinionated」なフォーマッター to 「opinionated」なformatter because of the textlint error
|
|
||
| [Prettierのオプション哲学](https://twitter.com/Vjeux/status/1722733472522142022)に基づき、Biomeは新たなスタートを切るチャンスがあり、Prettierが `--bracket-same-line` や `--arrow-parens` などの既存のオプションで陥った落とし穴を避けることができました： | ||
|
|
||
| > ...[これら]は私たちが持っていることを望んでいるタイプのオプションではありません。チーム内で多くの議論を引き起こし、そのために申し訳ありません。今では削除するのが難しいため、これらのオプションは歴史的な遺物として存在し、他のオプションを追加するための動機付けにはなりません（「これらのオプションが存在するなら、なぜこのオプションはダメなのか？」）。 |
There was a problem hiding this comment.
Suggested change
| > ...[これら]は私たちが持っていることを望んでいるタイプのオプションではありません。チーム内で多くの議論を引き起こし、そのために申し訳ありません。今では削除するのが難しいため、これらのオプションは歴史的な遺物として存在し、他のオプションを追加するための動機付けにはなりません（「これらのオプションが存在するなら、なぜこのオプションはダメなのか？」）。 | |
| > ...これらのオプションについては、私たちは保持していることを望んでいません。チーム内で多くの議論を引き起こしており、それを申し訳なく思っています。今では削除するのが難しいため、これらのオプションは歴史的な成果物として存在しており、他のオプションを追加するための動機付けにはなりません（「これらのオプションが存在するなら、なぜこのオプションはダメなのか？」といったような）。 |
|
|
||
| いずれにせよ、[Prettier Challengeが発表](https://twitter.com/Vjeux/status/1722733472522142022)された際、Biomeはこのチャレンジを受け入れることにし、Prettierが持つ全ての設定オプションを実装して完全な互換性を達成する必要がありました。 | ||
|
|
||
| Biomeは依然としてPrettierと同じ哲学を共有しており、これらのオプションを互換性のためのレガシー機能として捉えており、将来的なオプションの追加の基準とは考えていません。 |
There was a problem hiding this comment.
Suggested change
| Biomeは依然としてPrettierと同じ哲学を共有しており、これらのオプションを互換性のためのレガシー機能として捉えており、将来的なオプションの追加の基準とは考えていません。 | |
| ただ、BiomeはPrettierと同じ考え方を共有しており、これらのオプションは互換性のためのレガシー機能として考えています。これらのオプションは、さらに多くのオプションが追加されることを示すものではなく、将来的な他のオプションの存在を裏付ける根拠として使用されるべきではありません。 |
|
|
||
| それにもかかわらず、Biomeはまだ比較的新しいツールとして確立されつつあり、他では実現不可能と思われる新しいアイデアや進歩への道を切り開く機会がたくさんあります。 | ||
|
|
||
| Biomeのformatスタイルも比較的安定しており、Prettierとできるだけ一致するように続けていますが、意図的な逸脱もあります。Biomeのスタイルに対する変更は検討され、実装される可能性がありますが、これらも設定可能なオプションにはならず、代わりに将来のBiomeの全てのバージョンに一律に適用されることになります。 |
There was a problem hiding this comment.
This line is duplicated. please remove
|
|
||
| それにもかかわらず、Biomeはまだ比較的新しいツールとして確立されつつあり、他では実現不可能と思われる新しいアイデアや進歩への道を切り開く機会がたくさんあります。 | ||
|
|
||
| Biomeのformatスタイルも比較的安定しており、Prettierとできるだけ一致するように続けていますが、意図的な逸脱もあります。Biomeのスタイルに対する変更は検討され、実装される可能性がありますが、これらも設定可能なオプションにはならず、代わりに将来のBiomeの全てのバージョンに一律に適用されることになります。 |
There was a problem hiding this comment.
Suggested change
| Biomeのformatスタイルも比較的安定しており、Prettierとできるだけ一致するように続けていますが、意図的な逸脱もあります。Biomeのスタイルに対する変更は検討され、実装される可能性がありますが、これらも設定可能なオプションにはならず、代わりに将来のBiomeの全てのバージョンに一律に適用されることになります。 |
nissy-dev
reviewed
Dec 9, 2023
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
website/src/content/docs/ja/formatter/differences-with-prettier.md
Outdated
Show resolved
Hide resolved
chansuke
force-pushed
the
docs/update-formatter
branch
from
e913766
to
1ef4783
Compare
|
@nissy-dev I appreciate for your review. I've fixed & squashed the commits. |
chansuke
force-pushed
the
docs/update-formatter
branch
from
1ef4783
to
f900171
Compare
nissy-dev
approved these changes
Dec 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes part of updated tasks
Test Plan