@doki-land/nifty

中文文档
0.1.12发布于 2026/11/08MPL-2.0TypeScriptES Module构建来源已验证近 30 天下载 9660

Gitmoji-first commit conventions and release helpers (Node-API + TypeScript)

原始使用文档
文档目录4 节
  1. Exports
  2. Runtime
  3. Example
  4. Related packages

@doki-land/nifty

npm version

Programmatic and CLI surface for Nifty — gitmoji commit lint, hybrid Cargo + npm bumps, Oak formatting, workspace publish, and gix-backed git helpers. Product overview: npm-tools readme.

Exports

SubpathPurpose
@doki-land/niftyNifty, Git, Github, Gitmoji, config loaders, shared types
@doki-land/nifty/cliCLI module re-exports (advanced integrations)
nifty (bin)Full command-line interface

Platform native bindings (@doki-land/nifty-*) install automatically as optional dependencies on matching hosts. Do not import them directly.

Runtime

Requires Node.js >=24.12.0. The CLI and package exports load prebuilt JS from dist. Project configs (nifty.config.ts / .mts / .js / .mjs / .cjs) are executed by Node itself, so npm packages imported by a config must expose JS runtime exports — Node does not run TypeScript inside node_modules.

Example

CLI — run from a project root that contains nifty.config.ts (optional):

nifty check --from v0.1.0 --to HEAD
nifty bump --version 0.2.0 --dry-run
nifty format --check

TypeScript API — open a hybrid workspace and read git history:

import { createNifty } from "@doki-land/nifty";

const nifty = await createNifty({ cwd: process.cwd() });
const ok = nifty.gitmoji.validateSubject("✨ Add workspace helper");
const range = nifty.git.resolveRange(nifty.layout.root, {
  fromRef: "v0.1.0",
  toRef: "HEAD",
});

Config — typed project defaults:

import { defineConfig } from "@doki-land/nifty";

export default defineConfig({
  lint: {
    rules: [{ id: "gitmoji/subject", severity: "error", enabled: true }],
  },
});
  • @doki-land/nifty-skills — Agent Skills for nifty workflows
  • Platform sidecars (@doki-land/nifty-win32-x64, @doki-land/nifty-linux-x64, …) — prebuilt Node-API artifacts resolved by this package

版本与发布记录

@doki-land/nifty 共发布 24 个版本,首次发布于 2026/09/26;过去 12 个月发布了 24 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.12latest2026/11/085 天前
0.1.112026/11/076 天前
0.1.102026/10/2420 天前
0.1.92026/10/2222 天前
0.1.82026/10/2222 天前
0.1.72026/10/2222 天前

关于 @doki-land/nifty 的常见问题

@doki-land/nifty 是什么?

Gitmoji-first commit conventions and release helpers (Node-API + TypeScript)

如何安装 @doki-land/nifty?

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

@doki-land/nifty 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@doki-land/nifty 支持 ESM 还是 CommonJS?

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

@doki-land/nifty 需要什么版本的 Node.js?

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

@doki-land/nifty 可以商用吗?

@doki-land/nifty 使用 MPL-2.0 许可。弱 Copyleft:可以商用,也可以和闭源代码一起使用;但如果分发时修改了 MPL 授权的文件,这些文件的修改需以 MPL 开源。以上为概括,不构成法律意见,请以许可原文为准。

@doki-land/nifty 的下载量有多少?

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

@doki-land/nifty 还在维护吗?

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