条目 shell 脚本(开始前端和后端)应该有什么名称?
What name should an entry shell script (that starts frontend and backend) have?
我想知道是否有关于条目名称的约定 shell 脚本。我的意思是 shell 脚本应该是 运行 启动程序(前端和后端)。是否有大多数开发人员都知道的等同于 README.md 的名称?提前致谢!
我不知道有任何广泛的约定。也许 main 在某些上下文中使用,但这并没有说明脚本的作用。然而,我自己的惯例是让入口点源代码文件具有小写名称,而非入口点源代码文件以 PascalCase 编写。同样对于包含多个文件的程序 foo,我的惯例是创建一个名为 foo 的目录并在该目录中创建一个入口点文件也被命名为 foo.
如果这是我喜欢的项目,我会称之为 start.sh
。
但是对于企业项目,通常有一些CI启动项目的机制。
例如,如果您使用 Docker - 您的脚本将存在于 Docker 文件中,而 CI 只会知道它应该使用 Docker文件,否则你必须使用一些配置来指示它。
例如,在 Heroku 上,有一个 Procfile 指定应用程序在启动时执行的命令。
每个 CI 都是不同的,因此不应仅依赖 CI 脚本并期望其他开发人员了解它们。因此,如果我正在处理基于 NodeJS 的项目,我会将我的启动命令放在 package.json
的 scripts
部分并将其命名为 start
。因为这是 NodeJS 世界中众所周知的约定,所以 运行 npm start
.
例如,我可以将我的完整命令放在 package.json
{
"scripts": {
"start": "./node_modules/vader-sentiment-cpython/install_vader.sh && ts-node api.ts"
}
}
然后在我的 Heroku Procfile 中,我将只引用 npm start
,像这样:
web: npm start
一个额外的好处是,因为 npm start
是一个约定,Heroku 将尝试使用它 by default,如果我根本不添加 Procfile。
我想知道是否有关于条目名称的约定 shell 脚本。我的意思是 shell 脚本应该是 运行 启动程序(前端和后端)。是否有大多数开发人员都知道的等同于 README.md 的名称?提前致谢!
我不知道有任何广泛的约定。也许 main 在某些上下文中使用,但这并没有说明脚本的作用。然而,我自己的惯例是让入口点源代码文件具有小写名称,而非入口点源代码文件以 PascalCase 编写。同样对于包含多个文件的程序 foo,我的惯例是创建一个名为 foo 的目录并在该目录中创建一个入口点文件也被命名为 foo.
如果这是我喜欢的项目,我会称之为 start.sh
。
但是对于企业项目,通常有一些CI启动项目的机制。
例如,如果您使用 Docker - 您的脚本将存在于 Docker 文件中,而 CI 只会知道它应该使用 Docker文件,否则你必须使用一些配置来指示它。
例如,在 Heroku 上,有一个 Procfile 指定应用程序在启动时执行的命令。
每个 CI 都是不同的,因此不应仅依赖 CI 脚本并期望其他开发人员了解它们。因此,如果我正在处理基于 NodeJS 的项目,我会将我的启动命令放在 package.json
的 scripts
部分并将其命名为 start
。因为这是 NodeJS 世界中众所周知的约定,所以 运行 npm start
.
例如,我可以将我的完整命令放在 package.json
{
"scripts": {
"start": "./node_modules/vader-sentiment-cpython/install_vader.sh && ts-node api.ts"
}
}
然后在我的 Heroku Procfile 中,我将只引用 npm start
,像这样:
web: npm start
一个额外的好处是,因为 npm start
是一个约定,Heroku 将尝试使用它 by default,如果我根本不添加 Procfile。