@minimalstuff/tooling

中文文档
0.8.0发布于 2026/11/02MITES Module构建来源已验证

共享工具配置:EditorConfig, OXC (oxlint + oxfmt), Knip

中文使用文档
文档目录8 节
  1. 要求
  2. 版本控制
  3. 建立一个项目
  4. 使用CLI
  5. 手动
  6. 开发
  7. 文档
  8. 许可证

@minimalstuff /工具

共享工具配置:EditorConfig, OXC (oxlint + oxfmt), Knip。CLI在项目中设置它们。

要求

  • 节点>= 26
  • oxlint > = 1.89.0, oxfmt >= 0.74.0和 oxlint-tsgolint >= 7.0.2004(可选的对等依赖,用于OXC预设)
  • knip >= 6.42.1(可选的对等依赖,用于Knip预设)
  • @adonisjs/eslint-plugin ^2.2.2(可选的对等依赖,需要与 adonisjs: true 在oxlint预设中;命令行安装它)

版本控制

[!重要的) 删除或更改导出或选项是破坏性更改。1.0之前,new或strict error-级别的规则和新的需要的对等依赖也被打破了:它们在一个小版本中发布,其中 ^0.x 范围永远不会自动增加。新 warn严格的规则和宽松的规则都没有违反。

建立一个项目

使用CLI

在交互式终端中,从项目根目录运行以下命令:

pnpm dlx @minimalstuff/tooling@latest

命令行询问要设置哪些工具(EditorConfig, OXC, Knip),在选择OXC时提供VS Code设置,并要求预置(react, adonisjs, vitest)从依赖项中预先选择。它在覆盖文件之前进行询问,并且只添加 package.json 缺少的脚本。然后使用检测到的包管理器将这些包作为devDependencies安装一次。看到 CLI参考 获取详细信息。

手动

pnpm add -D oxlint oxfmt oxlint-tsgolint @minimalstuff/tooling
# optional, for the AdonisJS oxlint preset
pnpm add -D @adonisjs/eslint-plugin
# optional, for the Knip preset
pnpm add -D knip
// oxlint.config.ts
import { minimalstuffPreset } from '@minimalstuff/tooling/oxc/lint';

export default minimalstuffPreset({ react: true });
// oxfmt.config.ts
import { minimalstuffPreset } from '@minimalstuff/tooling/oxc/fmt';

export default minimalstuffPreset();
// knip.ts
import { minimalstuffPreset } from '@minimalstuff/tooling/knip';

export default minimalstuffPreset();
cp node_modules/@minimalstuff/tooling/preset/.editorconfig .editorconfig

看到 预设的参考 选项。

开发

pnpm install
pnpm checks

pnpm checks 运行类型检查、lint、格式检查、Knip、单元测试和构建。 pnpm test:package 使用严格的pnpm将打包好的tarball安装到一次性的消费者项目中:它需要网络访问并在CI中运行。

文档

许可证

麻省理工学院

版本与发布记录

@minimalstuff/tooling 共发布 11 个版本,首次发布于 2026/04/03;过去 12 个月发布了 11 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.8.0latest2026/11/021 天前
0.8.0-next.0next2026/11/021 天前
0.7.02026/10/2311 天前
0.6.02026/05/115 个月前
0.5.02026/04/266 个月前
0.4.02026/04/266 个月前

关于 @minimalstuff/tooling 的常见问题

@minimalstuff/tooling 是什么?

共享工具配置:EditorConfig, OXC (oxlint + oxfmt), Knip

如何安装 @minimalstuff/tooling?

在项目目录运行 npm install @minimalstuff/tooling,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 tooling,可以用 npx tooling 直接运行。

@minimalstuff/tooling 支持 TypeScript 吗?

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

@minimalstuff/tooling 支持 ESM 还是 CommonJS?

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

@minimalstuff/tooling 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=26。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@minimalstuff/tooling 可以商用吗?

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

@minimalstuff/tooling 还在维护吗?

最新版本 0.8.0 发布于 2026/11/02(1 天前);至今共发布 11 个版本,其中过去 12 个月发布了 11 个;首次发布于 2026/04/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。