ファイルとフォルダーのNode.jsプロジェクトの命名規則

大規模なNode.jsプロジェクト内のファイルとフォルダーの命名規則は何ですか？

大文字にするか、キャメルケースにするか、アンダースコアにするか？

つまり。これは有効と見なされますか？

project-name
    app
        controllers
            someThings.js
            users.js
        models
                someThing.js
                user.js
        views
            some-things
                index.jade
            users
                logIn.jade
                signUp.jade
    ...

nodeを使って数年が経ちましたが、ディレクトリ/ファイル構造には慣例がないと言えます。ただし、ほとんどの（プロフェッショナル）Expressアプリケーションは次のような設定を使用します。

/
  /bin - scripts, helpers, binaries
  /lib - your application
  /config - your configuration
  /public - your public files
  /test - your tests

この設定を使用する例はnodejs-starterです。

私はこの設定を個人的に次のように変更しました：

/
  /etc - contains configuration
  /app - front-end javascript files
    /config - loads config
    /models - loads models
  /bin - helper scripts
  /lib - back-end express files
    /config - loads config to app.settings
    /models - loads mongoose models
    /routes - sets up app.get('..')...
  /srv - contains public files
  /usr - contains templates
  /test - contains test files

私の意見では、後者はUnixスタイルのディレクトリ構造とよく一致します（一方、前者はこれを少し混ぜます）。

また、ファイルを分離するためにこのパターンが好きです。

lib / index.js

var http = require('http');
var express = require('express');

var app = express();

app.server = http.createServer(app);

require('./config')(app);

require('./models')(app);

require('./routes')(app);

app.server.listen(app.settings.port);

module.exports = app;

lib / static / index.js

var express = require('express');

module.exports = function(app) {

  app.use(express.static(app.settings.static.path));

};

これにより、依存関係を気にすることなく、すべてのソースコードをきれいに分離できます。厄介なJavascriptと戦うための本当に良い解決策です。この設定を使用する実際の例が近くにあります。

更新（ファイル名）：

最も一般についてのファイル名は短く、小文字のファイル名。ファイルを2語でしか記述できない場合、ほとんどのJavaScriptプロジェクトでは、区切り文字としてアンダースコアを使用します。

更新（変数）：

変数に関しては、ファイル名と同じ「ルール」が適用されます。ただし、プロトタイプまたはクラスはcamelCaseを使用する必要があります。

更新（スタイルガイド）：

• https://github.com/feross/standard
• https://github.com/airbnb/javascript

kebab-caseすべてのパッケージ、フォルダ、ファイル名に使用します。

どうして？

いずれかのフォルダまたはファイルがいつか独自のパッケージに抽出される可能性があることを想像する必要があります。パッケージに大文字を含めることはできません。

新しいパッケージの名前に大文字を含めることはできません。 https://docs.npmjs.com/files/package.json#name

したがって、camelCase使用しないでください。この葉snake_caseとkebab-case。

kebab-case今日、これは最も一般的な慣例です。アンダースコアの唯一の使用は内部ノードパッケージであり、これは単に初期の頃からの慣習です。

規約はありません。いくつかの論理構造があります。

私が言える唯一のことは、キャメルケースのファイル名とディレクトリ名を使用しないことです。どうして？動作しますが、MacとWindowsではsomeActionとsome actionに違いはありません。私はこの問題に遭遇しました。次のようなファイルが必要です。

var isHidden = require('./lib/isHidden');

しかし、残念なことに、私は小文字でいっぱいのファイルを作成しましたlib/ishidden.js。Macで動作しました。私の同僚のMacでも問題なく動作しました。テストはエラーなしで実行されます。デプロイ後、大きなエラーが発生しました：

Error: Cannot find module './lib/isHidden'

そうそう。これはLinuxボックスです。したがって、キャメルケースのディレクトリ構造は危険な場合があります。WindowsまたはMacで開発している同僚には十分です。

したがって、必要に応じて、アンダースコア（_）またはダッシュ（-）の区切り文字を使用してください。

「Google JavaScript Style Guide」に基づいています

ファイル名はすべて小文字でなければならず、アンダースコア（_）またはダッシュ（-）を含めることができますが、句読点を追加することはできません。プロジェクトが使用する規則に従います。ファイル名の拡張子は.jsでなければなりません。

ほとんどの人camelCaseはJSで使用します。何かをオープンソース化したいなら、これを使うことをお勧めします:-)

Node.jsは、ファイルの命名規則を適用しません（を除くindex.js）。また、JavaScript言語は一般的にもそうではありません。キャメルケース、ハイフン、アンダースコアを示唆する数十のスレッドをここで見つけることができます。だからあなた次第です。1つを選択し、それを使用してください。

私によると：ファイルの場合、module.exportsがオブジェクトの場合はキャメルの小文字を使用します。つまり、シングルトンモジュールです。単一のトンであるので、これはJSONファイルにも当てはまります。module.exportsがクラスのように機能するコンストラクタ関数を返す場合は、キャメル大文字を使用します。

フォルダには短い名前を使用します。複数の単語が必要な場合は、「-」で区切って完全に小文字にし、すべてのプラットフォームで一貫して機能するようにします。