docs: apply PR review feedback

yumemi-inc · Nov 6, 2024 · ccbb255 · ccbb255
1 parent 6b68c4f
commit ccbb255
Show file tree

Hide file tree

Showing 4 changed files with 131 additions and 17 deletions.
diff --git a/docs/en/GET_STARTED.md b/docs/en/GET_STARTED.md
@@ -8,22 +8,29 @@ Language: English | [日本語](/docs/ja/GET_STARTED.md)
   - [IntelliJ IDEA], [Android Studio] or [Visual Studio Code]
   - [Xcode]
 - Enable the [fvm] command.
+  (Since mason is difficult to access through fvm unlike melos, we set the current version as global in fvm)
+  ```shell
+  fvm use --force
+  FLUTTER_VERSION=$(cat .fvmrc | yq ".flutter" -r) && fvm global $FLUTTER_VERSION
+  ```
 - Enable the [melos] command.
   - Please install the [yq] command if it is not already installed. The yq command is used to parse the `pubspec.lock` file to extract the version of the melos command.
   - Then, run the following command to globally activate the melos command.
 
     ```shell
-    MELOS_VERSION=$(cat pubspec.lock | yq ".packages.melos.version" -r)
-    fvm dart pub global activate melos $MELOS_VERSION
+    MELOS_VERSION=$(cat pubspec.lock | yq ".packages.melos.version" -r) && dart pub global activate melos $MELOS_VERSION
     ```
 
 - Enable the [mason_cli] command.
+  - Run the following command to globally activate the mason_cli command.
+    ```
+    MASON_VERSION=$(cat pubspec.lock | yq ".packages.mason_cli.version" -r) && dart pub global activate mason_cli $MASON_VERSION
+    ```
+  - Also, please run the following command to enable local bricks:
 
-### Set up Flutter SDK
-
-```shell
-fvm use --force
-```
+    ```shell
+    mason get
+    ```
 
 ### Set up the IDEs to use fvm
 

diff --git a/docs/ja/GET_STARTED.md b/docs/ja/GET_STARTED.md
@@ -8,28 +8,30 @@
   - [IntelliJ IDEA], [Android Studio] または [Visual Studio Code]
   - [Xcode]
 - [fvm] コマンドを有効にしてください。
+  - また、以下のコマンドを実行して`.fvmrc`で指定されたバージョンを有効化してください。
+    (masonはmelosのようにfvm経由でのアクセスが難しいため、fvmで現在のバージョンをglobalに設定するようにしている)
+    ```shell
+    fvm use --force
+    FLUTTER_VERSION=$(cat .fvmrc | yq ".flutter" -r) && fvm global $FLUTTER_VERSION
+    ```
 - [melos] コマンドを有効にしてください。
   - pubspec.lock ファイルを解析して melos コマンドのバージョンを取得するため、[yq] コマンドをインストールしてください。
   - 以下のコマンドを実行して melos コマンドをグローバルに有効にしてください。
-
     ```shell
-    MELOS_VERSION=$(cat pubspec.lock | yq ".packages.melos.version" -r)
-    fvm dart pub global activate melos $MELOS_VERSION
+    MELOS_VERSION=$(cat pubspec.lock | yq ".packages.melos.version" -r) && dart pub global activate melos $MELOS_VERSION
     ```
 
 - [mason_cli] コマンドを有効にしてください。
+  - 以下のコマンドを実行して mason コマンドをグローバルに有効にしてください。
+    ```shell
+    MASON_VERSION=$(cat pubspec.lock | yq ".packages.mason_cli.version" -r) && dart pub global activate mason_cli $MASON_VERSION
+    ```
   - また、ローカルのbricksを有効にするため、以下のコマンドを実行してください。
 
     ```shell
     mason get
     ```
 
-### Flutter SDKのセットアップ
-
-```shell
-fvm use --force
-```
-
 ### FVM を使用するように IDE を設定
 
 [Visual Studio Code] を使用している場合は、ウィンドウをリロードして SDK を再読み込みしてください。

