# @fomantic/gulp-concat-filenames 中文文档

规范地址：https://npmcn.com/package/%40fomantic/gulp-concat-filenames/

版本：3\.0\.0
npm 元数据更新时间：2026-07-17T18:27:59.966Z
中文译文更新时间：2026-11-15T04:11:20.660Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40fomantic/gulp-concat-filenames
原文对照：https://npmcn.com/package/%40fomantic/gulp-concat-filenames/?lang=original
项目主页：http://jesseharlin.net/
源码仓库：https://github.com/fomantic/gulp-concat-filenames

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

- 包体积（解压后）：20.7 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2024-04-19T22:27:43.232Z
- 最新版本发布：2026-07-17T18:27:59.738Z
- 近 30 天下载量：22720（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 1 个）

## 中文简介

类似于 concat,但创建一个文件,其中包含文件名列表,而非文件内容.

## 安装

```sh
npm install @fomantic/gulp-concat-filenames
```

也可以使用：`pnpm add @fomantic/gulp-concat-filenames`、`yarn add @fomantic/gulp-concat-filenames`、`bun add @fomantic/gulp-concat-filenames`

## README

> ### 使用更新的依赖关系伪造版本
> 
> 原始重播时间 [https://github.com/the-simian/gulp-concat-filenames 互联网档案馆的存檔,存档日期2013-12-02](https://github.com/the-simian/gulp-concat-filenames)

# 资料

| 软件包 | gulp-concat- 文件名称 |
| --- | --- |
| 说明 | 类似于concat,但在输出文件中创建了名称列表,而不是内容被合并. |
| 节点版本 | \>= 20 |

* * *

![gulp-concat-filenames](https://cloud.githubusercontent.com/assets/954596/12309992/609d63da-ba13-11e5-8698-b06ea035f07b.png)

## 使用量

### 基本用途,没有选项.

```js
var concatFilenames = require('gulp-concat-filenames');

var concatFilenamesOptions = {

};

function fileManifest(){
  gulp
      .src('./lib/**/*.*')
      .pipe(concatFilenames('manifest.txt', concatFilenamesOptions))
      .pipe(gulp.dest('./output/'));
}


gulp.task('file-manifest', fileManifest);

```

参数

Gulp concat 文件名需要两个参数: `filename` 财务报告和审定财务报表 `options`

QQ 名称 \[**需求**\[ . \]

第一个参数是输出文件的名称,文件名列表将被插入 .

备选 \[**可选**\[ . \]

第二个参数是可选的(pun意图),是一个具有以下属性的对象:

-   `newline` - 用来代替 `\n` 为一新行。 默认值将是 `\n`
-   `prepend` - 在文件名列表的每个条目中预留一些文字
-   `append` - 文件名列表中每个输入的附加文本
-   `template` - 函数需要一个参数(文件名),并在格式化后返回字符串。 可用于补充或代替, `append` 财务报告和审定财务报表 `prepend`
-   `root` - 根文件夹。 包括这个参数会返回相对路径列表,而不是绝对路径.

实例

鉴于文件结构 :

```
.
+-- somefile.txt
+-- lib
|   +-- one.txt
|   +-- two.txt
+-- gulpfile.js

```

```js
var concatFilenames = require('gulp-concat-filenames');

var concatFilenamesOptions = {
    root: '/lib',
    prepend: '==> ',
    append: ' <=='
};

function fileManifest(){
  gulp
      .src('./lib/**/*.*')
      .pipe(concatFilenames('manifest.txt', concatFilenamesOptions))
      .pipe(gulp.dest('./output/'));
}


gulp.task('file-manifest', fileManifest);
```

运行 `gulp file-manifest` 现在生成一个名为 `manifest.txt` 内容

```
==> one.txt <==
==> two.txt <==

```

或者您也可以使用模板属性来格式化输出.

```js

function fileNameFormatter(filename) {
   return 'XXX--' + filename.toUpperCase() + '--YYY';
}

var concatFilenames = require('gulp-concat-filenames');

var concatFilenamesOptions = {
    root: '/lib',
    template: fileNameFormatter // Pass in a function
};

function fileManifest(){
  gulp
      .src('./lib/**/*.*')
      .pipe(concatFilenames('manifest.txt', concatFilenamesOptions))
      .pipe(gulp.dest('./output/'));
}


gulp.task('file-manifest', fileManifest);
```

运行 `gulp file-manifest` 现在生成一个名为 `manifest.txt` 内容

```
XXX--ONE.TXT--YYY
XXX--TWO.TXT--YYY

```

贡献 如果你写测试,跟随Semver 并有东西补充, 我喜欢接受拉请求! 有问题吗? 在github上发表文章! < 3

## 常见问题

### @fomantic/gulp-concat-filenames 是什么？

类似于 concat,但创建一个文件,其中包含文件名列表,而非文件内容\.

### 如何安装 @fomantic/gulp-concat-filenames？

在项目目录运行 npm install @fomantic/gulp-concat-filenames，或使用 pnpm add / yarn add / bun add。

### @fomantic/gulp-concat-filenames 支持 TypeScript 吗？

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

### @fomantic/gulp-concat-filenames 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fomantic/gulp-concat-filenames 需要什么版本的 Node\.js？

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

### @fomantic/gulp-concat-filenames 可以商用吗？

@fomantic/gulp-concat-filenames 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @fomantic/gulp-concat-filenames 的下载量有多少？

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

### @fomantic/gulp-concat-filenames 还在维护吗？

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