node.js - What naming conventions exist for the primary Node.js file?

Question

This question has been completely edited in hopes that it will be reopened.

The naming of the main Node.js file is something left to the user and and does not seem to be defined by any well established convention. In hopes of finding a good name, I am curious if there are naming conventions in other parts of the Node.js ecosystem that might suggest a name to use.

Some names I have seen are: app.js, index.js, main.js, server.js, etc.

Please provide only well documented standards in answers.

Answer 1

NPM 似乎提出了一种标准，可以package.json像这样在文件中定义主文件：

"scripts": {"start": "node server.js"}

如果未设置此类属性，NPMserver.js会在包的根目录中查找文件。如果server.js存在，它将与 Node.js 一起运行。

这个默认值似乎强烈建议名称server.js应该是标准。

Answer 2

index.js在 Node.js 中有一个特殊的用法。来自模块文档。

...

如果目录中没有 package.json 文件，则 node 将尝试从该目录加载 index.js 或 index.node 文件。例如，如果上例中没有 package.json 文件，则 require('./some-library') 将尝试加载：

./some-library/index.js

./some-library/index.node

我更喜欢使用app.js甚至main.js

Answer 3

两个主要的文件名是“app.js”和“server.js”。最好使用“server.js”。这适用于 nodejs应用程序。对于库，大多数库使用“index.js”并在 package.json 文件的“主”参数中指定它。

Answer 4

据我所见，app.js 是最被普遍接受的。

我个人更喜欢 server.js，但这可能是有偏见的，因为我运行了一个庞大的单页应用程序，所以我的所有文件都是.... javascript .....而且我的前端有一个 app.js 控制器。所以它帮助我区分两者。

你知道成熟的公约是如何开始的吗？你做出了一个合乎逻辑的决定，并以坚定的把握直截了当地做出决定——然后其他人就会效仿。显然没有完善的惯例，所以选择一个并告诉其他人。