在package.json中查找未使用的npm包

Question

有没有办法确定你的package.json文件中是否有不再需要的软件包？

例如,在尝试打包并稍后评论或删除代码但忘记卸载时,我最终会得到一些可以删除的软件包.

什么是确定包是否可以安全删除的有效方法？

Answer 1

您可以使用名为depcheck的npm模块.

1. 安装模块:

   npm install depcheck -g
   
   or
   
   yarn global add depcheck
   

2. 运行它并找到未使用的依赖项:

   depcheck
   

这种方法的好处是你不必记住find或grep命令.

Answer 2

还有一个叫做的包npm-check:

NPM-检查

检查过时,不正确和未使用的依赖项.

它非常强大并且积极发展.其中一个功能是检查未使用的依赖项 - 对于这部分,它使用depcheck另一个答案中提到的模块.

Answer 3

检查未使用的依赖项

npm install depcheck -g
depcheck

检查过时的库

npm outdated

Answer 4

这里的许多答案都是如何只找到未使用的物品。如果...我想自动 -- a)查找 + b)删除未使用的项目怎么办？

下面的选项 2 似乎是较新的方法。

选项1：

1. 安装此节点项目。

 $ npm install -g typescript tslint tslint-etc

2. 在根目录中，添加一个新文件 tslint-imports.json

{
  "extends": [
    "tslint-etc"
  ],
  "rules": {
    "no-unused-declaration": true
  }
}

3. 运行此命令需要您自担风险，并进行备份:)

$ tslint --config tslint-imports.json --fix --project .

选项 2（根据 @Alex 和 @JacopKane 的建议，谢谢）：

// newer one line option
npx depcheck --json | jq '.dependencies[]' | xargs -L1 npm rm

// or
npm uninstall $(npx depcheck --oneline)

Answer 5

用于检查未使用的依赖项、库和未导入的文件

 npx unimported 

你会得到类似的结果

Answer 6

fiskeben 写道:

缺点是它不是全自动的，即它不会从 package.json 中提取包名称并检查它们。您需要自己为每个包执行此操作。

如果由于某种原因depcheck无法正常工作，让我们使 Fiskeben 的回答自动化！（例如，我用 Typescript 尝试了它，但它给出了不必要的解析错误）

对于解析，package.json我们可以使用该软件jq。下面的 shell 脚本需要一个从哪里开始的目录名。

#!/bin/bash
DIRNAME=${1:-.}
cd $DIRNAME

FILES=$(mktemp)
PACKAGES=$(mktemp)

find . \
    -path ./node_modules -prune -or \
    -path ./build -prune -or \
    \( -name "*.ts" -or -name "*.js" -or -name "*.json" \) -print > $FILES

function check {
    cat package.json \
        | jq "{} + .$1 | keys" \
        | sed -n 's/.*"\(.*\)".*/\1/p' > $PACKAGES

    echo "--------------------------"
    echo "Checking $1..."
    while read PACKAGE
    do
        RES=$(cat $FILES | xargs -I {} egrep -i "(import|require).*['\"]$PACKAGE[\"']" '{}' | wc -l)
        if [ $RES = 0 ]
        then
            echo -e "UNUSED\t\t $PACKAGE"
        else
            echo -e "USED ($RES)\t $PACKAGE"
        fi
    done < $PACKAGES
}

check "dependencies"
check "devDependencies"
check "peerDependencies"

首先它创建两个临时文件，我们可以在其中缓存包名和文件。

它从find命令开始。第一行和第二行使它忽略node_modules和build文件夹（或任何你想要的）。第三行包含允许的扩展名，您可以在此处添加更多，例如 JSX 或 JSON 文件。

一个函数将读取依赖类型。

首先cat是package.json. 然后，jq获取所需的依赖组。（{} +是否存在以便在文件中没有对等依赖项时不会抛出错误。）

之后，sed提取引号之间的部分，包名称。-n并.../p告诉它打印匹配的部分，而不是从jq的 JSON 输出中打印任何其他内容。然后我们将这个包名列表读入一个while循环。

