環境構築マニュアル (MacOS/Linux) で、MacだとXS-devのexport.shを呼ばないとmcconfigなどのツールが呼べない

sugarsweetrobotics commented 4 months ago

不具合の概要 環境構築マニュアル (MacOS/Linux) で、Macだと~/.local/share/xs-dev-export.shを呼ばないとmcconfigなどのツールが呼べないですが、マニュアルには記述がないので、親切のためにできれば追記をお願いしたい。

再現手順 空のMacの環境を用意し、homebrewをインストール。マニュアルに従って以下の順序でコマンドを実行する。

$ brew install git
$ git clone --recursive https://github.com/rt-net/stack-chan.git
$ cd stack-chan/firmware
$ npm I 
$ npm run setup
$ npm run setup -- --device=esp32
$ npm run build --target=esp32/m5stack_cores3

結果として最後のコマンドで以下のエラーメッセージを得る

> stack-chan@0.2.1 build
> cross-env npm_config_target?=esp32/m5stack cross-env-shell mcconfig -d -m -p $npm_config_target -t build ./stackchan/manifest_local.json

/bin/sh: mcconfig: command not found

挙動と原因と対応策 mcconfig等のModdableに関するコマンドが~/.local/share以下にインストールされているものの、PATHが設定されていない。これについては ~/.local/share/xs-dev-export.shを呼び出すことで対応できるが、マニュアルに記述がないです。シンプルにxs-dev-export.shを毎回呼び出すか、.zshrcをホームに作成してsourceすることを記述する旨、マニュアルに追記することをお願いしたい。

環境 (次の項目を埋めてください):

OS: MacOS Sonoma 14.5
スタックちゃんアールティVer.

stc1988 commented 4 months ago

xs-devのsetupにて.zshrcにxs-dev-export.shの読み込みが追記されるはず、かつsetup完了時に新規ターミナルセッションの開始が必要な旨が表示されます。

とは言え、見逃しやすいところなので、手順書にターミナルを開き直す必要がある旨を追記した方が親切かと思います。

https://xs-dev.js.org/features/setup/

KuraZuzu commented 1 month ago

ご報告ありがとうございます。こちら現在対応中です。後ほど反映させていただきます。

rt-net / stack-chan

環境構築マニュアル (MacOS/Linux) で、MacだとXS-devのexport.shを呼ばないとmcconfigなどのツールが呼べない #15