# @form8ion/core 中文文档 规范地址：https://npmcn.com/package/%40form8ion/core/ 版本：4\.11\.3 npm 元数据更新时间：2026-10-05T09:06:50.283Z 中文译文更新时间：2026-11-15T08:17:56.990Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40form8ion/core 原文对照：https://npmcn.com/package/%40form8ion/core/?lang=original 项目主页：https://npm.im/@form8ion/core 源码仓库：https://github.com/form8ion/core ## 关键信息（来自 npm 元数据） - 包体积（解压后）：94.1 kB，36 个文件 - 模块格式：ESM + CJS - TypeScript 类型：未声明 - Node.js 要求：^18\.17 \|\| \>=20\.6\.1 - 运行依赖：7 个 - 首次发布：2020-07-07T05:51:13.276Z - 最新版本发布：2026-10-05T09:06:49.900Z - 近 30 天下载量：68571（2026-10-16 至 2026-11-14，npm 官方下载统计） - 已发布版本数：68（近 12 个月 19 个） ## 中文简介 form8ion 工具的核心逻辑 ## 安装 ```sh npm install @form8ion/core ``` 也可以使用：`pnpm add @form8ion/core`、`yarn add @form8ion/core`、`bun add @form8ion/core` ## README # 核心项目 核心逻辑 [窗体8离子](https://github.com/form8ion/) 工具 [![Codecov](https://img.shields.io/codecov/c/github/form8ion/core?logo=codecov)](https://codecov.io/github/form8ion/core) [![Node CI Workflow Status](https://img.shields.io/github/actions/workflow/status/form8ion/core/node-ci.yml.svg?branch=master&logo=github)](https://github.com/form8ion/core/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster) ![SLSA Level 2](https://slsa.dev/images/gh-badge-level2.svg) ## 目录 - [使用量](https://npmcn.com/package/%40form8ion/core/#readme-usage) - [安装](https://npmcn.com/package/%40form8ion/core/#readme-installation) - [示例](https://npmcn.com/package/%40form8ion/core/#readme-example) - [API 密码](https://npmcn.com/package/%40form8ion/core/#readme-api) - [`fileExists`](https://npmcn.com/package/%40form8ion/core/#readme-fileexists) - [`directoryExists`](https://npmcn.com/package/%40form8ion/core/#readme-directoryexists) - [`validateOptions`](https://npmcn.com/package/%40form8ion/core/#readme-validateoptions) - [`schema` (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-schema-required) - [`options` (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-options-required) - [`applyEnhancers`](https://npmcn.com/package/%40form8ion/core/#readme-applyenhancers) - [`results` **对象** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-results-object-required) - [`enhancers` **数组** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-enhancers-array-required) - [`options` **对象** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-options-object-required) - [`writeConfigFile`](https://npmcn.com/package/%40form8ion/core/#readme-writeconfigfile) - [`path` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-path-string-required) - [`name` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-name-string-required) - [`config` **对象** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-config-object-required) - [`format` **字符串** (单位:千美元)_所需经费_(中文(简体) )](https://npmcn.com/package/%40form8ion/core/#readme-format-string-required) - [常数](https://npmcn.com/package/%40form8ion/core/#readme-constants) - [`fileTypes`](https://npmcn.com/package/%40form8ion/core/#readme-filetypes) - [捐款](https://npmcn.com/package/%40form8ion/core/#readme-contributing) - [依赖关系](https://npmcn.com/package/%40form8ion/core/#readme-dependencies) - [核查](https://npmcn.com/package/%40form8ion/core/#readme-verification) ## 使用量 [![MIT license](https://img.shields.io/github/license/form8ion/core.svg?logo=opensourceinitiative)](https://npmcn.com/package/%40form8ion/core/LICENSE) [![npm](https://img.shields.io/npm/v/@form8ion/core?logo=npm)](https://www.npmjs.com/package/@form8ion/core) [![Try @form8ion/core on RunKit](https://badge.runkitcdn.com/@form8ion/core.svg)](https://npm.runkit.com/@form8ion/core) ![node](https://img.shields.io/node/v/@form8ion/core?logo=node.js) ### 安装 ```sh $ npm install @form8ion/core --save-prod ``` ### 示例 ```javascript import {directoryExists, fileExists} from '@form8ion/core'; (async () => { await fileExists('path/to/some/expected/file'); await directoryExists('path/to/some/expected/directory'); })(); ``` ### API 密码 #### `fileExists` 包起来 [`fs.promises.stat()`](https://nodejs.org/api/fs.html#fs_fspromises_stat_path_options) 以确定文件是否存在于给定路径. #### `directoryExists` 包起来 [`fs.promises.stat()`](https://nodejs.org/api/fs.html#fs_fspromises_stat_path_options) 以确定某一路径是否存在目录. #### `validateOptions` 提供选项的验证 [乔伊](https://joi.dev/) 计划. ##### `schema` (单位:千美元)_所需经费_(中文(简体) ) [乔伊](https://joi.dev/) 计划 ##### `options` (单位:千美元)_所需经费_(中文(简体) ) 选项与所提供的计划进行比较 #### `applyEnhancers` 通过应用增强器(升起器)清单来处理脚手架结果 链条,返回增强的结果. 根据上游结果有条件地应用每个增强器 提供每个增强器. 以单个选项对象作为参数,包含: ##### `results` **对象** (单位:千美元)_所需经费_(中文(简体) ) 脚手架执行的结果对象 ##### `enhancers` **数组** (单位:千美元)_所需经费_(中文(简体) ) 插件列表 `lift` 财务报告和审定财务报表 `test` 用于处理提供的属性 `results`。 。 。 . 这个 `test` 属性是决定增强器是否 适用于当前项目. 这个 `lift` 属性处理 `results` 若为 `test` 上游回归 `true`。 。 。 . ##### `options` **对象** (单位:千美元)_所需经费_(中文(简体) ) 拟提供给缔约方大会的备选办法 `test` 财务报告和审定财务报表 `lift` 每个增强器的功能. #### `writeConfigFile` 用所选格式将配置文件写入文件系统 以单个选项对象作为参数,包含: ##### `path` **字符串** (单位:千美元)_所需经费_(中文(简体) ) 包含要保存的文件的文件夹路径( 没有后继斜线) 写入 ##### `name` **字符串** (单位:千美元)_所需经费_(中文(简体) ) 文件名称( 没有扩展名) ##### `config` **对象** (单位:千美元)_所需经费_(中文(简体) ) 要写入文件的配置细节 ##### `format` **字符串** (单位:千美元)_所需经费_(中文(简体) ) 要写入的配置文件的格式 。 格式来自 [`fileTypes` 常数](https://npmcn.com/package/%40form8ion/core/#readme-filetypes) 目前获得支持的内容包括: `fileTypes.JSON` 财务报告和审定财务报表 `fileTypes.YAML`。 。 。 . 为不支持的格式出错 . ### 常数 #### `fileTypes` 用于描述各种形式8ion工具中使用的文件类型的常数 ## 捐款 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com/) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org/) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release](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/core 是什么？ form8ion 工具的核心逻辑 ### 如何安装 @form8ion/core？ 在项目目录运行 npm install @form8ion/core，或使用 pnpm add / yarn add / bun add。 ### @form8ion/core 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/form8ion\_\_core 是否存在。 ### @form8ion/core 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @form8ion/core 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js ^18\.17 \|\| \>=20\.6\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @form8ion/core 可以商用吗？ @form8ion/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @form8ion/core 的下载量有多少？ 根据 npm 官方下载统计，@form8ion/core 在 2026/10/16 – 2026/11/14 这 30 天内被下载 68,571 次，日均约 2,286 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @form8ion/core 还在维护吗？ 最新版本 4\.11\.3 发布于 2026/10/05（1 个月前）；至今共发布 68 个版本，其中过去 12 个月发布了 19 个；首次发布于 2020/07/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。