RES是包名在引号中出现的次数。现在是import/ require... 'package'/ "package"。它在大多数情况下都能胜任。

然后我们简单地计算结果行的数量然后打印结果。

注意事项：

• 不会在不同的导入中找到文件，例如tsconfig.json文件（lib选项）
• 您必须grep手动仅针对^USED和UNUSED文件。
• 对于大型项目来说速度很慢——shell 脚本通常不能很好地扩展。但希望你不会跑这么多次。

Answer 7

gombosg的脚本比 npm-check 好得多。
我稍微修改了一下，所以也会发现node_modules中的devdependencies。从未使用过的
示例sass，但需要sass-loader

#!/bin/bash
DIRNAME=${1:-.}
cd $DIRNAME

FILES=$(mktemp)
PACKAGES=$(mktemp)

# use fd
# https://github.com/sharkdp/fd

function check {
    cat package.json \
        | jq "{} + .$1 | keys" \
        | sed -n 's/.*"\(.*\)".*/\1/p' > $PACKAGES
    echo "--------------------------"
    echo "Checking $1..."
    fd '(js|ts|json)$' -t f > $FILES
    while read PACKAGE
    do
        if [ -d "node_modules/${PACKAGE}" ]; then
            fd  -t f '(js|ts|json)$' node_modules/${PACKAGE} >> $FILES
        fi
        RES=$(cat $FILES | xargs -I {} egrep -i "(import|require|loader|plugins|${PACKAGE}).*['\"](${PACKAGE}|.?\d+)[\"']" '{}' | wc -l)

        if [ $RES = 0 ]
        then
            echo -e "UNUSED\t\t $PACKAGE"
        else
            echo -e "USED ($RES)\t $PACKAGE"
        fi
    done < $PACKAGES
}

check "dependencies"
check "devDependencies"
check "peerDependencies"

结果与原始脚本：

--------------------------
Checking dependencies...
UNUSED           jquery
--------------------------
Checking devDependencies...
UNUSED           @types/jquery
UNUSED           @types/jqueryui
USED (1)         autoprefixer
USED (1)         awesome-typescript-loader
USED (1)         cache-loader
USED (1)         css-loader
USED (1)         d3
USED (1)         mini-css-extract-plugin
USED (1)         postcss-loader
UNUSED           sass
USED (1)         sass-loader
USED (1)         terser-webpack-plugin
UNUSED           typescript
UNUSED           webpack
UNUSED           webpack-cli
USED (1)         webpack-fix-style-only-entries

和修改：

Checking dependencies...
USED (5)         jquery
--------------------------
Checking devDependencies...
UNUSED           @types/jquery
UNUSED           @types/jqueryui
USED (1)         autoprefixer
USED (1)         awesome-typescript-loader
USED (1)         cache-loader
USED (1)         css-loader
USED (2)         d3
USED (1)         mini-css-extract-plugin
USED (1)         postcss-loader
USED (3)         sass
USED (1)         sass-loader
USED (1)         terser-webpack-plugin
USED (16)        typescript
USED (16)        webpack
USED (2)         webpack-cli
USED (2)         webpack-fix-style-only-entries

Answer 8

如果您使用的是类Unix操作系统（Linux操作系统，OSX等），那么你可以使用的组合find和egrep搜索需要您的包名的语句：

find . -path ./node_modules -prune -o -name "*.js" -exec egrep -ni 'name-of-package' {} \;

如果搜索整个require('name-of-package')语句，请记住使用正确的引号类型：

find . -path ./node_modules -prune -o -name "*.js" -exec egrep -ni 'require("name-of-package")' {} \;

要么

find . -path ./node_modules -prune -o -name "*.js" -exec egrep -ni "require('name-of-package')" {} \;

缺点是它不是全自动的，即它不会从中提取软件包名称package.json并进行检查。您需要自己为每个程序包执行此操作。由于package.json只是JSON，因此可以通过编写一个小的脚本child_process.exec针对每个依赖项运行此命令来解决。并使其成为一个模块。并将其添加到NPM存储库中...