文件和文件夹的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几年之后，我可以说目录/文件结构没有约定。但是，大多数（专业）快递应用程序都使用类似以下的设置：

/
  /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的解决方案。附近有一个使用此设置的真实示例。

更新（文件名）：

关于文件名最常见的是短的，小写的文件名。如果您的文件只能用两个词来描述，那么大多数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是迄今为止最常见的约定。下划线的唯一用途是用于内部节点程序包，这只是早期的惯例。

没有约定。有一些逻辑结构。

我只能说的一件事：永远不要使用camelCase文件和目录名称。为什么？它可以工作，但在Mac和Windows上，someAction和some action之间没有区别。我遇到了这个问题，而且一次都没有。我需要这样的文件：

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

但是可悲的是，我创建了一个包含小写字母的文件：lib/ishidden.js。它在Mac上对我有用。在我的同事的Mac上运行正常。测试运行没有错误。部署后，我们遇到了一个巨大的错误：

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

哦耶。这是一个Linux系统。因此，camelCase目录结构可能很危险。对于在Windows或Mac上进行开发的同事来说就足够了。

因此，如果需要，请使用下划线（_）或破折号（-）分隔符。

基于“ Google JavaScript样式指南 ”

文件名必须全部小写，并且可以包含下划线（_）或破折号（-），但不能包含其他标点符号。请遵循项目使用的约定。文件名的扩展名必须是.js。

大多数人camelCase在JS中使用。如果您想开源任何东西，我建议您使用这个:-)

Node.js不执行任何文件命名约定（除外index.js）。Java语言通常也不是。您可以在此处找到许多线索，这些线索暗示了camelCase，连字符和下划线，它们中的任何一个都可以很好地工作。因此，取决于您。选择一个并坚持下去。

据我说：对于文件，如果module.exports是一个对象，请使用小写驼峰，我的意思是单例模块。这也适用于JSON文件，因为它们也是单吨形式。如果module.exports返回一个构造函数，其作用类似于类，请使用大写驼峰形式。

对于文件夹，请使用短名称。如果需要多个单词，请使用“-”将其完全小写，以使其在所有平台上均能正常工作。