[bug] `subprocess.run(["code", root_dir])` により生成された文書をVSCodeで開くときエラーになる

astertechs-dev commented 6 months ago

説明:

subprocess.run(["code", root_dir]) を使用して文書を開く場合、code コマンドがシステムのPATHに存在しないためにエラーが発生します。これはVisual Studio Codeをコマンドラインから起動する際に必要なコマンドです。

現在の状況と暫定的な解決策:

WindowsでVisual Studio Codeをインストールする際、「PATHに追加」オプションを選択すればcode コマンドを利用できます。既にインストール済みの場合、再インストールするか、手動でPATHを設定することで対応可能です。

ただし、すべてのユーザーがこの操作を理解・実行しているわけではありません。そこで現時点での回避策として、Visual Studio Codeの絶対パスをスクリプト内で直接指定する方法がございます。

# ディレクトリを開く
import subprocess
vscode_path = 'C:\\Users\\YourUserName\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe'
root_dir = '<ルートディレクトリへのパス>'
readme_path = '<READMEファイルへのパス>'

subprocess.run([vscode_path, root_dir])
subprocess.run([vscode_path, readme_path])

上記のコードでは YourUserName を自身のユーザー名に置き換え、<ルートディレクトリへのパス> および <READMEファイルへのパス> をそれぞれ適切なものに変更する必要があります。

根本的な解決策の提案:

この問題を解決するためには、インストーラーがPATHを自動的に更新するか、またはVisual Studio Codeの初期セットアップ時にPATHへの追加を促すメッセージを表示する機能が必要です。この改善を通じて、ユーザーが追加の設定を行わずともcode コマンドを即座に使用できるようになります。

追加情報:

一部のユーザーはVisual Studio Codeのインストール後にこの問題に直面し、適切な解決策を見つけられずにいます。
手動での設定は技術的な知識を要し、誤った操作が原因で他の問題を引き起こす可能性があります。
自動的な設定更新はユーザーフレンドリーなアプローチであり、このような初心者ユーザーにも好意的です。

提案されるラベル:

改善提案
インストール
PATH
windows

補足: 上記の文は日本語に訳されたものです。元の英語版のテキストに戻す場合は、適宜元の質問に戻して参照してください。

astertechs-dev commented 6 months ago

@all-contributors please add @astertechs-dev for bug

allcontributors[bot] commented 6 months ago

@astertechs-dev

I've put up a pull request to add @astertechs-dev! :tada:

dai-motoki commented 6 months ago

@astertechs-dev 日本語めっちゃ綺麗ですね！解決します〜

jasagiri commented 3 months ago

zoltraak v0.1.33でも発生していたので追記しておきます。

$ vim ~/.zprofile

export PATH="\$PATH:/usr/local/bin:/Applications/Visual Studio Code.app/Contents/Resources/app/bin:$PATH"

$ source ~/.zprofile

参考リンクを記載します。

https://www.crossroad-tech.com/entry/babylonjs-editor-visual-studio-code-path

dai-motoki / zoltraak