Visual Studio Codeでソースコードを自動整形するショートカットキー

Tools
質問する生徒
生徒

ソースコードが汚いと会社の人に怒られます。ソースコードを整形してると時間かかるんですよね。

回答する先生
先生

ソースコードの整形なんて一瞬で終わりますよ。ショートを1個覚えるだけです。

1人でもグループでも開発するのにソースコードが汚いとテンション下がってしまいますよね。

私もVisual Studio Codeとソースコードを自動整形してくれるショートカットキーを知るまで汚いソースコード上等でしたが、今は整理されてないとやる気起きません。

Visual Studio Codeでフォーマッター(formatter)の拡張機能を入れて
shift + option + F
を実行すれば一瞬でどんなに汚いソースコードもきれいに自動整形してくれます。

自動整形前のサンプルソースコード

<!doctype html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
  <title>サンプルタイトル</title>

      <style>
  .header {
    position: fixed;
        top: 0;
    width: 100%;
        height: 50px;
    background-color: rgb(70, 67, 67);
  }

  .main {
         padding-top: 50px;
    overflow: auto;
  }
   
                   .footer {
    position: fixed;
            bottom: 0;
    width: 100%;
                    height: 50px;
                 background-color: rgb(70, 67, 67);
  }
      </style>
</head>
        <body>
  <div class="header">Header</div>
            <div class="main">
    <h1>見出し</h1>
            <p>コンテンツ</p>

  </div>
  <div class="footer">
    <span>Footer</span>
            <a href="#">コピーライトサンプル</a>
  </div>
                  </body>
</html>

違いを分かりやすくするため必要以上にバラバラにしてみました。

自動整形後のサンプルソースコード

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="UTF-8" />
    <title>サンプルタイトル</title>

    <style>
      .header {
        position: fixed;
        top: 0;
        width: 100%;
        height: 50px;
        background-color: rgb(70, 67, 67);
      }

      .main {
        padding-top: 50px;
        overflow: auto;
      }

      .footer {
        position: fixed;
        bottom: 0;
        width: 100%;
        height: 50px;
        background-color: rgb(70, 67, 67);
      }
    </style>
  </head>
  <body>
    <div class="header">Header</div>
    <div class="main">
      <h1>見出し</h1>
      <p>コンテンツ</p>
    </div>
    <div class="footer">
      <span>Footer</span>
      <a href="#">コピーライトサンプル</a>
    </div>
  </body>
</html>

これが一瞬にして自動整形されました。

拡張機能を入れる前にショートカットキーを押しても

フォーマッターをインストールしてください

という注意文が表示されます。

HTML、CSS、PHP、JavaScript、Ruby等、それぞれに対応したフォーマッターの拡張機能をインストールが必要です。

Marketplaceで拡張機能を検索する

と表示されてる検索窓に[formatter]と入力して検索すれば、それぞれに対応したフォーマッターの拡張機能が出てきます。

新規でファイルを開いてるだけの状態だとショートカットキーは実行されませんので、ファイルが存在してる状態で実行してください。

質問する生徒
生徒

ありがとうございます!ソースコードきれいな人はこういう事してたんですね。

回答する先生
先生

ソースコードがきれいなだけで仕事が捗りますから、できる人は自動整形を使ってます。