レガシー環境から脱却したい

プログラミングや環境構築の話をまとめています。

PhpStorm on WSL2でWindowsに依存しない開発環境を作る

はじめに

WindowsPHPなどの開発をしていると色々トラブルに見舞われます。

WSL2やWindows terminalの登場で、端末環境はほぼLinux同等のものが動くようになりました。

しかし、コード編集にWindows側のIDEを使おうとすると色々トラブルに見舞われます。
(Dockerの実効速度とか、Git管理時のパーミッション問題とか)

それらはLinuxマシンを使えば解決することですが、Windowsマシンを使いたい。。。

今回はWSL2に開発ツールを詰め込みX-Server経由でGUI操作することで、Windowsの依存性を限りなく減らした環境を作成します。

補足

VSCodeを使用する場合はX環境を設定しなくても、Remote Develop機能でWSL2内の環境を直接操作できると思います。

また、Windowsのファイルエクスプローラ\\wls$\ubuntu-20.04\にアクセスすると、WSL2内のファイルが参照できますので、Windows側から操作できます。

今回は、X-Server経由でWSL2内のPhpStorm(Intellij IDEA)を利用して開発する環境を設定しました。

ゴール

下記の設定を行います。

  • WSL2の有効化
  • Docker、docker-composeをインストール
  • X-Server設定し、WSL2上のPhpStormを開く

環境

  • ホスト
    • Windows10 Professional
  • WSL2

設定手順

  1. WSL2の有効化
  2. X-Serverの設定
  3. Dockerのインストール
  4. PhpStorm設定
  5. その他ツール(Node.js、Fish)

1.WSL2の有効化

WSLにUbuntuをインストールして、WSL2を有効化します。

WSL2を有効化するためには、Windows10が下記のバージョンである必要があります。
バージョン 2004、ビルド 19041 以上

こちらのページを参考にインストールします。

docs.microsoft.com

途中、何回か再起動が必要です。

エラーの対応

> wsl --set-default-version 2

このコマンドの実行時、下記のエラーが出る場合は、カーネルの更新が必要です。

変換中です。この処理には数分かかることがあります...
WSL 2 を実行するには、カーネル コンポーネントの更新が必要です。詳細については https://aka.ms/wsl2kernel を参照してください

指摘通りに、https://aka.ms/wsl2kernelページ内のリンクからダウンロードしてインストールします。

Ubuntuをインストールして、バージョン2になったことを確認

> wsl -l -v
  NAME            STATE           VERSION
* Ubuntu-20.04    Running         2

WSLのバージョンが1の場合は、下記コマンドで個別に設定可能です。

> wsl --set-version Ubuntu-20.04 2

2.X-Serverの設定

下記ページを参考にしました。

参考ページ:

① X環境のインストール

少しでも軽いものをと思い、軽量デスクトップ環境のXfceを選択しました。

$ sudo apt update && sudo apt upgrade -y
$ sudo apt install -y xfce4-terminal xfce4-session xfce4

※途中、ログインマネージャの選択(GDMとLightDM)が出ますが、おそらくどちらでも構いません。
私はLightDMを選びました。

WindowsにVcXsrv(XServer)をインストール

下記リンクよりダウンロードしてインストールします。

sourceforge.net

XLaunch(VcXsrvのアプリ名)を起動します。

設定はこちら

  • 1ページ目:Multiple Windows
  • 2ページ目:Start no client
  • 3ページ目:全部チェック

f:id:odaryo:20200116162353j:plain

一度起動したらそのまま放置しておけば良いですが、
毎回設定するのは面倒なので、ショートカットや自動起動の設定をしておくと良いです。

③ X環境の動作確認

WSL2側で".bashrc"に下記を追記します。

export DISPLAY=$(cat /etc/resolv.conf | grep nameserver | awk '{print $2}'):0.0

設定をリロード

$ source $HOME/.bashrc

試しにxeyesを表示させてみます。

$ xeyes

起動に成功すると、xeyesのアプリが表示されます。

f:id:odaryo:20200116153720p:plain

もし、起動されなかった場合はWindows側でVcXsrvのファイアウォール設定を試してください。

