Repolode
ryanmcdermott

ryanmcdermott/clean-code-javascript

Robert C. MartinのClean Codeの原則をJavaScriptに適用し、命名、関数、クラス、SOLIDの悪い例・良い例を紹介するガイド。

スター
94,723
フォーク
12,568
未解決の Issue
124
最終コミット
2 年前

これは何?

Robert C. Martinの書籍『Clean Code』にあるソフトウェアエンジニアリングの原則を、JavaScript向けに応用したリポジトリです。正式なスタイルガイドではなく、読みやすく、再利用しやすく、リファクタリングしやすいコードを書くための指針としてまとめられており、各ルールを「Bad」と「Good」のコード例で説明しています。

変数と命名、関数の設計(引数の数、単一責任、副作用やフラグの回避)、オブジェクトとデータ構造、クラス(ES2015のクラス、継承よりコンポジション、メソッドチェーン)、SOLID原則を取り上げています。後半では、テスト、並行処理、エラー処理、フォーマット、コメントにも触れています。

JavaScriptでクリーンコードの習慣を身につけるための具体的なコード例を求める開発者や、チームでのコードレビューの議論の土台として活用したい場合に役立ちます。

主な機能

  • 01各原則について悪いコードと良いコードを比較
  • 02命名、関数、オブジェクト、クラスを網羅
  • 03JavaScriptの例を交えてSOLID原則を解説
  • 04副作用の回避と不変性について解説
  • 05継承よりコンポジションを選ぶべき場面を案内

ユースケース

  • JavaScript開発者としてクリーンコードの習慣を学ぶ
  • チームのコードレビュー指針を作るための資料として活用する
  • レガシーなJavaScriptを、より読みやすくモジュール化されたコードにリファクタリングする

トピック

よくある質問

clean-code-javascript とは?
Robert C. MartinのClean Codeの原則をJavaScriptに適用し、命名、関数、クラス、SOLIDの悪い例・良い例を紹介するガイド。 Robert C. Martinの書籍『Clean Code』にあるソフトウェアエンジニアリングの原則を、JavaScript向けに応用したリポジトリです。正式なスタイルガイドではなく、読みやすく、再利用しやすく、リファクタリングしやすいコードを書くための指針としてまとめられており、各ルールを「Bad」と「Good」のコード例で説明しています。
clean-code-javascript は無料で使えますか?ライセンスは?
clean-code-javascript は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
clean-code-javascript は今もメンテナンスされていますか?
半年以上コミットなし。clean-code-javascript の最終コミットは 2024年7月29日 です。
clean-code-javascript は何に使えますか?
JavaScript開発者としてクリーンコードの習慣を学ぶ チームのコードレビュー指針を作るための資料として活用する レガシーなJavaScriptを、より読みやすくモジュール化されたコードにリファクタリングする
clean-code-javascript はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/ryanmcdermott/clean-code-javascript

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト