docs: add Japanese README #461
Conversation
I created Japanese translated README.
WalkthroughThis update introduces Japanese as an additional language option in the project documentation. The root README file and several translation-specific README files (Korean, Portuguese, and Chinese) have been updated to include a new link for Japanese. Additionally, a new Japanese README has been added under the Flutter Hooks translations to provide comprehensive information about the library. No changes were made to any exported or public entities. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
packages/flutter_hooks/resources/translations/zh_cn/README.md (1)
1-1: Nitpick: Validate Markdown SyntaxPlease double-check that all markdown links in the language selection line are correctly paired with matching square brackets and parentheses to avoid any rendering issues.
packages/flutter_hooks/resources/translations/ja_jp/README.md (2)
93-95: Explanation of Hooks UsageThe section explaining that hooks are independent and can be reused arbitrarily is clear. As a minor nitpick, please verify that the punctuation in this explanation (around the transition to the code snippet) is complete for optimal readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~94-~94: A punctuation mark might be missing here.
Context: ...ildメソッドでのみ使用できます。 - 同じフックを任意の回数再利用できます。 次のコードは、2つの独立したAnimationController`を定義し、...(AI_EN_LECTOR_MISSING_PUNCTUATION)
204-205: Nitpick: Check End-of-Line PunctuationIn the text explaining hot-reload behavior, consider verifying whether an additional punctuation mark (such as a comma or period) could improve clarity in the sentence about disposing hooks after refactoring.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~204-~204: A punctuation mark might be missing here.
Context: ...れると、最初の影響を受けた行の後のすべてのフックがdisposeされるためです。 したがって、HookCがHookBの後に配置されていたため、dispos...(AI_EN_LECTOR_MISSING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
README.md(1 hunks)packages/flutter_hooks/resources/translations/ja_jp/README.md(1 hunks)packages/flutter_hooks/resources/translations/ko_kr/README.md(1 hunks)packages/flutter_hooks/resources/translations/pt_br/README.md(1 hunks)packages/flutter_hooks/resources/translations/zh_cn/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/flutter_hooks/resources/translations/ja_jp/README.md
[uncategorized] ~94-~94: A punctuation mark might be missing here.
Context: ...ildメソッドでのみ使用できます。 - 同じフックを任意の回数再利用できます。 次のコードは、2つの独立したAnimationController`を定義し、...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~204-~204: A punctuation mark might be missing here.
Context: ...れると、最初の影響を受けた行の後のすべてのフックがdisposeされるためです。 したがって、HookCがHookBの後に配置されていたため、dispos...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
packages/flutter_hooks/resources/translations/pt_br/README.md
[typographical] ~1-~1: Símbolo sem par: “]” aparentemente está ausente
Context: ...sources/translations/zh_cn/README.md) | [日本語](https://github.com/rrousselGit/flut...
(UNPAIRED_BRACKETS)
🔇 Additional comments (11)
packages/flutter_hooks/resources/translations/ko_kr/README.md (1)
1-2: Added Japanese Language LinkThe Japanese translation link has been successfully appended to the language selection line. This update improves accessibility by providing direct navigation to the Japanese documentation.
packages/flutter_hooks/resources/translations/zh_cn/README.md (1)
1-2: Added Japanese Language LinkThe Japanese language link has been correctly added alongside the existing links. This ensures that Chinese readers (and others) can easily switch to the Japanese version of the documentation.
packages/flutter_hooks/resources/translations/pt_br/README.md (1)
1-2: Added Japanese Language LinkThe Portuguese translation README now includes a link for Japanese, expanding the available language options. This change promotes better accessibility for users who prefer Japanese documentation.
🧰 Tools
🪛 LanguageTool
[typographical] ~1-~1: Símbolo sem par: “]” aparentemente está ausente
Context: ...sources/translations/zh_cn/README.md) | [日本語](https://github.com/rrousselGit/flut...(UNPAIRED_BRACKETS)
README.md (1)
1-2: Enhanced Language Options with Japanese LinkThe main README’s language selection line has been updated to include the Japanese link. This consistent update across the project improves accessibility and user experience for Japanese-speaking users.
packages/flutter_hooks/resources/translations/ja_jp/README.md (7)
1-7: Japanese Translation Document SetupThe language selection line and badge section are properly introduced at the top of the new Japanese README. The links, images, and formatting are consistent with the other translations.
8-14: Title and Introduction SectionThe title "Flutter Hooks" and the introductory line explaining the Flutter implementation of React hooks are clear, concise, and well translated. This sets a good tone for the rest of the document.
16-27: Motivation Section ("動機")The "動機" section effectively outlines the challenges with
StatefulWidget(using theAnimationControllerexample) and provides a well-formatted code snippet. This mirrors the style of the other translations.
55-66: Code Example forAnimationControllerUsageThe example code block correctly demonstrates the usage pattern of an
AnimationControllerwithin aStatefulWidgetcontext. The code is well indented and clearly presented.
270-280: Custom Hook Creation ExamplesThe section that explains how to create custom hooks—both as functions and as classes—is thorough and contains well-formatted Dart code samples. These examples will be very helpful for developers looking to extend the library.
340-348: Existing Hooks OverviewThe comprehensive list of existing hooks is well organized into categories with clear descriptions. The table formatting is consistent and mirrors the structure seen in other translation files.
349-378: Contributions and Sponsors SectionsThe final sections regarding contributions and sponsors are complete and consistent with the rest of the documentation. Their inclusion supports community involvement and maintains uniformity across language versions.
|
LGTM! Thanks:) |
2 participants
I created Japanese translated README.
Summary by CodeRabbit
New Features
Documentation