f:id:odaryo:20200116102531p:plain

設定の詳細については下記を参照してください。

odaryo.hatenablog.com

④ 日本語環境のインストール

日本語環境として、fcitx-mozcをインストールします。
※色々試し、上手く行った方法をまとめます

1.Japanese Teamの追加パッケージを設定

$ wget -q https://www.ubuntulinux.jp/ubuntu-ja-archive-keyring.gpg -O- | sudo apt-key add -
$ wget -q https://www.ubuntulinux.jp/ubuntu-jp-ppa-keyring.gpg -O- | sudo apt-key add -
$ sudo wget https://www.ubuntulinux.jp/sources.list.d/bionic.list -O /etc/apt/sources.list.d/ubuntu-ja.list
$ sudo apt update
$ sudo apt upgrade -y
$ sudo apt install ubuntu-defaults-ja

2.fcitx-mozcのインストール

$ sudo apt install fcitx fcitx-mozc

環境変数が必要なため、以下を.bashrcに追記します。

export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx
export XMODIFIERS=@im=fcitx
export DefaultIMModule=fcitx

設定をリロード

$ source $HOME/.bashrc

3.日本語フォントをインストール

$ sudo apt install fonts-noto-cjk fonts-noto-color-emoji

4.日本語ロケールに設定

$ sudo update-locale LANG=ja_JP.UTF8

5.日本語変換を利用する設定 fcitxを起動する

$ fcitx-autostart

※fcitx-autostartは自動起動させたいですが、.bashrcなどに書くとX環境を使っていないときに端末が立ち上がらなくなります。
なので、Windows側でVcXsrvを立ち上げた後にコマンドを実行してやります。

6.入力メソッドの追加

下記コマンドを実行して、入力メソッドの設定を開きます。

$ fcitx-config-gtk3

左下の「+」ボタンから、Mozcを追加してください。

f:id:odaryo:20200116160221p:plain
設定するとこうなります。
f:id:odaryo:20200116160224p:plain

試しにエディタを開いて、Ctrl+Spaceキーで日本語が入力できればOKです。
(確認用エディタはplumaを使用してます。)

f:id:odaryo:20200116161037j:plain

7.競合するショートカットキーを変更

※2021/02/16追加

デフォルトの設定ですと、PhpStormのキーボードショートカットと競合する設定がありました。
例えば、設定を開く「Ctrl + Alt + S」が競合するので無効化します。

①下記コマンドから入力メソッドの設定を開きます。

$ fcitx-config-gtk3

「全体の設定」タブをクリックします。

f:id:odaryo:20210216015546p:plain

②「Show Advanced Options」にチェックを入れます。

f:id:odaryo:20210216015343p:plain

下の方にある「すべての設定と入力履歴を保存」のショートカットキーを空にします。
念の為、「Switch Embedded Preedit」も空にしました。

f:id:odaryo:20210216015433p:plain

3.Dockerのインストール

下記手順に従ってDocker, Docker Composeをインストールします。

① Dockerのインストール

公式サイトを参考にインストールします。

$ sudo apt install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo add-apt-repository \
   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
   $(lsb_release -cs) \
   stable"
$ sudo apt update
$ sudo apt install docker-ce docker-ce-cli containerd.io

インストールの確認

$ docker -v
Docker version 19.03.5, build 633a0ea838

このままではroot権限が無いと実行できないため、一般ユーザでも実行できるよう設定します。 (groupはすでに作られていると思いますが、一応実行)

$ sudo groupadd docker
$ sudo usermod -a -G docker <user_id>

WSL2を再起動することで反映されます。
PowerShellで下記コマンドを実行します。

wslconfig /t Ubuntu-20.04

参考:Redirecting…

② Docker Composeのインストール

同様にDocker Composeもインストールします。

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.25.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

インストールの確認

$ docker-compose -v
docker-compose version 1.25.0, build 0a186604

参考:Install Docker Compose | Docker Documentation

補足:dockerデーモンの起動について

WSL2の現バージョンでは、systemdが正しく動かず、デーモンの自動起動が設定できないようです。

WSL2を再起動するたびにdockerデーモンを起動する必要があります。
(インストール直後も起動していないため、下記コマンド実行が必要です)

