编辑:检测是否从 git repo 安装包
我没有正确理解这个问题。
以下是我写的东西,但有点离题。
现在,如果您想在从 repo 安装时仅运行 build.js:
repo 中的文件:
.gitignore
.npmignore
ThisIsNpmPackage
build.js
package.json
.gitginore:
ThisIsNpmPackage
.npmignore:
!ThisIsNpmPackage
在 package.json 中:
"scripts": {
"install": "( [ ! -f ./ThisIsNpmPackage ] && [ ! -f ./AlreadyInstalled ] && echo \"\" > ./AlreadyInstalled && npm install . && node ./build.js ) || echo \"SKIP: NON GIT SOURCE\""
}
我们的想法是让文件 ThisIsNpmPackage 在 repo 中可用,但不在 npm 包中。
安装钩子它只是一个检查ThisIsNpmPackage 是否存在的笨拙脚本。如果是,那么我们执行npm install .(这将确保我们有devDependencies。生成文件AlreadyInstalled以防止无限循环
(npm install 会递归调用 install hook)
发布时我会使用 git push 和 npm publish
请注意,npm 发布可以通过 CI 工具 - githooks 自动化
这个带有文件ThisIsNpmPackage 的小技巧使源检测可用。
调用npm install dumb-package的结果:
“跳过:非 GIT 源”
并执行npm install https://github.com/styczynski/dumb-package
文件将被构建
问题
我们在这里面临的主要问题如下:
-
每次都必须做npm publish ...
有时修复一个小错误太痛苦了,然后推送到 repo 并忘记在 npm 上发布。当我在处理一个基于微服务的项目时,该项目有大约 5 个独立的子项目,分为模块,我发现了一个问题,修复了它,却忘记在我必须的每个地方发布,这真的很烦人。
-
不想将lib 推送到 repo 中,因为它来自源代码
-
变基和合并更烦人。
-
不要乱用.gitgnore
哎呀,当您有麻烦的文件必须包含在 repo 中但从不修改它们或有时删除时,我知道这个问题?那只是病态。
编辑:npm 钩子
正如@Roy Tinker 提到的,安装包时存在执行命令的能力。
可以通过 npm hooks 实现。
"install": "npm run build"
然后我们执行:
npm install https://github.com/<user>/<package>
编辑:
来自 cmets 的 OP 问题:
但这将为从 npm 下载模块的每个人运行安装,对吗?鉴于不会为从 npm 下载模块的任何人安装开发依赖项,因此这是一个很大的问题。不会安装用于构建应用程序的库 - babel 等。
注意:但是如果你想要一个特定版本的包(生产/开发),无论是否有开发依赖,你都可以通过以下方式安装它:
npm install --only=dev
--only={prod[uction]|dev[elopment]} 参数将导致仅安装 devDependencies 或仅安装非 devDependencies,而不管 NODE_ENV。
在我看来,更好的解决方案是使用:
npm install <git remote url>
然后在 package.json 中指定:
"scripts": {
"prepare": "npm run build"
}
如果正在安装的包包含一个准备脚本,它的依赖项和devDependencies将被安装,准备脚本将在包被打包和安装之前运行。
例子:
npm install git+https://isaacs@github.com/npm/npm.git
阅读 npm 文档:npm install
编辑:代理模块(高级技术)
这是一种不好的做法,但很高兴知道。
有时(如 Electron 框架,您需要根据各种情况安装其他外部包或资源/模块)。
在这些情况下使用代理思想:
- 您制作了一个行为类似于安装程序的模块,并根据您的需要安装所有内容
在您的情况下,准备脚本就足够了,但我保留此选项,因为它有时可能会有所帮助。
这个想法是你编写一个模块并为它编写一个安装kook:
"scripts": {
"install": "<do the install>"
}
在这种情况下你可以放在那里:
npm install . && npm run build
无论如何都会安装所有 devDependencies(如前面提到的准备案例),但这有点黑客攻击。
如果你想在那里进行真正的黑客攻击:
"scripts": {
"install": "curl -L -J -O \"<some_url>\""
}
使用 -nix 命令手动下载文件curl
应该避免这种情况,但如果模块的每个平台都有大量二进制文件并且您不想全部安装它们,这是一个选项。
就像 Electron 你已经编译了二进制文件(每个用于单独的平台)
所以你希望人们制作 install package 而不是 install package-linux 或 package-window 等。
所以您在package.json 中提供自定义install 脚本
{
...
"scripts": {
"install": "node ./install_platform_dep.js"
}
}
然后在安装module 时会执行install_platform_dep.js 脚本。里面install_platform_dep.js你放:
// For Windows...
if(process.platform === 'win32') {
// Trigger Windows module installation
exec('npm install fancy-module-windows', (err, stdout, stderr) => {
// Some error handling...
}
} else if ... // Process other OS'es
而这以纯手动方式安装一切。
注意:再一次,这种方法可用于依赖于平台的模块,如果你使用它,它可能是你的代码的设计问题。
基于 CI 构建
我想到的是我真正使用了很长时间的解决方案(使用 CI 服务自动构建)。
大多数 CI 服务的主要目的是在推送到分支或对 repo 执行其他操作时测试/构建/发布您的代码。
这个想法是您提供设置文件(如 travis.yml 或 .gitlab-ci.yml),其余的由工具来处理。
如果您真的不想将 lib 包含到项目中,请相信 CI 可以完成所有工作:
- Githook 将在提交时触发构建(在分支或任何其他位置 - 这只是配置问题)
- CI 将构建您的文件,然后将它们传递到测试阶段并发布
现在我正在 Gitlab 在我自己的项目上工作(作为爱好的一部分)一些网页。构建项目的 Gitlab 配置如下所示:
image: tetraweb/php
cache:
untracked: true
paths:
- public_html/
- node_modules/
before_script:
- apt-get update
stages:
- build
- test
- deploy
build_product:
stage: build
script:
- npm run test
build_product:
stage: build
script:
- npm run build
deploy_product:
stage: deploy
script:
- npm run deploy
当我合并到主分支时,会发生以下事件:
- CI 运行
build 阶段
- 如果构建成功,则启动
test 阶段
- 如果
test 阶段正常,那么最终会触发deploy 阶段
脚本是要执行的unix命令列表。
您可以在配置中指定任何 Docker 映像,因此实际上可以使用您想要的任何 Unix 版本以及一些(或不)预安装的工具。
有一个包 deploy-to-git 将人工制品部署到所需的 repo 分支。
或者在这里(对于 Travis CI)将工件发布到 repo 的配置片段:
travis-publish-to-git
(我自己用过)
那么,当然可以让 CI 运行:
npm publish .
因为 CI 执行 Unix 命令,所以它可以(至少有一堆 CI 提供者):
- 发布标签(可能是发布标签?)
- 触发脚本以更新所有自述文件和任何地方的项目版本
- 如果所有阶段均成功,则向您发送通知
那么我该怎么做:
我承诺、推动并让工具做我想做的一切。
在此期间,我进行了其他更改,并在 1 到 10 分钟后通过邮件收到更新报告。
那里有很多 CI 提供者:
这里附上我另一个项目的另一个例子(.travis.yml):
language: generic
install:
- npm install
script:
- chmod u+x ./utest.sh
- chmod u+x ./self_test/autodetection_cli/someprogram.sh
- cd self_test && bash ../utest.sh --ttools stime --tno-spinner
如果你设置 CI 来推送和发布你的包,你总是可以确保使用最新的尖端版本的代码,而不必担心 我现在也必须运行这个命令...... 问题。
我建议您选择其中一家 CI 提供商。
最好的为您提供数百种能力!
当您习惯自动执行发布、测试和构建阶段时,您会发现它对享受生活有何帮助!
然后用自动脚本启动另一个项目,只需复制配置!
总结
在我看来 npm prepare script 是一种选择。
您也可以尝试其他人。
所描述的每种方法都有其缺点,可以根据您想要实现的目标来使用。
我只是想提供一些替代方案,希望其中一些适合您的问题!