DEV Community: birdsea

Windows Terminalを使う

birdsea — Sat, 01 Aug 2020 17:56:48 +0000

Windowsでは今までCLI環境としてコマンドプロンプトとPowerShellが提供されてきましたが、新しいCLI環境としてWindows Terminalが5/20にリリースされました。

Windows Terminalは新しいシェルを提供するわけではなく、Windows Terminalから以下を起動できるようになっています。

コマンドプロンプト
PowerShell
WSL
Azure Cloud Shell

Windows Terminalではこれらを複数のタブやペインに分けて同時に操作が可能です。

今後、CLIでパッケージを管理するWindows Package Managerもリリースされるそうなので、Windows環境でもCLIの開発ツールが大分そろってきたのではないでしょうか。

インストール

Microsoft Store からインストールできます。

インストール直後は、PowerShellがデフォルトで起動するシンプルな感じです。設定をすることで見た目や操作性をカスタマイズできます。

設定を変更してカスタマイズする

Window Terminalでは起動するシェルごとに設定できる動的プロファイルを設定することができます。

メニューから設定を選択するとsettings.jsonがエディタで開きます。
このファイルに設定を書いていきます。

設定は大まかに分けて以下があります。

グローバル設定・・・ Windows Terminal全体の設定
プロファイル設定・・・シェルごとの設定
配色・・・独自の配色の作成
ショートカットキー・・・カスタムキーバインドの作成

細かい設定値についてはリンク先のドキュメントを参照してお好みにカスタマイズしてください。

複数のペインをTerminal起動時に開く

Windows Terminalのプログラム本体wt.exeは引数をサポートしています。
これにより複数のタブやペインをターミナル起動時に立ち上げることができます。

以下は3つのペインを立ち上げる場合のコマンドです。

start wt '-p "プロファイル名1" ; split-pane -p "プロファイル名2" ; split-pane -p "プロファイル名3"'

Powerline をセットアップする

Powerline は、Gitの状態やアイコンをプロンプト表示して見やすくするツールです。

事前準備

Powerlineフォントをインストールする
プロンプトにアイコン（Powerline グリフ）を表示するために、それに対応したフォントをインストールする必要があります。

Windows TerminalではデフォルトでCascadia Monoが使われるようになっていますが、こちらはPowerlineグリフに対応していません。

CascadiaにはPowerlineグリフを含むフォントもあるので、こちらを別途インストールして使うように設定します。
インストール後、ターミナルの設定に以下を追加し、フォントを読み込みます。

    "profiles":
    {
        "defaults":
        {
            ...

            "fontFace": "Cascadia Code PL",
        },

PowerShellでのPowerlineの設定 PowerShell を使用して、以下の２つをインストールします。
- Posh-Git ・・・ Git の状態情報の表示や補完を行う
- Oh-My-Posh ・・・ Powerlineのテーマを提供するライブラリ

Install-Module posh-git -Scope CurrentUser
Install-Module oh-my-posh -Scope CurrentUser

以下にモジュールがインストールされます。

C:\Users\ユーザ\Documents\WindowsPowerShell\Modules

上記モジュールをターミナル（PowerShell）起動時に読み込むための設定を行い、ターミナルを起動するとPowerlineが表示されるようになります。

ファイル：C:\Users\ユーザ\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1

Import-Module posh-git
Import-Module oh-my-posh
Set-Theme <テーマ名>

シェルごとに背景画像を設定する

ターミナルで複数ペインを表示できるようになったので、それぞれを区別しやすいように背景を変えると良いです。

画像は以下に公式のものが公開されています。
気に入ったものをダウンロードして設定ファイルの各プロファイルに画像のパスを紐づけてあげれば、見た目をカスタマイズできます。

Microsoft
https://wallpaperhub.app/
Ubuntu
https://design.ubuntu.com/downloads/

設定ファイル

        "list":
        [
            {
                "guid": "{XXXXXXXX-XXXX-XXXX-XXxX-XXXXXXXXXXXX}",
                "name": "Windows PowerShell",
                "commandline": "powershell.exe",
                "hidden": false,
                "backgroundImageStretchMode": "uniformToFill",
                "backgroundImage": <背景画像のパス>
            },
            {
                "guid": "{XXXXXXXX-XXXX-XXXX-XXxX-XXXXXXXXXXXX}",
                "name": "Ubuntu-18.04",
                "source": "Windows.Terminal.Wsl",
                "hidden": false,
                "backgroundImageStretchMode": "none",
                "backgroundImageAlignment": "bottomRight",
                "backgroundImage":<ロゴ画像のパス>,
                "useAcrylic": false,
            }
        ]
    },
}

Windows Terminalは7月から毎月アップデートされるようで、これからもっと使いやすく改善されていくと思われます。

Linuxのシェルにもこれで直接アクセスできますし、自分用にカスタマイズすることで、より楽しく開発ができるようになると思います。

GitHub Actionsで.NETプロジェクトのフォーマットチェックを行う。