起動コマンドは下記です。

$ sudo service docker start

4.PhpStormの設定

PhpStormのインストールについて説明します。

① インストール方法

今回はToolboxからインストールしました。

1.下記サイトより、Toolbox AppのLinux版(tar.gz)をダウンロード

www.jetbrains.com

2.下記コマンドを実行してインストール

$ sudo tar -xzf jetbrains-toolbox-*.tar.gz -C /usr/local/bin --strip-components 1

3.Toolbox起動

$ jetbrains-toolbox

VcXsrvを立ち上げているとGUIが起動します。
その後、アプリよりインストールしてください。

② PhpStormの設定

開発言語に合わせて設定してください。

Git、Docker、Node.jsなどはインストール後に設定を開くと自動で認識して設定されます。

また、フォントとして「Ricty Diminished」もインストールしました。

$ sudo apt install fonts-ricty-diminished

5.その他ツールのインストール

Node.js

IDEからLinterツールなどを実行するにはローカルにNode.jsをインストールしていたほうが都合がよいため、インストールします。

nvmからインストールしました。

$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.0/install.sh | bash
$ source $HOME/.bashrc

Node.js(LTS)のインストール

$ nvm install --lts

ついでにyarnもインストール
※指定したnodeのバージョン配下を指定してインストールする

$ node -v
v12.14.1
$ nvm use 12.14.1
$ npm install -g yarn

$ node -v
v12.14.1
$ npm -v
6.13.4
$ yarn -v
1.21.1

Fish Shell

シェルにfishをインストールします。
コマンドやディレクトリ名の補完機能が便利です。

テーマはシンプルな「clearance」に設定しました。

また、aliasなどの設定はbashで設定しているため、.bashrcの末尾に"exec fish"を記載してbash経由で起動しています。

① fishのインストール

インストールは公式の情報を参考にしました。

$ sudo apt-add-repository ppa:fish-shell/release-3
$ sudo apt-get update
$ sudo apt-get install fish

② テーマの変更

テーマやプラグイン管理のツール「fisherman」をインストールします。(参考
テーマはシンプルな「clearance」を選択しました。

$ curl https://git.io/fisher --create-dirs -sLo ~/.config/fish/functions/fisher.fish

以下はfish内で実行。

$ fish
> fisher add oh-my-fish/theme-clearance

※fisherが4系になり、addがinstallに変更になったようです。

addコマンドが聞かない場合はfisher add ....の部分をfisher install ....に置き換えてください。

③ 各種プラグインのインストール

  • bassのインストール
    fishでbashコマンドを使えるようにするためのプラグインです。

> fisher add edc/bass

bashスクリプトも下記のように動かすことができます。

> bass test.sh
> bass source config.sh

  • pecoのインストール

pecoは入力された一覧から絞り込み検索と、選択ができるようになるツールです。(参考)

いろいろな用途があるようですが、今回はhistoryの検索を設定しています。

> sudo apt install peco
> fisher add oh-my-fish/plugin-peco

config.fishに設定を追記する

> cat ~/.config/fish/config.fish
function fish_user_key_bindings
  bind \cr 'peco_select_history (commandline -b)'
end

設定の反映

> source ~/.config/fish/config.fish

使用感について

たまに日本語変換が効かなくなることがありますが、おおむね快適に動作します。
また、Docker for windowsで作業していたときよりもビルド速度が上がっているようなので(体感)、精神的にも安心です。

日本語環境がLinux側にあるためWindows側で登録した辞書が使えなかったり、変換ダイアログがカーソル位置ではなくウィンドウの左下に出ていたりと変換周りの惜しい点はあります。

また、次の2つのコマンドをWSL2起動のたびに実行する必要があるのが難点です。

$ sudo service docker start
$ fcitx-autostart

とはいえ、Windowsの環境に左右されないというのは大きなメリットといえます。

しばらく使ってまた追記します。

終わりに

WSL2を使った開発環境について記載しました。

本物のLinux環境には快適さは及びませんが、Windowsマシンを使う人にとっては環境構築の1選択肢となるのではないでしょうか。