# @citation-js/plugin-cff 中文文档

规范地址：https://npmcn.com/package/%40citation-js/plugin-cff/

版本：0\.7\.3
npm 元数据更新时间：2026-10-01T15:23:31.316Z
中文译文更新时间：2026-11-09T17:00:03.254Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40citation-js/plugin-cff
原文对照：https://npmcn.com/package/%40citation-js/plugin-cff/?lang=original
项目主页：https://github.com/citation-js/plugin-software-formats#readme
源码仓库：https://github.com/citation-js/plugin-software-formats

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：25.5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：2 个
- 首次发布：2023-03-26T16:51:16.979Z
- 最新版本发布：2026-10-01T15:23:31.033Z
- 近 30 天下载量：28462（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 5 个）

## 中文简介

引用文件格式( CFF) 插件

## 安装

```sh
npm install @citation-js/plugin-cff
```

也可以使用：`pnpm add @citation-js/plugin-cff`、`yarn add @citation-js/plugin-cff`、`bun add @citation-js/plugin-cff`

## README

此插件添加支持 [引用文件格式( CFF)](http://citation-file-format.github.io/citation-file-format) 文档,既作为YAML,又作为非标准的JSON格式.

## 安装

### 无

```js
npm install @citation-js/plugin-cff
```

### 浏览器

盖起一个 `@citation-js/plugin-cff` 编辑 [构建工具](https://juniper-coat.glitch.me/)来啊!

## 使用

注册插件 `require`\- 说:

```js
require('@citation-js/plugin-cff')
```

## 格式

### 投入

```yml
# Example from https://github.com/citation-file-format/citation-file-format#example

cff-version: 1.2.0
message: If you use this software, please cite it as below.
type: software
authors:
  - family-names: Druskat
    given-names: Stephan
    orcid: https://orcid.org/0000-0003-4925-7248
title: My Research Tool
version: 1.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
```

变成

```js
{
  author: [ { family: 'Druskat', given: 'Stephan' } ],
  issued: { 'date-parts': [ [2017, 12, 18] ] },
  DOI: '10.5281/zenodo.1234',
  title: 'My Research Tool',
  version: '1.0.4',
  type: 'book',
  _cff_mainReference: true
}
```

### 产出

如果通过多次引用,则将第一个数作为主要参考,而 剩余部分在 `references` 列表中选择一个选项。 指定不同的条目为主 引用,通过 `main` 选项 :

```js
Cite(/* ... */).format('cff', {
  main: '...'
})
```

或者,该条目可以 `_cff_mainReference` 设置为 `true`不过 主要用于圆通取水.

要指定首选引用,请在 `preferred` 选项.

生成 CFF `1.1.0` 输出, 通过 `'1.1.0'` 页:1 `cffVersion` 选项.

您也可以指定信件,每个 CFF 文件的强制部分. 默认, 消息为:

> 请在使用此软件时引用以下作品.

要改变它, 传递一个字符串到 `message` 选项在格式化时:

```js
Cite(/* ... */).format('cff', {
  message: 'If you use this software, please cite it as below.'
})
```

## 常见问题

### @citation-js/plugin-cff 是什么？

引用文件格式\( CFF\) 插件

### 如何安装 @citation-js/plugin-cff？

在项目目录运行 npm install @citation-js/plugin-cff，或使用 pnpm add / yarn add / bun add。

### @citation-js/plugin-cff 支持 TypeScript 吗？

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

### @citation-js/plugin-cff 支持 ESM 还是 CommonJS？

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

### @citation-js/plugin-cff 需要什么版本的 Node\.js？

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

### @citation-js/plugin-cff 可以商用吗？

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

### @citation-js/plugin-cff 的下载量有多少？

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

### @citation-js/plugin-cff 还在维护吗？

最新版本 0\.7\.3 发布于 2026/10/01（1 个月前）；至今共发布 6 个版本，其中过去 12 个月发布了 5 个；首次发布于 2023/03/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。