# @form8ion/config-file 中文文档

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

版本：1\.4\.1
npm 元数据更新时间：2026-08-05T20:33:25.065Z
中文译文更新时间：2026-11-15T08:18:23.073Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13.9 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2022-06-03T20:40:02.307Z
- 最新版本发布：2026-08-05T20:33:24.717Z
- 近 30 天下载量：13924（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 2 个）

## 中文简介

form8ion 用于管理 RC 文件的工具

## 安装

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

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

## README

# 配置文件

form8ion 用于管理 RC 文件的工具

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

## 目录

-   [使用量](https://npmcn.com/package/%40form8ion/config-file/#readme-usage)
    -   [安装](https://npmcn.com/package/%40form8ion/config-file/#readme-installation)
    -   [示例](https://npmcn.com/package/%40form8ion/config-file/#readme-example)
    -   [API 密码](https://npmcn.com/package/%40form8ion/config-file/#readme-api)
        -   [`write`](https://npmcn.com/package/%40form8ion/config-file/#readme-write)
            -   [`format` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/config-file/#readme-format-string-required)
            -   [`name` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/config-file/#readme-name-string-required)
            -   [`path` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/config-file/#readme-path-string-required)
            -   [`config` **对象** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/config-file/#readme-config-object-required)
-   [捐款](https://npmcn.com/package/%40form8ion/config-file/#readme-contributing)
    -   [依赖关系](https://npmcn.com/package/%40form8ion/config-file/#readme-dependencies)
    -   [核查](https://npmcn.com/package/%40form8ion/config-file/#readme-verification)

## 使用量

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

### 安装

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

### 示例

```javascript
import {fileTypes} from '@form8ion/core';
import {write} from '@form8ion/config-file';
```

```javascript
(async () => {
  await write({
    format: fileTypes.JSON,
    name: 'tool-name',
    path: process.cwd(),
    config: {foo: 'bar', baz: 'qux'}
  });
})();
```

### API 密码

#### `write`

将指定的工具的配置写入相应的 rc 文件

以单个选项对象作为参数,包含:

##### `format` **字符串** (单位:千美元)_所需经费_(中文(简体) )

要写入的文件的格式

##### `name` **字符串** (单位:千美元)_所需经费_(中文(简体) )

配置文件要使用的工具名称

##### `path` **字符串** (单位:千美元)_所需经费_(中文(简体) )

包含配置文件的目录路径

##### `config` **对象** (单位:千美元)_所需经费_(中文(简体) )

要写入文件的配置

## 捐款

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/) [![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/) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com/)

### 依赖关系

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

### 核查

```sh
$ npm test
```

## 常见问题

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

form8ion 用于管理 RC 文件的工具

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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