コードフォーマッターの役割

コードフォーマッターは、コードの動作を変えずに、一貫したスタイルに書き換えます。各文、ルール、タグをそれぞれ別の行に配置し、ネストされたブロックにインデントを付け、演算子の前後にスペースを入れ、リストの位置をそろえます。そのため、圧縮されたコードや、チャットから貼り付けたコード、急いで書いたコードも読みやすく、比較しやすくなります。チームでフォーマッターを使うと、全員のコードの見た目が統一され、レビューで空白の違いではなく実際の変更を確認できます。

ツールの説明

コードを貼り付けるか入力すると、入力に合わせて整形結果が表示されます。言語を選び、ネストされた行のインデントに2スペース、4スペース、またはタブのどれを使うか選択してください。結果をコピーするか、適切な拡張子のファイルとしてダウンロードできます。

各ツールは名前に記載された言語から始まり、メニューから別の言語に切り替えられます。HTML、CSS、SCSS、Less、JavaScript、TypeScript、Vue、GraphQL、YAML、Markdownは、多くのWebプロジェクトで使われているフォーマッターのPrettierで整形されます。HTMLファイルとVueファイルでは、<style>ブロックと<script>ブロックも整形されます。JavaScriptにはJSXを含めることができ、VueのスクリプトにはTypeScriptを使用できます。

SQLは、各方言のキーワード、演算子、引用符のルールを認識するsql-formatterで整形されます。たとえば、T-SQLの角かっこで囲まれた名前、PostgreSQLの::キャスト、MySQLとMariaDBのバッククォートに対応しています。最適な結果を得るには、データベースで使用している方言を選んでください。また、SELECTやFROMなどのキーワードを大文字、小文字、または入力したとおりの表記にするかも選択できます。

コードを読み取れない場合、たとえば閉じかっこがない場合や文字列が閉じられていない場合は、解析が停止した行と列を含むパーサーのメッセージが表示されます。JSONには専用のツール、JSONフォーマッターがあります。

対応言語

言語 整形ツール 備考
HTML Prettier インラインCSSとJavaScriptを含む
CSS Prettier
SCSS Prettier 波かっこを使うSass
Less Prettier
JavaScript Prettier モダンな構文とJSX
TypeScript Prettier TSXを含む
Vue Prettier 単一ファイルコンポーネント
GraphQL Prettier クエリ、ミューテーション、スキーマ
YAML Prettier YAMLではタブを使えないため、タブはスペースに変換
Markdown Prettier 見出し、リスト、表、強調
SQL sql-formatter 標準SQL
MySQL sql-formatter
MariaDB sql-formatter
PostgreSQL sql-formatter
SQLite sql-formatter
T-SQL sql-formatter Microsoft SQL Server
PL/SQL sql-formatter Oracle
BigQuery sql-formatter Google BigQuery
Snowflake sql-formatter
Redshift sql-formatter Amazon Redshift
Spark SQL sql-formatter Apache SparkとDatabricks

機能

  • 入力中に整形し、左右両側で構文を強調表示
  • Web言語、YAML、Markdown、および主要データベースのSQL方言に対応
  • 2スペース、4スペース、またはタブによるインデント
  • SQLキーワードを大文字、小文字、または変更なしに設定
  • コードが有効でなくなる位置を表示
  • 結果をコピーまたはダウンロード
  • ブラウザー上で動作するため、コードがデバイスの外部に送信されることはありません