JS 中怎么用 npm 钩子脚本(preinstall / postinstall)执行自定义逻辑

胖辰吖_8549

胖辰吖_8549

2026-10-13

960人浏览

原创

preinstall 在 npm install 开始前执行,仅限根目录全量安装时触发,用于环境校验;postinstall 在所有依赖写入 node_modules 后运行,常用于构建或生成资源,但存在供应链安全风险。

js 中怎么用 npm 钩子脚本(preinstall / postinstall)执行自定义逻辑

在 npm 包的生命周期中,preinstall 和 postinstall 是两个常用的钩子脚本(npm lifecycle scripts),它们会在 npm install 执行前后自动触发,适合用来做依赖安装前的校验、环境检查,或安装后的构建、资源生成等操作。

preinstall:安装前执行,常用于校验或清理

preinstall 在 npm install 开始解析和下载依赖之前运行。注意:它 不会 在 npm install <pkg></pkg>(安装单个包)时触发,只在项目根目录执行 npm install(即安装 package.json 中所有依赖)时生效。

  • 适合做 Node.js 版本检查、权限验证、临时文件清理
  • 若脚本退出码非 0(如 process.exit(1)),整个 npm install 会中止
  • 不建议在此阶段执行耗时构建或网络请求,会影响安装体验

示例:在 package.json 中添加:

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
"scripts": {
  "preinstall": "node check-node-version.js"
}

postinstall:安装后执行,最常用也最需谨慎

postinstall 在所有依赖安装完成(包括 node_modules 写入完毕)后运行。它在以下场景都会触发:
– 本地执行 npm install
– CI/CD 构建时拉取依赖后
– 甚至别人 npm install your-pkg 时也会执行(⚠️关键风险点)

  • 常见用途:自动生成类型声明(tsc --emitDeclarationOnly)、编译 TS、复制 assets、生成配置文件
  • 务必避免副作用操作(如修改全局配置、弹窗、发请求),尤其不要在发布到 npm 的包里用 postinstall 下载二进制或调用外部服务
  • 如果只是给项目自身用,可加条件判断:"postinstall": "if [ -f tsconfig.json ]; then tsc; fi"(Shell)或用 cross-env + node 脚本更可靠

如何写一个安全可靠的钩子脚本

  • 用独立的 .js 文件(如 scripts/postinstall.js),比内联命令更易维护、调试和跨平台
  • 开头加 #!/usr/bin/env node 并设可执行权限(Linux/macOS),或统一通过 node xxx.js 调用
  • 捕获异常并显式退出:process.exit(0) 表示成功,非零值表示失败
  • 区分开发 vs 生产环境:可通过 process.env.NODE_ENV 或 npm_lifecycle_event 判断当前是 install 还是 ci
  • 避免硬编码路径,用 path.join(__dirname, '..') 或 process.cwd() 定位项目根目录

替代方案:什么时候不该用 pre/postinstall

这些钩子不是万能的。以下情况建议换方式:

  • 只想在 CI 或特定机器上运行?→ 改用 CI 配置(如 GitHub Actions 的 steps)
  • 需要确保某命令总在启动前运行?→ 改用 start 脚本组合:"start": "npm run build && node server.js"
  • 要为库用户屏蔽构建细节?→ 提前构建好再发布,或用 prepare(仅在 npm publish 前运行,不影响下游安装)
  • 需要跨平台兼容性极强?→ 避免 shell 内联命令,优先选纯 JS 脚本 + execa 等库调用子进程

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4766

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1189

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4704

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

940

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1856

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3405

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4413

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2880

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

928

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习