在前端开发的工作中，我们经常需要对多个 JavaScript 文件进行合并，或者需要给 Javascript 文件添加一些版权信息或者其他的头信息。这时，一个能够自动添加头信息的 npm 包就显得格外重要。本篇文章将介绍 npm 包 @gerhobbelt/prepend-header 这一工具的使用方法。
什么是 @gerhobbelt/prepend-header
@gerhobbelt/prepend-header 是一个 npm 包，用来往文件的头部写入内容。其主要作用是方便我们在工程化的项目中，快速添加头信息。使用此包编写脚本也比较容易，而且功能丰富，支持多种功能。它可以将一个或多个文件的开头添加一个头部注释或文字，具有可配置的升级选项、覆盖行数以及可以选择性地仅在文件不存在时添加头文件等等功能。
如何使用 @gerhobbelt/prepend-header
安装
使用 npm 安装 @gerhobbelt/prepend-header，我们可以利用 npm来安装它。
npm install -g @gerhobbelt/prepend-header
使用
@gerhobbelt/prepend-header 的使用方法主要有以下几种：
1. 将头信息添加到一个文件
执行以下命令可以将头信息添加到 file.js 中，并且将处理后的文件放到 current_folder/output/file.js 中。
prepend-header -f file.js -o current_folder/output/file.js
2. 将头信息同时添加到多个文件
执行以下命令可以将头信息添加到多个文件，并将处理后的文件放到 output 目录中。
prepend-header -f js/*.js -o output
3. 指定添加的头信息
执行以下命令可以指定要添加的头信息，并且将处理后的文件放到 output 文件中。
prepend-header -f file.js -o output --header "var name = 'name'"
示例代码
以下是一个实际的使用，将指定文件中的头部注释掉。
-- -------------------- ---- -------
-- ------
----- ------ - --------------------------------------
----- -- - --------------
-- ----
--- -------- - ------------
--- -------- - ------------------------- ---------
-- ----
--- --- - ---------------------
--- --------- - ------
--- ---- - - -- - - ----------- ---- -
-- ------------------------------------------- -
--------- - -----
-
-- ----------- -
------ - ---
-
-- ----------------------------------------- -
--------- - ------
-
-
-------- - ---------------
-- ------
--- ---------- - ---- ---- -- - -------
-
- -------- --------
- ------ ----------
- ----- -------- --- --------
- ----- -------- ----- ----------
- ------------- --- ---- -- ------
--
--
--- ----------- - ------------------ ---------------------
-- ----
--- ------- - ---------------
------------------------- -------------
----------------- -- ------- -- -------------总结
使用 @gerhobbelt/prepend-header 能够帮助我们快速地给多个 JavaScript 文件添加头信息。使用此包能够使得我们更加便捷地维护和开发大型的工程化项目。本文主要介绍了该 npm 包如何安装和使用，并提供了一个示例代码，希望能对读者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f02cac7403f2923b035bd99