birdsea — Thu, 30 Apr 2020 16:21:04 +0000

GitHubのCI/CD機能、GitHub Actionsが去年11月にリリースされました。

GitHub ActionsはGitHubで公式に用意された環境のため、CircleCIやTravisCIなどの既存のCI/CDサービスがpush時にアクションするよりも広範囲にGitHubのイベントを取得してワークフローを実行することができます。

また、GitHub内でのみ完結するため、GitHubの権限を外に出す必要もありません。
その点もセキュリティ的には良いと思われます。

まだリリースして時間が経っていないというのもあり、公式のテンプレートは色々用意されているもののサンプルの情報は少ないです。

.NET Coreのテンプレートはビルドとテストを実行するものが用意されており、CIでは他にLintチェックやフォーマットチェック等もプッシュ時に行うように自動化していきたいところです。

今回はまず.NETのビルドのテンプレートをもとにフォーマットチェックを行うようにしてみました。

GitHub Actionsの書き方は以下の書籍（2020年4月時点で日本の書籍はこれしかなさそう）を参考に実装しています。

ワークフローを作成する
GitHubのリポジトリのトップ画面のタブからActionsを選択します。

テンプレートから.NET Coreを選択します。

テンプレートで用意された内容は以下です。
.NET Coreのバージョンは3.1です。
GitHub Actionsの定義はymlファイルの形式で記述していきます。
```
name: .NET Core

on:
  push:
    branches: [ master ]
  # pull_request:　　プルリクエスト時の実施は不要なので削除します
    # branches: [ master ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Setup .NET Core
      uses: actions/setup-dotnet@v1
      with:
        dotnet-version: 3.1.101
    - name: Install dependencies
      run: dotnet restore
    - name: Build
      run: dotnet build --configuration Release --no-restore
    - name: Test
      run: dotnet test --no-restore --verbosity normal
```
1行目のname:はワークフローの名前です。
その次のonの後にワークフローを実行させたいGitHubのイベントを記述します。
（ここではプルリクエスト時のワークフロー実行は不要なので削除しています）

その後に、jobが複数定義でき、buildという名前のjobは、runs-on:で指定されたOS環境ubuntu(Linux)で実行されます。（環境にはWindowsやMacを指定することもできます）

1つのjobには複数のstepが指定でき、上記テンプレートでは5つのステップを実施しています。
1. チェックアウト
2. .NET Coreのセットアップ
3. ライブラリのインストール
4. ビルド
5. テスト
これでmasterブランチにpushした際にビルドとテストが実行されます。
ワークフローにフォーマットチェックを追加する
フォーマッタには、dotnet-formatを使用します。
dotnet-formatはEditorConfigに対応してるフォーマッタです。
.editorconfigを.NETプロジェクトにおけばその設定内容でフォーマットしてくれます。
.editorconfigファイルがない場合はデフォルト設定でフォーマットします。

以下をテンプレートに追加します。
```
    - name: Install dotnet format
      run: dotnet tool install -g dotnet-format
    - name: format-check
      run: dotnet format --check --dry-run
```
dotnet-formatのインストールはdotnet toolコマンドを使用します。
フォーマットチェックはdotnet formatコマンドにオプションとして--checkと--dry-runを付与します。

オプションの意味はそれぞれ以下です。
--dry-run：フォーマットを実行しますが、結果を保存しません
--check　：フォーマットが発生した場合に0以外の値を返却します

GitHub Actionではrunで実行したコマンドが0以外の返却値を返すとエラーになります。これにより、フォーマットされていないものがpushされたらエラーとなり、フォーマット漏れを防ぐことができます。

最終的なyamlファイルは以下になりました。
```
name: .NET Core

on:
  push:
    branches: [ master ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Setup .NET Core
      uses: actions/setup-dotnet@v1
      with:
        dotnet-version: 3.1.101
    - name: Install dotnet format
      run: dotnet tool install -g dotnet-format
    - name: format-check
      run: dotnet format --check --dry-run
    - name: Install dependencies
      run: dotnet restore
    - name: Build
      run: dotnet build --configuration Release --no-restore
    - name: Test
      run: dotnet test --no-restore --verbosity normal
```

Windows Subsystem for Linux 2でDocker for WSL2を使う

birdsea — Sat, 04 Apr 2020 11:10:35 +0000

Subsystem for Linux 2（WSL2）はWindowsからLinuxが使える機能です。

2020年4月にリリースされるWindows10 2004から提供される予定です。
もともと2017年にリリースされたWindows 10 Fall Creators UpdateでWSLが提供されてましたが、そちらは本物のLinuxカーネルを使っておらず、実行できるシステムコールが限られてました。

2は本物のLinuxカーネルが動作します。
Dockerも使えるようになります。
これにより今後はWindowsでもLinuxを使用して開発が行いやすくなると思います。

WSL2のインストール

WSL 2 のインストール手順をもとに実施

WSL2に必要な環境条件は以下

