Naming Conventions : E2E
命名規則を考えるにあたって以下のサイトを参考にしました。
- Naming conventions | The University of Edinburgh
- Best practices for file naming | Stanford Libraries
- キャメルケースよりスネークケースで。 - 偏見プログラマの語り！
- 変数名の命名規則/＊＊ケースの使い分け - Qiita
Naming conventions ではファイル命名についての規則を紹介しています。
この中から基本に使えそうな部分を抜粋しました。
-
ファイル名は意味を十分にもたせて、且つ短くする
-
冗長なファイル名及びファイルパスを避ける
-
- : \ / < > | " ? [ ] ; = + & $ , .などを含めない
単語をつなぐ方法
どう単語同士を結びつけるのか
- camelCase
camelCase
firstIssue
- snake_case
snake_case
second-issue
単語の順番
どの順番で記述するのか
1. issue番号 動詞 名詞
2. issue番号 画面番号 動詞 名詞
組み合わせ
どの規則で組み合わせるのか
1. snake_case: 番号 動詞 名詞 ( issueNum_Verb_Noun Style)
Style: {issueNum}_{Verb}_{Noun}.spec.js
Ex : 1234_check_position.spec.js
2. camalCase: 番号 動詞 名詞 ( issueNumVerbNoun Style)
Style: {issueNum}{Verb}{Noun}.spec.js
Ex : 1234CheckPosition.spec.js
3. snake_case: issue番号 画面番号 動詞 名詞 ( issueNum_ScreenNum_Verb_Noun Style)
Style: {issueNum}_{Verb}_{Noun}.spec.js
Ex : 1234_ABC-5_check_position.spec.js
4. camalCase: issue番号 画面番号 動詞 名詞 ( issueNumScreenNumVerbNoun Style)
Style: {issueNum}{Verb}{Noun}.spec.js
Ex : 1234ABC-5CheckPosition.spec.js