github-core
core package to support form8ion plugins that interact with GitHub
Table of Contents
Usage
Installation
$ npm install @form8ion/github-core
Example
import {sourceHostedOnGitHub, octokit} from '@form8ion/github-core';
await sourceHostedOnGitHub({projectRoot: process.cwd()});
octokit.getNetrcAuthenticatedInstance({
logger: {
info: message => console.error(message),
warn: message => console.error(message),
error: message => console.error(message)
}
});
Contributing
Dependencies
$ nvm install
$ npm install
Verification
$ npm test
关于 @form8ion/github-core 的常见问题
@form8ion/github-core 是什么？
core package to support form8ion plugins that interact with GitHub
如何安装 @form8ion/github-core？
在项目目录运行 npm install @form8ion/github-core，或使用 pnpm add / yarn add / bun add。
@form8ion/github-core 支持 TypeScript 吗？
该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/form8ion__github-core 是否存在。
@form8ion/github-core 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@form8ion/github-core 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js ^20.19.0 || >=22.14.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@form8ion/github-core 可以商用吗？
@form8ion/github-core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@form8ion/github-core 的下载量有多少？
根据 npm 官方下载统计，@form8ion/github-core 在 2026/10/16 – 2026/11/14 这 30 天内被下载 6,068 次，日均约 202 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@form8ion/github-core 还在维护吗？
最新版本 2.0.0 发布于 2026/04/18（6 个月前）；至今共发布 11 个版本，其中过去 12 个月发布了 1 个；首次发布于 2025/04/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。