简介
在前端开发中,文件名是一个很重要的部分,因为文件名可以很好地描述一个文件的作用。gulp-filenames 是一个 npm 包,可以帮助我们在 Gulp 中获取文件名。
安装
使用 npm 安装 gulp-filenames
npm install gulp-filenames --save-dev
使用
在 Gulp 任务中使用 gulp-filenames 来获取文件名,可以通过三种方式获取文件名: get()
,rename()
和 save()
。
在 Gulp 中使用 gulp-filenames 需要先引入该模块:
const filenames = require('gulp-filenames');
get()
使用 get()
获取文件名称可以获取当前所有文件名。在使用之前请先确认 Gulp 任务已经包含了所需文件。
gulp.src('./src/*.js') .pipe(filenames.get('files.txt')) .pipe(gulp.dest('./dist/'));
这会将文件名字写入文件 files.txt
,并将该文件放入 ./dist
目录下。
rename()
使用 rename()
可以将文件重命名为获取到的文件名。在使用之前请先确认 Gulp 任务已经包含了所需文件。
gulp.src('./src/*.js') .pipe(filenames.get('')) .pipe(rename(function(path) { path.basename = filenames.getSync('')[0]; })) .pipe(gulp.dest('./dist/'));
save()
save()
函数会保存获取到的文件名称列表到一个 JavaScript 数据文件中。在使用之前请先确认 Gulp 任务已经包含了所需文件。
gulp.src('./src/*.js') .pipe(filenames.save('files.json') .pipe(gulp.dest('./dist/'));
这个操作将会获取文件名,将其保存到文件 ./dist/files.json
中。
示例
在下面的示例中,我们将获取到所有 JavaScript 文件的文件名,并将其重命名为 example.js
。
-- -------------------- ---- ------- ----- ---- - ---------------- ----- --------- - -------------------------- ----- ------ - ----------------------- -------------------- ---------- - ------ ------------------------- ------------------------ --------------------------- ---------------------------- ---
运行该任务后,所有 JavaScript 文件将会以 example.js
的名称输出到 ./dist
目录下。
总结
gulp-filenames 可以帮助我们快速获取到文件名,并方便地进行重命名和保存。希望该教程对你理解 gulp-filenames 的使用和效果有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedaf1bb5cbfe1ea0610f92