diff --git a/pubspec.lock b/pubspec.lock
@@ -9,6 +9,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.3.2+1"
+  archive:
+    dependency: transitive
+    description:
+      name: archive
+      sha256: cb6a278ef2dbb298455e1a713bda08524a175630ec643a242c399c932a0a1f7d
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.6.1"
   args:
     dependency: transitive
     description:
@@ -41,6 +49,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.3.1"
+  checked_yaml:
+    dependency: transitive
+    description:
+      name: checked_yaml
+      sha256: feb6bed21949061731a7a75fc5d2aa727cf160b91af9a3e464c5e3a32e28b5ff
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.3"
+  cli_completion:
+    dependency: transitive
+    description:
+      name: cli_completion
+      sha256: "158deec74a75cdc69bce061645fea08f94190dd6833f988f517c2dfcb45e9117"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.5.0"
   cli_launcher:
     dependency: transitive
     description:
@@ -73,6 +97,38 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.6.0+1"
+  convert:
+    dependency: transitive
+    description:
+      name: convert
+      sha256: b30acd5944035672bc15c6b7a8b47d773e41e2f17de064350988c5d02adb1c68
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.1.2"
+  crypto:
+    dependency: transitive
+    description:
+      name: crypto
+      sha256: "1e445881f28f22d6140f181e07737b22f1e099a5e1ff94b0af2f9e4a463f4855"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.6"
+  equatable:
+    dependency: transitive
+    description:
+      name: equatable
+      sha256: c2b87cb7756efdf69892005af546c56c0b5037f54d2a88269b4f347a505e3ca2
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.5"
+  ffi:
+    dependency: transitive
+    description:
+      name: ffi
+      sha256: "16ed7b077ef01ad6170a3d0c57caa4a112a38d7a2ed5602e0aca9ca6f3d98da6"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.3"
   file:
     dependency: transitive
     description:
@@ -129,6 +185,38 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.9.0"
+  mason:
+    dependency: transitive
+    description:
+      name: mason
+      sha256: "2508bb0bf51028fe6a433d694bd4d586d1ad99abb7699ee24d7ed3bfda0ea39e"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.1.0-dev.57"
+  mason_api:
+    dependency: transitive
+    description:
+      name: mason_api
+      sha256: "2433357d3a9046923137a83ea1847f2177cbab23ea5330b238193abf2714a8ec"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.1.0-dev.11"
+  mason_cli:
+    dependency: "direct dev"
+    description:
+      name: mason_cli
+      sha256: "40121e94b40249697e663ae98a369bf2440c930b97779dd72bbe442081181009"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.1.0-dev.55"
+  mason_logger:
+    dependency: transitive
+    description:
+      name: mason_logger
+      sha256: "1fdf5c76870eb6fc3611ed6fbae1973a3794abe581ea5e22e68af2f73c688b93"
+      url: "https://pub.dev"
+    source: hosted
+    version: "0.2.16"
   matcher:
     dependency: transitive
     description:
@@ -297,6 +385,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.0"
+  watcher:
+    dependency: transitive
+    description:
+      name: watcher
+      sha256: "3d2ad6751b3c16cf07c7fca317a1413b3f26530319181b37e3b9039b84fc01d8"
+      url: "https://pub.dev"
+    source: hosted
+    version: "1.1.0"
   web:
     dependency: transitive
     description:
@@ -305,6 +401,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.5.1"
+  win32:
+    dependency: transitive
+    description:
+      name: win32
+      sha256: "68d1e89a91ed61ad9c370f9f8b6effed9ae5e0ede22a270bdfa6daf79fc2290a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "5.5.4"
   yaml:
     dependency: "direct dev"
     description:
@@ -322,4 +426,4 @@ packages:
     source: hosted
     version: "2.2.1"
 sdks:
-  dart: ">=3.3.1 <4.0.0"
+  dart: ">=3.4.0 <4.0.0"
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -3,6 +3,7 @@ environment:
   sdk: ^3.3.1
 
 dev_dependencies:
+  mason_cli: ^0.1.0-dev.55
   melos: ^6.0.0
   path: ^1.9.0
   yaml: ^3.1.2