Conventions for app.js, index.js, and server.js in node.js?

前端 未结 4 527
-上瘾入骨i
-上瘾入骨i 2021-02-01 14:22

In node.js, it seems I run into the same 3 filenames to describe the main entry point to an app:

  • When using the express-generator package, an
4条回答
  •  青春惊慌失措
    2021-02-01 14:34

    Even though you can call the files anything you want, there's an advantage to calling the entry point index.js or server.js

    Why index.js: When you issue npm init it will set the main entry point of the module to index.js. Some people don't change it, so they end up naming their main entry point index.js. It means there's one less thing to do.

    Why server.js: If your node package is not going to be consumed by another package, but rather is a stand-alone app, then if you call your main entry point server.js, then you can issue npm start and start your app. npm start will run your the server.js file by default. To change this behavior, supply a start script in package.json. If a start script exists, npm start will run that script instead.

    app.js is just a convention -- the only advantage to it is that some IDEs, such as Visual Studio Code will default to app.js as the entry point of a program you debug. That way when using the most common framework, Express, which creates an app.js file, "it just works"

提交回复
热议问题