JS/TSに関するドキュメント案

[tyankatsu0105]

JS and TS Coding Guideline

• early return を使う

• enum を使わない

• any を使わない

• ドキュメント的なコメントには JSDoc annotationを使う

  • https://github.com/tyankatsu0105/books/blob/main/%E8%AA%AD%E3%81%BF%E3%82%84%E3%81%99%E3%81%84%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E3%82%AC%E3%82%A4%E3%83%89%E3%83%A9%E3%82%A4%E3%83%B3%20-%E6%8C%81%E7%B6%9A%E5%8F%AF%E8%83%BD%E3%81%AA%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%E9%96%8B%E7%99%BA%E3%81%AE%E3%81%9F%E3%82%81%E3%81%AB.md#%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E7%A8%AE%E9%A1%9E

• TODO や FIXME のようなコメントには具体性をもたせる

• 引数が 2 以上の時にはオブジェクトにする

• 引数には readonly 型を使う

• 適度に抽象的なファイル名を使う

  • 1 ファイル 1 関数にならないように

• 列挙型を考慮するときは取りこぼさない仕組みを使う

  • assertNever みたいなもの

• 特定の機能の返却値を利用するときは ReturnType と typeof を使う

• テンプレートリテラル使う

  • 「+」を使わない

• 基本的に type アサーション使わない

• 変数名省略しない

  • cnt, idex

• forEach, for を極力使わない

  • map, filter, find, reduce, some 等を使えないか検討する

• 二重否定を使わないで良いか検討する

  • 可読性, falsy, truthy の時に意図しない挙動となり得る

• 変数・関数名の prefix にアンダースコアをつけない

  • _hoge
  • private 変数的な思想？？
  • eslint にアンダースコアを使用すると使わなくてもエラー検知しないものと見なされるルールがある

• interface or type を統一する

  • 極力 type を使用する
  • 統一させる意味
  • https://react-typescript-cheatsheet.netlify.app/docs/basic/getting-started/basic_type_example/#types-or-interfaces

• 関数宣言・関数式の統一

  • アローファンクションを基本使う的な
  • 統一させる意味
  • https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Functions

• 戻り値の方は型推論使う 　- 返却値の型を固定したい場合のみ使用する 　- 基本型推論に任せる

• 一関数内に複数責務を持たないようにする 　- 使われる側の事情を含めない 　- ex) オンラインの時は〜　対面の時は〜 など 　- 分割できないか考える

• ファイルの相互参照の禁止

  • 型定義の時
  • Page コンポーネントの型

[toshi-toma]

ts-ignore使わない

[toshi-toma]

日時操作関連はDateオブジェクトではなくdayjs使う