TypeScript コード フォーマッタ
ガイド
TypeScript コード フォーマッタ
TypeScriptプロジェクトは、一貫したフォーマットによって成功も失敗も決まります。チームがセミコロンを使用するかどうか、シングルクォートを好むかダブルクォートを好むか、2スペースまたは4スペースのインデントを使用するかどうかにかかわらず、フォーマッターはそれらのルールをすべてのファイルで一貫して適用する必要があります。このツールは、設定可能なスタイルオプションを使用してTypeScriptコードをクライアントサイドでフォーマットするため、何もインストールせずにプロジェクトの規約に合わせることができます。
TypeScriptコードを貼り付け、スタイル設定を選択して、フォーマットされた出力を即座に取得します。すべてブラウザで実行されます。コードはアップロードまたは保存されません。
使い方
TypeScriptコードを入力エリアに貼り付けるか、組み込みの例を試してください。好みのスタイルを設定します:インデントの種類と幅、セミコロン、クォートスタイル、末尾カンマ、行幅。フォーマットされた出力には、選択した規約が適用されます。結果をコピーするか、.tsファイルとしてダウンロードしてください。
特徴
- 設定可能なインデント – プロジェクトのスタイルに合わせて、スペース2つ、スペース4つ、またはタブを選択します
- セミコロン制御 – チームの好みに基づいてセミコロンを追加または削除します
- 引用スタイル – すべての文字列リテラルでシングルクォートまたはダブルクォートに正規化します
- 末尾カンマオプション – なし、ES5互換、またはすべての末尾カンマ
- 行幅 – 行幅を80、100、または120文字に設定します
- インポートの並べ替え – インポート文を自動的にアルファベット順に並べ替え、整理します
- 型注釈のフォーマット – コロン、ジェネリクス、型パラメータの周りの一貫したスペース
- 構文検証 – 行番号レポートで一般的なエラーを検出します
- コンテキスト認識解析 – フォーマット時に文字列、コメント、テンプレートリテラルを尊重します
- クライアントサイドのみ –コードはブラウザから離れません
このツールを使用するタイミング
ドキュメントに貼り付ける前にTypeScriptスニペットをすばやくフォーマットし直したい場合、チュートリアルやStack Overflowのコードをきれいにしたい場合、コードレビューの前にフォーマットを正規化したい場合、またはプロジェクトの規約で書かれていないコードに一貫したスタイルを適用したい場合に使用してください。セミコロンなしへの切り替えやシングルクォートからダブルクォートへの切り替えなど、スタイルの好みを切り替えるのにも便利です。
よくある質問
-
TypeScriptとJavaScriptのフォーマットの違いは何ですか?
TypeScriptは、型注釈、インターフェース、ジェネリクス、列挙型、その他の型システム機能でJavaScriptを拡張します。TypeScriptフォーマッターは、すべての標準JavaScriptフォーマットに加えて、型注釈のコロン(const x: string)、ジェネリクスの山括弧(Array)、インターフェースと型エイリアスの宣言、列挙型のフォーマットのような型固有の構文を処理する必要があります。標準のJavaScriptフォーマッターは、これらのTypeScript固有の構造を破損または無視する可能性があります。
-
TypeScriptプロジェクトではセミコロンを使用すべきですか、それとも使用しないべきですか?
どちらのアプローチも有効であり、広く使用されています。TypeScript(JavaScriptと同様)には自動セミコロン挿入(ASI)があり、解析時にセミコロンを追加するため、ほとんどの場合省略しても機能します。セミコロンを省略するチームは、コードがきれいになり、キーストロークが少なくなると主張します。セミコロンを含めるチームは、明示性とまれなASIのエッジケースを回避できると主張します。重要なのは一貫性です。1つのスタイルを選択し、プロジェクト全体でそれを強制してください。ほとんどの主要なスタイルガイド(Airbnb、Google)にはセミコロンが含まれていますが、StandardJSは省略しています。
-
TypeScriptでインポート順序が重要なのはなぜですか?
一貫したインポート順序は、コードの可読性を向上させ、マージコンフリクトを減らします。インポートがアルファベット順にソートされ、論理的にグループ化されている(サードパーティパッケージが最初、次に内部モジュール)場合、開発者は特定のインポートをすばやく見つけ、重複を回避できます。順序付けられていないインポートは、不要なgit diffも引き起こします。2人の開発者が異なる位置にインポートを追加すると、実際のコード変更が同一であってもマージコンフリクトが発生します。
-
TypeScriptにおける末尾カンマとは何ですか、またなぜそれを使用するのですか?
末尾カンマは、配列、オブジェクト、関数パラメータ、型パラメータの最後の要素の後に追加されるカンマです。末尾カンマを使用すると、新しいアイテムを追加する際に、変更が1行だけでなく2行(新しい行と前の最後の行へのカンマの追加)になるため、git diffがきれいになります。また、アイテムの並べ替えも容易になります。ES5は配列とオブジェクトで末尾カンマを許可し、ES2017とTypeScriptは関数パラメータでも許可します。
-
TypeScriptプロジェクトではどのくらいの行幅を使用すべきですか?
最も一般的な選択肢は80、100、120文字です。80文字は、ターミナルの幅の制限に由来する従来の標準であり、Prettierのデフォルトのままです。100文字は、TypeScriptの冗長な型注釈を過度の折り返しなしで収容できる、人気のある現代的な妥協点です。120文字は、ワイドモニターではうまく機能しますが、小さい画面やサイドバイサイドのdiffビューでは可読性が低下する可能性があります。チームの典型的な画面設定とコードレビューワークフローに基づいて選択してください。
恵 スコアボードが到着しました!
スコアボード ゲームを追跡する楽しい方法です。すべてのデータはブラウザに保存されます。さらに多くの機能がまもなく登場します!
