无需登录 数据私有 本地保存

package.json 文件检查器 - 验证字段与依赖规范

31
0
0
0

Package.json 文件检查器

验证 package.json 字段完整性与依赖规范,确保符合 npm 标准

JSON 输入
拖拽 package.json 文件到此处,或点击上传
错误
0
警告
0
通过
0
检查详情

输入 JSON 内容后点击验证
结果将显示在这里

已验证字段清单
name
version
description
license
author
repository
main
scripts
dependencies
devDependencies
engines
keywords
常见问题与知识点

根据 npm 官方规范,nameversion 是两个绝对必填字段。name 必须是小写、无空格、可使用连字符和下划线,且长度不超过 214 个字符。version 必须遵循 SemVer(语义化版本) 格式,即 主版本.次版本.修订号,例如 1.0.0。如果缺少这两个字段,npm 将无法安装你的包。对于发布到 npm registry 的包,还强烈建议填写 descriptionlicenserepository

  • ^1.2.3:兼容性更新,允许 minor 和 patch 升级(>=1.2.3 <2.0.0)
  • ~1.2.3:仅允许 patch 升级(>=1.2.3 <1.3.0)
  • *x:通配符,匹配任意版本
  • >=1.0.0 <2.0.0:范围表达式
  • 预发布标签:1.0.0-alpha.11.0.0-beta.2
  • 建议生产依赖使用 ^ 前缀以获得安全更新,关键依赖可锁定版本

dependencies 是生产环境必需的依赖,用户在安装你的包时会一并安装。例如 React、Express 等运行时依赖。devDependencies 仅在开发阶段使用,如测试框架(Jest)、构建工具(Webpack)、TypeScript 等。使用 npm install --production 或设置 NODE_ENV=production 时,devDependencies 不会被安装,这可以减少部署体积。

npm 包名必须:全部小写、无前导点或下划线、允许使用连字符、长度 ≤ 214 字符、不能包含空格、不能使用非 URL 安全字符。作用域包格式为 @scope/package-name。此外,不要使用与核心模块相同的名称(如 fspath),也不要使用容易引起安全误解的名称。

常见的 scripts 包括:start(启动应用)、build(构建项目)、test(运行测试)、lint(代码检查)、prepublish(发布前钩子)。npm 内置了 prepost 钩子机制,例如 prebuild 会在 build 之前自动执行。建议在 scripts 中使用跨平台兼容的命令,或使用 cross-env 处理环境变量。

本工具主要验证 package.json 的结构规范性和字段格式,包括必填字段检查、版本格式校验、命名规则验证等。如需检查依赖是否有新版本,建议使用 npm outdatednpm-check-updates。本工具会指出不符合 SemVer 的版本号、GitHub 仓库地址格式错误、author 字段格式问题等常见错误。