TypeScript のコードスタイル支援

ネーミングスタイル

ReSharper は、コード内のシンボルの希望する命名スタイルを定義、制御、適用できます。一連のルールがあり、各ルールは一連の制約を持つ特定の識別子を対象としています。各ルールには、複合語、アンダースコア、接尾辞、接頭辞などの大文字化を定義する 1 つ以上の関連スタイルを含めることができます。

これらのルールは、ReSharper がコード補完およびコード生成機能を使用して新しいコードを生成し、コードテンプレートを適用し、リファクタリングを実行するときに考慮されます。ReSharper は、命名規則の違反を検出して修正するのにも役立ちます。必要に応じて、命名規則の自動チェックを構成または無効にできます。

命名スタイルの構成と適用の詳細については、ネーミングスタイルを参照してください。

コードフォーマットルールの管理と適用

コードスタイルの重要な側面は、コードのフォーマット方法、つまり、空白、タブ、改行を使用してコード要素を配置する方法、インデントにタブを使用するかどうかと方法、長い行を折り返すかどうかと方法などです。オン。

ReSharper コードフォーマットルールの広範なセットには、デフォルトの Visual Studio フォーマットオプションと多数のベストプラクティスを考慮したデフォルト構成があります。フォーマットルールのすべての詳細を構成し、コードにルールを適用できます。これらのルールは、ReSharper がコード補完およびコード生成機能を備えた新しいコードを生成し、コードテンプレートを適用し、リファクタリングを実行するときに適用されます。フォーマットルールは、現在の選択、現在のファイル、ソリューション全体までのより広い範囲の既存のコードにも適用できます。

ReSharper は、共有設定のメカニズムを使用してフォーマット設定を保存します。コード編集 | TypeScript | スタイルのフォーマットグループのオプションページでフォーマットルールを設定できます。また、EditorConfig および Clang 形式ファイルにフォーマット設定を保存して共有することもできます。

引用スタイル

TypeScript 仕様では、文字列リテラルの処理に一重引用符 (') と二重引用符 (") の両方を使用できます。プロジェクトまたはソリューション内で同じ引用符スタイルに固執することをお勧めします。そのためには、好みの設定を次のように構成できます。ReSharper オプションのコード編集 | TypeScript | 構文スタイルページにある、対応するコードインスペクションの重大度レベルも表示されます。ReSharper は、設定と異なるコードを検出してハイライトします。既存のコードベースでこの設定を適用するには、ビルドされたコードのいずれかを使用してコードクリーンアップを実行します。プロファイルフルクリーンアップまたは再フォーマットして構文スタイルを適用で、または対応するオプションが選択されたカスタムプロファイルを作成して実行します。

この設定は JavaScript の同じ設定と共有されているため、ある言語で変更すると、他の言語の設定も変更されます。

モジュールのインポートスタイル

他のモジュールから型をインポートする方法はいくつかあります。モジュールの別名を追加するか、完全修飾型の名前を使用することができます。ReSharper を使用すると、目的の範囲内で型をインポートするための望ましい方法を適用できます。

必要に応じて、カスタムプロファイルを使用してモジュールインポートスタイルを適用できます。これを行うには、カスタムクリーンアッププロファイルを作成し、TypeScript 固有プロファイル設定の 'インポート' ステートメントを最適化するチェックボックスをオンにします。

参照コメントの最適化

ReSharper は、未使用の参照コメントを検出して削除できます。参照コメントを最適化するには、「フルクリーンアップ」プロファイルを使用して目的のスコープのコードクリーンアップの実行を作成するか、カスタムクリーンアッププロファイルを作成して、TypeScript 固有プロファイル設定の参照コメントを最適化するチェックボックスをオンにします。

終了文

JavaScript/TypeScript では、ステートメントが改行で終わる場合、または中括弧で囲まれたステートメントが 1 つだけある場合、ステートメントを終了するためにセミコロンは必要ありません。ただし、多くの場合、各ステートメントの後にセミコロンを使用することが推奨されます (たとえば、この StackOverflow スレッド(英語)を参照してください)。ReSharper を使用すると、セミコロンを自動的に追加できます。

特定のファイル、プロジェクト、ソリューションのステートメントを終了するには、「フルクリーンアップ」プロファイルまたはステートメントの終了が Javascript/Typescript セクションで選択されているカスタムプロファイルを使用して、目的のスコープでコードクリーンアップを実行します。

修飾子の配置

明示的な「public」修飾子を使用するかどうかを選択する場合は、ReSharper オプションのコード編集 | TypeScript | 構文スタイルページで、対応するコードインスペクションの設定と重大度レベルを構成できます。 ReSharper は、好みとは異なるコードを検出してハイライトします。既存のコードベースでこの設定を適用するには、組み込みプロファイルフルクリーンアップまたは再フォーマットして構文スタイルを適用のいずれかを使用してコードクリーンアップを実行するか、対応するオプションが選択された場所でカスタムプロファイルを作成して実行します。

暗黙的 / 明示的な型指定

TypeScript 仕様では、型に暗黙的または明示的に型を指定したり、型に 'any' キーワードを使用したりできます。ReSharper コードスタイルアシスタントを使用して、タイプを明示的に指定する必要があるかどうか、また暗黙の 'any' を許可するかどうかを定義できます。

好みを指定するには、ReSharper オプションのコード編集 | TypeScript | 構文スタイルページにある型指定グループのコントロールを使用します。

暗黙の「any」を使用することをプロジェクト設定で設定することもできます。暗黙の 'any' タイプがプロジェクト設定で許可されていない場合は、コードスタイルの設定に関係なく、常にエラーとしてハイライトされます。

暗黙的 / 明示的型指定設定を特定のファイル、プロジェクト、ソリューションに適用するには、「完全クリーンアップ」プロファイル、または TypeScript 固有セクションで型アノテーションの存在をコードスタイルと同期させるおよび必要に応じて明示的な「任意の」型アノテーションを追加するチェックボックスが選択されているカスタムプロファイルを使用して、目的のスコープでコードクリーンアップを実行します。

暗黙的 / 明示的なタイプ設定の好みも ReSharper のコードインスペクションによって考慮に入れられています。