@form8ion/core

中文文档
4.11.3发布于 2026/10/05MITESM + CJS构建来源已验证近 30 天下载 6.9万

form8ion 工具的核心逻辑

中文使用文档
文档目录9 节
  1. 目录
  2. 使用量
  3. 安装
  4. 示例
  5. API 密码
  6. 常数
  7. 捐款
  8. 依赖关系
  9. 核查

核心项目

核心逻辑 窗体8离子 工具

Codecov Node CI Workflow Status SLSA Level 2

目录

使用量

MIT license npm Try @form8ion/core on RunKit node

安装

$ npm install @form8ion/core --save-prod

示例

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() 以确定文件是否存在于给定路径.

directoryExists

包起来 fs.promises.stat() 以确定某一路径是否存在目录.

validateOptions

提供选项的验证 乔伊 计划.

schema (单位:千美元)所需经费(中文(简体) )

乔伊 计划

options (单位:千美元)所需经费(中文(简体) )

选项与所提供的计划进行比较

applyEnhancers

通过应用增强器(升起器)清单来处理脚手架结果 链条,返回增强的结果. 根据上游结果有条件地应用每个增强器 提供每个增强器.

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

results 对象 (单位:千美元)所需经费(中文(简体) )

脚手架执行的结果对象

enhancers 数组 (单位:千美元)所需经费(中文(简体) )

插件列表 lift 财务报告和审定财务报表 test 用于处理提供的属性 results。 。 。 . 这个 test 属性是决定增强器是否 适用于当前项目. 这个 lift 属性处理 results 若为 test 上游回归 true。 。 。 .

options 对象 (单位:千美元)所需经费(中文(简体) )

拟提供给缔约方大会的备选办法 test 财务报告和审定财务报表 lift 每个增强器的功能.

writeConfigFile

用所选格式将配置文件写入文件系统

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

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

包含要保存的文件的文件夹路径( 没有后继斜线) 写入

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

文件名称( 没有扩展名)

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

要写入文件的配置细节

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

要写入的配置文件的格式 。 格式来自 fileTypes 常数 目前获得支持的内容包括: fileTypes.JSON 财务报告和审定财务报表 fileTypes.YAML。 。 。 .

为不支持的格式出错 .

常数

fileTypes

用于描述各种形式8ion工具中使用的文件类型的常数

捐款

PRs Welcome Conventional Commits Commitizen friendly semantic-release Renovate

依赖关系

$ nvm install
$ npm install

核查

$ npm test

版本与发布记录

@form8ion/core 共发布 68 个版本,首次发布于 2020/07/07;过去 12 个月发布了 19 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.11.3latest2026/10/051 个月前
4.11.22026/06/135 个月前
5.0.0-beta.15beta2026/06/115 个月前
5.0.0-beta.142026/06/105 个月前
5.0.0-beta.132026/06/035 个月前
5.0.0-beta.122026/06/025 个月前

其他发布通道:alpha → 2.0.0-alpha.2,release-3.x → 3.3.0,beta → 5.0.0-beta.15。

关于 @form8ion/core 的常见问题

@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 和提交记录判断。