npm 包 ignore-by-default 使用教程

在使用 npm 安装包时，我们通常都需要忽略一些文件或文件夹。比如一些测试文件、文档、源代码等等，这些文件往往不会被直接用到。使用 .gitignore 可以过滤掉这些文件，让它们不会被加入到版本控制中。

但是有些文件在 .gitignore 中被忽略了，但在发布到 npm 上时，却被包含在内。因为 npm 发布的包是将整个项目目录打包上传的，而不是将代码提交到一个 Git 仓库中。

此时就需要使用 ignore-by-default 这个包来解决这个问题。

安装

使用 npm 安装：

npm install ignore-by-default --save-dev

配置

在项目的根目录下创建 .npmignore 文件并添加需要忽略的文件或文件夹。与 .gitignore 相同，每行一个文件或文件夹，支持使用通配符。

例如：

# 忽略所有 .md 文件
*.md

# 忽略 test 目录下的所有文件
test/**

使用

手动调用

在发布前，在终端输入以下命令：

npx ignore-by-default create

ignore-by-default 将会按照 .npmignore 中的配置，生成一个 .npmrc 文件。在发布时，npm 会自动读取该文件并忽略其中指定的文件和文件夹。

集成到构建流程中

如果希望在构建流程中自动调用 ignore-by-default，可以在 package.json 中添加如下脚本：

{
  "scripts": {
    "prepublishOnly": "npx ignore-by-default create"
  }
}

这样，在运行 npm publish 命令时，就会先执行 prepublishOnly 脚本，自动调用 ignore-by-default 并生成 .npmrc 文件，然后再进行包的发布。

总结

使用 ignore-by-default 可以很方便地在 npm 包中忽略一些不需要上传的文件或文件夹。同时，它也能与现有的 .gitignore 文件兼容，让我们更加轻松地管理项目。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/41029