# @form8ion/ignore-file 中文文档

规范地址：https://npmcn.com/package/%40form8ion/ignore-file/

版本：1\.0\.0
npm 元数据更新时间：2025-02-26T05:12:46.813Z
中文译文更新时间：2026-11-15T08:18:33.778Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40form8ion/ignore-file
原文对照：https://npmcn.com/package/%40form8ion/ignore-file/?lang=original
项目主页：https://npm.im/@form8ion/ignore-file
源码仓库：https://github.com/form8ion/ignore-file

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9.5 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：^18\.19\.0 \|\| ^20\.9\.0 \|\| \>=22\.11\.0
- 运行依赖：1 个
- 首次发布：2025-02-26T04:14:28.677Z
- 最新版本发布：2025-02-26T05:12:46.403Z
- 近 30 天下载量：7801（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

用于管理被忽略文件的窗体8ion工具

## 安装

```sh
npm install @form8ion/ignore-file
```

也可以使用：`pnpm add @form8ion/ignore-file`、`yarn add @form8ion/ignore-file`、`bun add @form8ion/ignore-file`

## README

# 忽略文件

用于管理被忽略文件的窗体8ion工具

[![Node CI Workflow Status](https://img.shields.io/github/actions/workflow/status/form8ion/ignore-file/node-ci.yml.svg?branch=master&logo=github)](https://github.com/form8ion/ignore-file/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster) [![Codecov](https://img.shields.io/codecov/c/github/form8ion/ignore-file?logo=codecov)](https://codecov.io/github/form8ion/ignore-file) ![SLSA Level 2](https://slsa.dev/images/gh-badge-level2.svg)

## 目录

-   [使用量](https://npmcn.com/package/%40form8ion/ignore-file/#readme-usage)
    -   [安装](https://npmcn.com/package/%40form8ion/ignore-file/#readme-installation)
    -   [示例](https://npmcn.com/package/%40form8ion/ignore-file/#readme-example)
        -   [导入](https://npmcn.com/package/%40form8ion/ignore-file/#readme-import)
        -   [执行](https://npmcn.com/package/%40form8ion/ignore-file/#readme-execute)
-   [捐款](https://npmcn.com/package/%40form8ion/ignore-file/#readme-contributing)
    -   [依赖关系](https://npmcn.com/package/%40form8ion/ignore-file/#readme-dependencies)
    -   [核查](https://npmcn.com/package/%40form8ion/ignore-file/#readme-verification)

## 使用量

[![npm](https://img.shields.io/npm/v/@form8ion/ignore-file?logo=npm)](https://www.npmjs.com/package/@form8ion/ignore-file) [![Try @form8ion/ignore-file on RunKit](https://badge.runkitcdn.com/@form8ion/ignore-file.svg)](https://npm.runkit.com/@form8ion/ignore-file) [![license](https://img.shields.io/github/license/form8ion/ignore-file.svg?logo=opensourceinitiative)](https://npmcn.com/package/%40form8ion/ignore-file/LICENSE) ![node](https://img.shields.io/node/v/@form8ion/ignore-file?logo=node.js)

### 安装

```sh
$ npm install @form8ion/ignore-file --save-prod
```

### 示例

#### 导入

```javascript
import {exists, read, write} from '@form8ion/ignore-file';
```

#### 执行

```javascript
const projectRoot = process.cwd();
const toolName = 'tool-name';

await exists({projectRoot, name: toolName});

await read({projectRoot, name: toolName});

await write({projectRoot, name: toolName, ignores: ['foo/', 'bar.js']});
```

## 捐款

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org/) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com/) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

### 依赖关系

```sh
$ nvm install
$ npm install
```

### 核查

```sh
$ npm test
```

## 常见问题

### @form8ion/ignore-file 是什么？

用于管理被忽略文件的窗体8ion工具

### 如何安装 @form8ion/ignore-file？

在项目目录运行 npm install @form8ion/ignore-file，或使用 pnpm add / yarn add / bun add。

### @form8ion/ignore-file 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/form8ion\_\_ignore-file 是否存在。

### @form8ion/ignore-file 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @form8ion/ignore-file 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^18\.19\.0 \|\| ^20\.9\.0 \|\| \>=22\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @form8ion/ignore-file 可以商用吗？

@form8ion/ignore-file 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @form8ion/ignore-file 的下载量有多少？

根据 npm 官方下载统计，@form8ion/ignore-file 在 2026/10/16 – 2026/11/14 这 30 天内被下载 7,801 次，日均约 260 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @form8ion/ignore-file 还在维护吗？

最新版本 1\.0\.0 发布于 2025/02/26（1\.7 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2025/02/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。