Windows 10 builds 18917 or higher

2020/03/20時点でWindows10 builds 18917はWindows Insider Program（slow or fast）に加入しないとアップデートできない。

Windows Insider Programに加入する

Windowsメニューから設定 > 更新とセキュリティ > Windows Insider Programより加入する。

[スロー]か[ファスト]を選択
Windows Updateを実施する
WSL2を有効にする

設定 > アプリ > アプリと機能 > オプションから「Windowsのその他の機能」リンクをクリックする。

以下のチェックをONにする。
- Linux 用 Windows サブシステム
- 仮想マシンプラットフォーム


PowerShellを管理者権限で起動し、以下を実行しても実施できる。
```
> dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
> dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
```
その後、再起動する。
Microsoft StoreからLinuxをインストールする

後述のDocker Desktop for WSL 2が使えるのはUbuntu 18.04 LTSのみの模様。（2020/03/20時点 Storeには「Ubuntu」もあるが、そちらは対応していない）
Ubuntu 18.04 LTSをダウンロードしたら起動する

起動後にインストールが始まり、ユーザ名とパスワードを入力し、ユーザを作成する。

PowerShellを起動する

# インストールしたディストリビューションの一覧を表示する
> wsl -l
Linux 用 Windows サブシステム ディストリビューション:
Ubuntu-18.04 (既定)

# WSLの状態とバージョンを確認する（VERSIONが1はWSLということです）
> wsl -l -v
  NAME            STATE           VERSION
* Ubuntu-18.04    Stopped         1

# Ubuntu-18.04をWSL2用に変換する
> wsl --set-version Ubuntu-18.04 2

# WSL2を標準設定とする
> wsl --set-default-version 2
WSL 2 を実行するには、カーネル コンポーネントの更新が必要です。詳細については https://aka.ms/wsl2kernel を参照してください。

上記のメッセージの通り、WSL 2 Linux カーネルの更新へアクセスし、更新プログラムをインストールする。インストール後、以下を実行する。

# WSL2を標準設定とする
> wsl --set-default-version 2

# WSLの状態とバージョンを確認する
> wsl -l -v
  NAME            STATE           VERSION
* Ubuntu-18.04    Stopped         2

Ubuntuを起動／停止する

# 起動する
> wsl -d Ubuntu-18.04
To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

# フォルダ階層は以下になる
$ /home/user/ ← 登録したLinuxユーザのhome
  /mnt/c ← WindowsのCドライブ
  /mnt/d ← WindowsのDドライブ

# Windowsに戻る
$ exit

これでWindowsからLinuxが使えるようなりました。

WSLはWindowsからシームレスにシェルを使え、VirtualBoxやVMWareのようにOSが起動する時間を待つ必要もありません。

Docker Desktop for Windowsをインストールする

Docker Desktop for Windowsをインストールする
メニューバーにDockerのアイコンが表示されるので、[Settings]を選択する
Settings画面が表示されるので、以下を確認する
- Dockerのステータスがrunningになっていること
- Use the WSL 2 based engineのチェックボックスがONになっていること
また、Resources > WSL INTEGRATIONを選択し、Enable integration with my default WSL distroのチェックボックスがONになっていることを確認する

DockerがWSL2 based engineで起動されていれば、Dockerコマンドを実施すると、上記でインストールしたWSL2のUbuntuにDockerコンテナが作成されるようになる

PorwerShellを起動し、Dockerコマンドを実行することができる。
Ubuntuのほうでもdockerコマンドの実行ができる。

# powershellでdockerコマンドを実行
> docker run hello-world

...

Hello from Docker!
This message shows that your installation appears to be working correctly.

> docker ps -a
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS                      PORTS               NAMES
0629bbd84b50        hello-world         "/hello"            22 seconds ago      Exited (0) 20 seconds ago                       mystifying_almeida

# WSL2に切り替える
> wsl -d Ubuntu-18.04

# Ubuntuでdockerコマンドを実行
$ docker ps -a
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS                      PORTS               NAMES
0629bbd84b50        hello-world         "/hello"            22 seconds ago      Exited (0) 20 seconds ago                       mystifying_almeida

WindowsとUbuntuでコンテナが共有されていることが確認できる。

Docker Desktop for WSL 2を使うと、このようにWindowsからDockerコマンドを実行して、LinuxのDockerコンテナを操作することができます。

2020/04/11追記
~~DockerComposeは、PowerShellからは実行できないようです。（実行してもLinuxのコンテナとならない）。Linuxのほうで実行すればWindowsと共有できそうです。~~

2020/05/11追記
Docker Desktop For Windowsの（Edge版：バーション2.3.0.1）で、WindowsからDockerComposeできるようになりました。

こちらのバージョンではWindows10 Home Editionでも動作するようです。
Docker Desktop for Winodwsのバージョンアップに伴い本記事の内容を修正しました。

2021/03/07追記
Dockerのバージョンアップに伴いStable版に記述を修正しました。