ESLintにおけるCamelCaseルール：詳細ガイド

ESLintのcamelcaseルールは、変数、関数、プロパティなどの識別子の命名規則をCamelCaseに準拠させるためのものです。CamelCaseとは、最初の単語を除き、単語の各先頭文字を大文字にする命名規則です。例えば、myVariableNameやisUserLoggedInなどがCamelCaseの例です。

このルールは、コードの可読性と一貫性を向上させるために役立ちます。CamelCaseを使用することで、コードを読む人が変数の目的をより簡単に理解できるようになります。また、異なる開発者間でコードを共有する場合にも、一貫した命名規則を使用することで、コードをより簡単に理解し、保守することができます。

ルールの構成

camelcaseルールは、以下のオプションで構成できます。

"error": 違反をエラーとして報告します。
"off": ルールを無効にします。

デフォルトでは、このルールは "error" に設定されています。

オプション

このルールには、以下のオプションを使用できます。

"ignoreGlobals": グローバル変数と関数を無視します。
"ignoreImports": インポートされた変数と関数を無視します。
"properties": オブジェクトのプロパティの命名規則を指定します。
"ignoreDestructuring": 構造代入の際に無視します。
"allow": ["exceptions", ...]: 例外を許可します。

例

以下の例は、camelcaseルールを "error" に設定し、ignoreGlobalsオプションを true に設定した場合のものです。

// 違反
var my_variable = 10;

// 違反しない
globalVariable = 20;

以下の例は、camelcaseルールを "warn" に設定し、propertiesオプションを使用して、オブジェクトのプロパティ名を小文字のアンダースコア区切りにすることを許可した場合のものです。

// 警告
var myObject = {
  my_property: 10
};

// 警告しない
var anotherObject = {
  myProperty: 20
};

違反例

// 変数名にアンダースコアが使われている
var my_variable = 10;

// 関数名が小文字で始まっている
function isUserLoggedIn() {
  return true;
}

// オブジェクトのプロパティ名が小文字アンダースコア区切りになっている
var myObject = {
  my_property: 10
};

準拠例

以下のコードは、camelcaseルールに準拠しています。

// 変数名がキャメルケースになっている
var myVariable = 10;

// 関数名がキャメルケースになっている
function isUserLoggedIn() {
  return true;
}

// オブジェクトのプロパティ名がキャメルケースになっている
var myObject = {
  myProperty: 10
};

オプションの使用例

以下のコードは、ignoreGlobalsオプションを使用して、グローバル変数 myGlobalVariable を無視するように設定しています。

// グローバル変数は無視される
var my_variable = 10;
myGlobalVariable = 20;

以下のコードは、propertiesオプションを使用して、オブジェクトのプロパティ名を小文字アンダースコア区切りにすることを許可するように設定しています。

// オブジェクトのプロパティ名が小文字アンダースコア区切りになっている
var myObject = {
  my_property: 10
};

CamelCaseの代替方法

スネークケース（snake_case）

スネークケースは、すべての単語を小文字にし、アンダースコア（_）で区切る命名規則です。CamelCaseよりも可読性が高く、特に長い名前の場合に有効です。

例：

my_variable
is_user_logged_in
my_object_property

パスカルケース（PascalCase）

パスカルケースは、最初の単語を含むすべての単語の最初の文字を大文字にする命名規則です。CamelCaseに似ていますが、より形式的な印象を与えます。

MyVariable
IsUserLoggedIn
MyObjectProperty

ケバブケース（kebab-case）

ケバブケースは、すべての単語を小文字にし、ハイフン（-）で区切る命名規則です。URLやファイル名などに適しています。

my-variable
is-user-logged-in
my-object-property

上記以外にも、様々な命名規則があります。例えば、匈牙利記法や頭字語などがあります。

選択の指針

どの命名規則を選択するかは、プロジェクトのスタイルガイドやチームの慣習によって異なります。一般的には、可読性と一貫性を考慮して、プロジェクト内で統一された命名規則を使用することが重要です。

以下の点を考慮して、適切な命名規則を選択してください。

プロジェクトの種類
ターゲットオーディエンス
チームの慣習
可読性
一貫性