メインコンテンツへスキップ

フォルダ/ファイル命名規則


1.基本方針

既存の思想等を参考にする場合は、それに準じた名称にする。

ツールを使う場合は、それに準じた名称にする。

これは命名規則です。既存の名前を制限するものではありません。


2.フォルダの命名規則

形式

「Xxxxxx」
位置 決まり
1桁目 英字大文字
2桁目以降 英字小文字

使用禁止記号・形式

  • 複数単語をつなぐ目的で使われるスネークケース(snake_case), ケバブケース(kebab-case), キャメルケース(camelCase)などは、本来の意味を読み取りづらくする恐れがある。特に安易な命名の温床になりやすく、冗長になりがちであるため禁止とする。 また、フォルダ構成においては、階層化(下位フォルダへの分割)で意味を分ける手段があり、複雑な単語の結合は不要と判断している。
  • ローカルを意図した、先頭への'_'(アンダーバー)の付与は禁止です。フォルダでなく、ファイルに付与して下さい。

命名の考慮点

  • そのフォルダの意味を表す英字の名称を用いる。(英単語を推奨)
  • 出来れば纏まりの中で一意となる事が望ましい。フォルダの配置の変更や名前空間を考慮しての事なので、それほど重要視する必要はない。尚、次の所属に関わる事ですが、一意でないと区別が出来なくなります。
  • そのフォルダの所属(どのフォルダの下位か)を表すような名称にはしない。所属は配置で表せばよく、名前空間などで所属等を表したい時はそこでその様に名付ければよい。(それぞれの命名規則に従う必要はあります。)
  • 成果物の出力先と置き場は分ける方が安全です。ツールによっては、フォルダごと上書きする物もあります。命名も注意しましょう。
  • 詳細はフォルダ内のREADMEファイルを見れば分かるようにすれば良いので、簡素な名称にする。

3.ファイルの命名規則

汎用ファイルの名前

index, README など、一般的にファイル名として意味のある物はそのまま付ける。 特別な命名規則を適用せず、一般慣習に従います。 これらは認識性とツール連携を重視するためです。 そのため、用途, 意味も一般慣習に合わせるので、拡大解釈に注意して下さい。

処理ファイルの名前

以下のファイルは、以下の名前とします。

  • _common: 内部共通処理用(フォルダ内)の機能を集めたファイル
  • _batch: 一括処理用の機能を集めたファイル

コンテンツファイルの名前

「_xxxxxnn」
位置 決まり
先頭 '_'(アンダーバー)を付ける。
1桁目以降 英字小文字。ページ名(エントリーポイントファイル名)
末尾2桁 通番。意味付けは自由。末尾を表す意味もあるので、省略は不可。

例: _namingfolder01.pug

文書ファイルの名前

スネークケース(snake_case) を採用する。ただし'_'(アンダーバー)での接続は1つだけとする。

例: naming.md, naming_folder.md, naming_folderfile.md (X: naming_folder_file.md, _naming.md)

データファイルの名前

スネークケース(snake_case) を採用する。これはデータ自身に説明を含めるのが困難な場面が容易に想像できるため、ファイル名で詳しく分かる必要があるとの判断です。 尚、英字小文字だけでなく数字の使用も自由です。

Pug, Sass などの言語形式でデータを保持する場合は、ファイル名にその旨分かるように命名する。 下記での接頭辞がない言語形式のファイルならデータであろうという推測も一応は出来ます。

その他の一般の命名パターンとその意味分解

「_risyuglxxxxxnnn」
部分 意味 備考
_ 部品を示す接頭辞 Sassのパーシャル意識。通常はアンダースコアで始める。エントリーファイルなどは付与しない。
risyu 固有接頭辞 外部ファイルとの識別に使う。一意であれば変更可。
gl 所属接頭辞 プロジェクト内での所属フォルダを識別する。フォルダ区分。
xxxxx 内容名 機能や用途を示す短い英字小文字。アンダーバーやハイフンは禁止。
nnn バージョン番号 原則 000 固定。変更する場合は手動管理。意味付けは自由。末尾を表す意味もあるので、省略は不可。
  • _: 部品の様な物は、先頭に'_'(アンダーバー)を付ける。 Sassのコンパイル対象外「パーシャル」の機能を意識して、後に参考にして他にも広げた規則です。
  • risyu: 外部のファイルとの識別用です。
  • gl: フォルダ区分を小文字で記しています。フォルダ区分はフォルダごと割り振られ、それによりどのフォルダか分かる様にしています。(プロジェクトで一意) 例示のglは、共通メンバのフォルダを表します。主にコンパイルエラーでのメッセージを読むのに役立ちます。
  • xxxxx: そのファイルの意味を表す英字の名称を用いる。この部分は英字の小文字で、'-'(ハイフン) '_'(アンダーバー) などの使用は禁止です。文字数は任意ですが、短すぎず長すぎずを心がけたいです。
  • nnn: この部分はバージョン管理用の数字です。実際にはバージョン管理は面倒なので、000の固定になると思います。 末尾を表す意味もあるので、省略は不可です。
    末尾を表す必要があるのと、拡張性を担保しないと、この規則が守れないという考えで末尾3桁の数字の部分を用意しています。
  • ファイルのフィルタリング等も意識して、命名しましょう。

ファイル名での使用禁止記号・形式

  • 複数単語をつなぐ目的で使われるスネークケース(snake_case), ケバブケース(kebab-case), キャメルケース(camelCase)などは、本来の意味を読み取りづらくする恐れがある。特に安易な命名の温床になりやすく、冗長になりがちであるため禁止とする。 文書ファイルの名前で例外として、単語は2つまでの限定としてスネークケース(snake_case) を採用しています。
  • 文書ファイルが例外の理由は、そこに「所属接頭辞」を用いていないからです。

4.特別な末尾2桁の付与(任意)

「XxxxxxSV」 「_risyuglxxxxxnnnSV」 「indexSV」

※ 以下は例示ではなく、決まり事です。付与の有無は任意だが、内容は決められたものだけです。 必要に応じて決まり事の追加は可能ですが、それは規約を改定するという事です。当然、他の規約の制約を受けます。

  • 'SV': 変更の為に、元の内容を保持する。最終的には外部に移動か破棄する。

    FolderSV/ が存在する時には、Folder/ も必ず存在していなければなりません。つまり FolderSV/ は、ある時点の Folder/ を複写したものです。

  • 'WK': 検証で当該フォルダ, ファイルを一時的に無効にする為に付与する。最終的には取って元に戻す。

    FolderWK/ が存在する時には、Folder/ は存在してはなりません。つまり FolderWK/ は、Folder/ をリネームしたものです。

  • 'XX': 廃棄予定のフォルダ, ファイルに付与する。本当に廃棄して問題ないか確認するまでの仮の処置です。最終的には元に戻すか破棄する。

    FolderXX/ が存在する時には、Folder/ は存在してはなりません。つまり FolderXX/ は、Folder/ をリネームしたものです。

現時点では、上記の3つだけに限定しています。これは安易なファイルのコピーによる増加を防ぐためです。 尚、セーブや履歴管理は、別途に行ってください。別ファルダの用意やツールの導入でないと、管理が煩雑になります。