npm-check

「 查过期的ㄡ不正确的和未使用的依赖项. 」

中文 | english

---

校对 🀄️

翻译的原文	与日期	最新更新	更多
commit	⏰ 2018 8.6		中文翻译

贡献

欢迎 👏 勘误/校对/更新贡献 😊 具体贡献请看

生活

If help, buy me coffee —— 营养跟不上了，给我来瓶营养快线吧! 💰

---

目录

NPM检查

检查过期的ㄡ不正确的和未使用的依赖项.

特征

• 告诉你什么过时了.
• 提供到包的文档的链接,这样您就可以决定是否需要更新.
• 请告知您是否在代码中使用了依赖项.
• 在您的全球安装包也通过-g.
• 交互更新少打字,少打字,通过-u.
• 支持公私@范围/包.
• 支持ES6风格import from语法.
• 使用NPM的安装版本升级您的模块,包括新版本npm@3因此,依赖关系会在你期望的地方进行.
• 与任何公共NPM注册表一起工作,有注册中心和备用注册表窦房结.
• 不为包查询注册表private: true在他们的包裹里.
• 在命令行应用程序中,因为命令行应用程序也很有趣.
• 作品与npm@2和npm@3以及新的替代安装程序ied和pnpm.

要求

• 节点>=0.11.

在命令行上

这是最容易使用的方法. npm-check.

安装

$ npm install -g npm-check

使用

$ npm-check

结果应该看起来像屏幕截图,或者当你的包都是最新的和正在使用的东西.

当需要更新时,它将返回一个可以在CI工具中使用的非零响应代码.

选项

Usage
  $ npm-check <path> <options>

Path
  Where to check. Defaults to current directory. Use -g for checking global modules.

Options
  -u, --update          Interactive update.
  -y, --update-all      Uninteractive update. Apply all updates without prompting.
  -g, --global          Look at global modules.
  -s, --skip-unused     Skip check for unused packages.
  -p, --production      Skip devDependencies.
  -d, --dev-only        Look at devDependencies only (skip dependencies).
  -i, --ignore          Ignore dependencies based on succeeding glob.
  -E, --save-exact      Save exact version (x.y.z) instead of caret (^x.y.z) in package.json.
  --specials            List of depcheck specials to include in check for unused dependencies.
  --no-color            Force or disable color output.
  --no-emoji            Remove emoji support. No emoji in default in CI environments.
  --debug               Show debug output. Throw in a gist when creating issues on github.

Examples
  $ npm-check           # See what can be updated, what isn't being used.
  $ npm-check ../foo    # Check another path.
  $ npm-check -gu       # Update globally installed modules by picking which ones to upgrade.

-u, --update

显示交互式UI,用于选择要更新的模块.

自动更新引用的版本package.json.

*根据建议npm团队,npm-check仅使用更新npm install不是npm update. 避免使用多个版本npm在一个目录中,npm-check将使用版本自动安装更新的模块npm全球安装. *

使用更新ied或pnpm

设置环境变量NPM_CHECK_INSTALLER您希望使用的安装程序的名称.

NPM_CHECK_INSTALLER=pnpm npm-check -u
## pnpm install --save-dev foo@version --color=always

你也可以用这种方法进行干运转试验:

NPM_CHECK_INSTALLER=echo npm-check -u

-y, --update-all

更新你的依赖关系--update只是没有任何提示. 如果您希望自动更新依赖项,则这一点尤其有用. npm-check.

-g, --global

检查您的全局安装包的版本.

如果值process.env.NODE_PATH设置时,它将重写包返回的全局NoDEN1模块的默认路径. global-modules.

*提示: 使用npm-check -u -g对全局模块进行安全的交互式更新,包括NPM本身. *

-s, --skip-unused

默认情况下npm-check会让你知道如果你的模块没有被用来查看require代码中的语句.

此选项将跳过该检查.

当使用时默认为启用. global或update.

-p, --production

默认情况下npm-check将查看列为dependencies和devDependencies.

此选项将使其忽略已列出的包的过时和未使用的检查. devDependencies.

-d, --dev-only

忽略dependencies并且只检查devDependencies.

此选项将使其忽略已列出的包的过时和未使用的检查. dependencies.

-i, --ignore

忽略与指定的GLUB匹配的依赖项.

$ npm-check -i babel-*将忽略从"巴别塔"开始的所有依赖关系.

-E, --save-exact

使用软件包安装--save-exact意思是确切的版本将保存在PACKAG.JSON中.

适用于两者dependencies和devDependencies.

--specials

在查找未使用的依赖项时,检查特殊文件 (如配置文件) .

$ npm-check --specials=bin,webpack将在scriptsPACKAG.JSON和WebPACK配置部分.

