如果你是一名前端开发者，那么你肯定知道 npm。npm 是一个流行的包管理工具，用于在 Node.js 环境中管理 JavaScript 模块。npm 提供了丰富的工具和包，可以使我们更高效地开发应用程序。其中一个有用的 npm 包是 urbanjs-tool-check-file-names，它可以帮助我们检查项目中文件的命名规范，从而使我们的代码更加整洁和易于维护。
urbanjs-tool-check-file-names 简介
urbanjs-tool-check-file-names 是一个基于 urbanjs-tools 的 npm 包，它可以自定义文件名的规范，并在打包过程中检查项目中所有文件名是否符合规范。如果文件名不合规，则会中断打包过程并输出错误信息。
urbanjs-tool-check-file-names 可以帮助我们创建更统一的命名规范，并确保所有的命名都符合规范。这个工具可以帮助我们提高代码的可读性和可维护性，减少因文件夹和文件名的混乱带来的烦恼。
urbanjs-tool-check-file-names 安装
在使用 urbanjs-tool-check-file-names 之前，需要先确保已安装 Node.js 和 npm。安装完成后，可以通过以下命令安装 urbanjs-tool-check-file-names：
npm install --save-dev urbanjs-tool-check-file-names
urbanjs-tool-check-file-names 使用方法
已经安装好 urbanjs-tool-check-file-names 后，在项目根目录下创建 urbanjs.yml 文件，并添加以下内容：
tools:
check-file-names:
# 这里可以自定义规范
patterns:
# 文件夹名必需以小写字母开头、使用中划线分隔
directory: /^[a-z]+(-[a-z]+)*$/
# 文件名必需使用驼峰命名法
filename: /^[a-z]+([A-Z][a-z]*)*$/上述配置中，我们为规定项目中文件夹和文件名的命名规范。文件夹名必须以小写字母开头，使用中划线来进行分隔。文件名必须使用驼峰命名法。
在配置完成后，可以运行以下命令来检查文件名是否符合规范：
npm run check-file-names
如果检测到有文件名不符合规范，则会输出以下错误信息：
Error Invalid file names: Error ui-Element should match pattern /^[a-z]+([A-Z][a-z]*)*$/
这样一来，我们就可以查看一下哪些文件不符合我们定义的规范，然后对它们进行修改。这样一来，我们的项目就变得更加整洁和易于维护了。
urbanjs-tool-check-file-names 示例代码
以下是一个示例代码，用来说明如何使用 urbanjs-tool-check-file-names 包。
-- -------------------- ---- -------
-- -----------------
----- - -------------------- - - ----------------------------------
----- -------------- - -----------------------------------------
-------------- - -
-- --- -
-------- -
--- ----------------------
------ -
-- ---------------------------
------------------- -
--------- -
---------- --------
--------- ----------------------------------
--
------- -
---------- ----------------
--------- --------------
-
-
-
--
-
--在定义 checker；'check-file-names'时，配置 patterns 和 ignore 表示 checker 向对应的源码目录和文件名做检查。patterns 和 ignore 中，使用的是正则表达式，用来匹配文件名或文件夹名。
在配置完成后，我们可以使用下面的命令运行示例：
npm install urbanjs-tool-check-file-names urbanjs-webpack-plugin -D
这样一来，我们就可以检查项目中所有文件的命名是否符合规范了。
总的来说，urbanjs-tool-check-file-names 是一个非常有用的 npm 包，可以帮助我们制定更好的命名规范，并保证所有的命名都符合规范。不仅能够让我们的代码更具可读性和可维护性，还能提高我们的开发效率。希望本文能够帮助你更好的使用 urbanjs-tool-check-file-names 包，从而为前端开发提供更好的体验和效果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562c981e8991b448e00e1