在前端开发中，经常会遇到需要把项目打包、部署等，而在此过程中，文件目录结构的规范化变得尤其重要。而这时，我们需要一个能够帮助我们把文件目录结构扁平化的工具 – npm 包 flatten-dirname。
npm 包 flatten-dirname 使用方法
安装 flatten-dirname
在开始使用 flatten-dirname 之前，我们需要先安装它。可以在命令行中执行以下命令：
npm install flatten-dirname --save-dev
使用 flatten-dirname
基本用法
当我们需要把项目中的文件扁平化时，我们需要使用 flatten-dirname 来处理文件目录结构。flatten-dirname 接受一个参数作为项目的根目录，然后把整个项目的文件目录重新整理，把所有文件移动到根目录下，文件名按照原来的路径分隔符分割后拼接而成。
举个例子，如果我们有以下目录结构：
-- -------------------- ---- ------- --- --- - --- -------- - --- ----- - --- ------- - --- -------- --- --- - --- ---- - --- ---- --- ------------ --- ---------
执行以下代码：
const flattenDirname = require('flatten-dirname');
flattenDirname('./');执行完毕后，我们得到以下新的目录结构：
├── index.js ├── test.js ├── test2.js ├── a.js ├── b.js ├── package.json └── README.md
目标目录
默认情况下 flatten-dirname 会把所有的文件都扁平移到项目根目录下，但是我们可以指定一个目标目录，使得扁平化后的文件都被放到这个目标目录下。
flattenDirname('./', './dist');执行后，扁平化后的文件就会被放到 dist 目录下。
排除指定文件
如果我们需要排除项目中的某些文件不参与扁平化，该怎么办呢？可以在 options 中传入 exclude 参数，exclude 接收一个正则表达式，匹配到的路径都会被排除在扁平化处理之外。
举个例子，我们需要排除掉所有名字为 README.md 的文件：
flattenDirname('./', null, {
exclude: /README\.md/
});映射新的文件名
在扁平化文件的时候，有时候我们并不希望使用原来的文件名，我们希望能够使用一些规则根据原来的路径，生成一个新的文件名。这时，可以传入一个 rename 回调函数，rename 函数接收一个参数 (filePath)，表示将要被重命名的文件的完整路径，我们需要在这个回调函数中返回一个新的文件名。
下面是一个例子，我们需要将原来的 a.js 重命名为 a.min.js：
-- -------------------- ---- -------
----- ---- - ----------------
-------------------- ----- -
------- -------- -- -
-- ------------------------ --- ------- -
------ -----------
-
------ ------------------------
-
---特殊情况
在使用 flatten-dirname 的过程中，有一些特殊情况需要注意：
- 如果有同名文件，后面的文件会覆盖前面的文件。
- 如果有同名文件夹和文件，会把同名文件夹中的所有文件扁平到被覆盖的同名文件中。由于这个情况很容易造成文件丢失，因此在使用 flatten-dirname 的时候需要特别注意这个问题。
结语
flatten-dirname 是一个非常有用的 npm 包，这个包可以帮助我们很方便地扁平化项目目录结构，使得我们的项目更加规范化，并且可以更方便地打包和部署。在使用这个包的时候，需要注意一些特殊情况，特别是同名文件夹和文件的情况容易造成文件丢失，因此在使用的时候需要特别小心。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005543281e8991b448d1876