コードを記述する際に特定のスタイルに従うことで、ソースコードの一貫性が増し、可読性の向上などに繋がります。

この章では、Denoでコードを記述する際のスタイルについて解説します。

Denoのスタイルってなに?

この本では、以下の基準を満たすスタイルを仮に「Denoのスタイル」として定義します。^[1]

• deno lintとdeno fmtが課すスタイル
• Deno Style Guideで提示されている命名などに関するスタイル

deno lintとdeno fmtについて

Denoにはリンタ(deno lint)とフォーマッタ(deno fmt)が標準搭載されています。

これらのツールはRustで実装されており、とても高速に動作します。

Deno本体に組み込まれているツールということもあり、Denoでアプリケーションやモジュールなどを開発する際は、これらのツールが課すスタイルに従うとよいでしょう。^[2]

また、CIをセットアップし、これらの実行を自動化するとよいでしょう。

詳しくはCIをセットアップしようを参照ください。

Deno Style Guide

Deno Style Guideとは、Denoの標準ライブラリであるdeno_stdや多くのサードパーティモジュールが従っているスタイルです。

ファイルや関数などの命名については、このスタイルに従うとよいでしょう。

ファイルの命名形式

• ファイルはスネークケース形式で命名する。(例: api-client.tsではなくapi_client.tsと命名する)
• モジュールのエントリポイント^[3]はmod.tsと命名する

コメント

コメントについては、以下の理由からJSDoc形式で記述するとよいです。

• Denoに付属しているdeno docコマンドは、JSDocコメントの内容を元にAPIドキュメントを生成してくれます。
• TypeScriptは一部のJSDocの構文をサポートしています。

ポイント

• deno lintとdeno fmtが課すスタイルに従おう。
• ファイルや関数などの命名形式はDeno Style Guideに従おう。

脚注

1. 「Denoのスタイル」というのはこの本の造語であり、正式なものではありません。筆者が観測している限りでは、多くのサードパーティモジュールで同様のスタイルが採用されており、これに従っておけば命名方式などの一貫性を保ちやすくてよいのではないか？というのが、このスタイルの根拠になってます。 ↩︎

2. これらのコマンドの使い方については、付録: チートシートを参照ください。 ↩︎

3. Node.jsにおけるindex.jsに相当するファイルのことです。 ↩︎