见http://GITHUB.COM/DEPCHECK/DEPCHECK欲了解更多信息.

--color, --no-color

启用或禁用颜色支持.

默认情况下npm-check使用颜色,如果他们是可用的.

--emoji, --no-emoji

启用或禁用表情支持. 对于不支持它们的终端是有用的. 在CI服务器中自动禁用.

--spinner, --no-spinner

启用或禁用旋转器. 对于不支持它们的终端是有用的. 在CI服务器中自动禁用.

美国石油学会

API是在这里,如果你想用CI工具集包装这个.

const npmCheck = require('npm-check');

npmCheck(options)
  .then(currentState => console.log(currentState.get('packages')));

update

• 交互式更新.
• 默认是false

global

• 检查全局模块.
• 默认是false
• cwd使用此选项自动设置.

skipUnused

• 跳过检查未使用的包.
• 默认是false

ignoreDev

• 忽略devDependencies.
• 这叫做--production在命令行上匹配npm.
• 默认是false

devOnly

• 忽略dependencies并且只检查devDependencies.
• 默认是false

ignore

• 忽略与指定的GLUB匹配的依赖项.
• 默认是[]

saveExact

• 用精确版本更新包x.y.z代替Sever范围^x.y.z.
• 默认是false

debug

• 显示调试输出. 在GITHUB上创建问题时要抛砖引玉.
• 默认是false

cwd

• 覆盖在哪里npm-check检查.
• 默认是process.cwd()

specials

• 名单depcheck包括特殊解析器.
• 默认是''

currentState

承诺的结果是currentState对象,查看JS看看它是如何工作的.

你可能想要currentState.get('packages')获取包数组和每个包的状态.

数组中的每个条目看起来如下:

{
  moduleName: 'lodash',                 // name of the module.
  homepage: 'https://lodash.com/',      // url to the home page.
  regError: undefined,                  // error communicating with the registry
  pkgError: undefined,                  // error reading the package.json
  latest: '4.7.0',                      // latest according to the registry.
  installed: '4.6.1',                   // version installed
  isInstalled: true,                    // Is it installed?
  notInstalled: false,                  // Is it installed?
  packageWanted: '4.7.0',               // Requested version from the package.json.
  packageJson: '^4.6.1',                // Version or range requested in the parent package.json.
  devDependency: false,                 // Is this a devDependency?
  usedInScripts: undefined,             // Array of `scripts` in package.json that use this module.
  mismatch: false,                      // Does the version installed not match the range in package.json?
  semverValid: '4.6.1',                 // Is the installed version valid semver?
  easyUpgrade: true,                    // Will running just `npm install` upgrade the module?
  bump: 'minor',                        // What kind of bump is required to get the latest, such as patch, minor, major.
  unused: false                         // Is this module used in the code?
},

如果你使用,你也会看到这个. --debug在命令行上.

灵感

• NPM过时-笨拙的输出,需要深度=0是可拖动的.
• 戴维-不与私人注册机构合作.
• 更新通知器-对于单个模块,不是包装中的一切. JSON.
• 除错-只是谜题的一部分. NPM检查使用DeBECK.

关于作者

你好!谢谢你检查这个项目!我的名字是迪伦格林尼. 当我没有被我的两个孩子压垮的时候,我喜欢为开源社区做贡献. 我也是一个技术领先者欧波威耳.

以下是我的其他节点项目:

名字	描述	npm 下载
grunt‑notify	自动桌面通知的咕噜错误和警告. 支持OS XㄡWindowsㄡLinux.
shortid	非常短的非顺序URL友好的唯一ID生成器.
space‑hogs	从命令行中发现惊人的大目录.
rss	RSS馈源发生器. 向任何项目添加RSS提要. 支持外壳和GOSSSS.
grunt‑prompt	使用控制台复选框ㄡ带有过滤的文本输入ㄡ密码字段来为您的Grutter配置提供交互式提示.
xml	快速简单的XML生成器. 支持属性ㄡCDATA等包括测试和示例.
changelog	命令行工具 (和Node模块) ,用于为npmjs.org注册表中的模块以及任何公共github.com repo中的模块生成颜色输出ㄡ标记或json中的更改日志.
grunt‑attention	显示终端中的注意力捕获消息
observatory	漂亮的UI,用于显示命令行上运行的任务.
anthology	任何@ NPMJS用户的模块信息和统计信息
grunt‑cat	将文件回传给终端. 作品与文本,小品,ASCII艺术,全彩ANSI.

使用此列表生成选本.

许可证

版权所有 (C) 2016 Dylan Greene,撰稿人.

发布下MIT许可.

截屏是西比萨 (归属共享) .