IT技术

前端工程化~强大的glob语法

2020-09-30  本文已影响0人  WEB前端含光

glob 在正则出现之前就有了,主要用于匹配文件路径,例如大名鼎鼎的 gulp 就使用了 glob 规则来匹配、查找并处理各种后缀的文件。在前端工程化的过程中,不可避免地会用 Node.js 来读取文件,例如想找到 src 目录下所有 jsjsx 文件,代码应该怎么写呢?首先安装依赖包:

yarn add glob

然后 3 行代码搞定:

const glob = require('glob')
const files = glob.sync('src/**/*.js{,x}')
console.log(files)

有没有感觉很强大呢?更重要的是 glob 语法在命令行就支持,不需要安装任何依赖,例如老板让你创建 a1.jsa9.jsb1.jsb9.js 这 18 个测试文件的话,怎么操作?一个个创建的话太傻了,glob 一句话就搞定:

$ touch {a,b}{1..9}.js
$ ls
a1.js a3.js a5.js a7.js a9.js b2.js b4.js b6.js b8.js
a2.js a4.js a6.js a8.js b1.js b3.js b5.js b7.js b9.js

更更更重要的是,glob 的语法非常简单,只要记住下面7个符号代表的含义就能掌握了:

接下来就逐个解释一下:

基础语法

分隔符和片段

概念:分隔符是/,通过split('/') 得到的数组每一项是片段。

示例:

单个星号

概念:单个星号* 用于匹配单个片段中的零个或多个字符。

示例

需要注意的是,* 不能匹配分隔符/,也就是说不能跨片段匹配字符。

问号

概念:问号 ?匹配单个片段中的单个字符。

示例

中括号

概念:同样是匹配单个片段中的单个字符,但是字符集只能从括号内选择,如果字符集内有-,表示范围。

示例:

惊叹号

概念:表示取反,即排除那些去掉惊叹号之后能够匹配到的文件。
示例:

扩展语法

基础语法非常简单好记,但是功能非常局限,为了丰富 glob 的功能,衍生了下面三种扩展语法:

两个星号

概念:两个星号** 可以跨片段匹配零个或多个字符,也就是说**是递归匹配所有文件和目录的,如果后面有分隔符,即 **/ 的话,则表示只递归匹配所有目录(不含隐藏目录)。

示例:

大括号

概念:匹配大括号内的所有模式,模式之间用逗号进行分隔,支持大括号嵌套,支持用.. 匹配连续的字符,即{start..end} 语法。

示例:

注意:{}[] 有一个很重要的区别:如果匹配的文件不存在,[]会失去模式的功能,变成一个单纯的字符串,而 {} 依然可以展开。

小括号

概念:小括号必须跟在 ?*+@! 后面使用,且小括号里面的内容是一组以 | 分隔符的模式集合,例如:abc|a?c|ac*

示例:

应用场景

webpack 多页面应用自动打包配置

在一个 webpack 项目中,假如我们有多个入口,每个入口都有一个 index.html 模板和 index.js 文件,而且这个入口是动态变化的,不希望每增加一个入口就改 webpack.config.js 配置文件,应该怎么办呢?

此时可以约定在 src 下面创建的文件夹,只要里面有 index.js,我们就把它当做一个入口文件进行打包:

src
├── detail
│   ├── index.html
│   └── index.js
├── home
│   ├── index.html
│   └── index.js
├── login
│   ├── index.html
│   └── index.js
├── shop
│   ├── index.html
│   └── index.js

用 glob 很快就能写出下面的自动打包代码:

const HtmlWebpackPlugin = require('html-webpack-plugin')
const path = require('path')
const glob = require('glob')

// 动态生成 entry 和 html-webpack-plugin
function getMpa() {
  const entry = {}, htmlPlugins = []
  const files = glob.sync('src/*/index.js')
  files.forEach((file) => {
    const filename = file.split('/')[1]
    entry[filename] = path.join(__dirname, file)
    htmlPlugins.push(
      new HtmlWebpackPlugin({
        template: path.join(__dirname, `src/${filename}/index.html`),
        filename: `${filename}.html`,
        chunks: [filename],
      })
    )
  })
  return { entry, htmlPlugins }
}
const mpa = getMpa()

// 动态的配置文件
module.exports = {
  entry: mpa.entry,
  output: {
    path: path.join(__dirname, 'dist'),
    filename: '[name]-[hash:6].js',
  },
  plugins: [...mpa.htmlPlugins],
}

这样,无论增加多少个入口,webpack.config.js 都不用变。

手写一个约定大于配置的 Node.js 框架

egg.js 是一款优秀的 Node.js 企业级开发框架,就应用了约定大于配置的思想,例如:

因为一个大规模的团队需要遵循一定的约束和约定,开发效率才更高,有了这些约定之后,我们就可以利用 glob 写出匹配规则,找到用户放到指定目录下的文件并进行动态加载了,一个最基础的 load 函数如下:

function load(folder, options) {
    const extname = options.extname || '.{js,ts}'
    return glob.sync(require('path').join(folder, `./**/*.js`)).forEach((item) => require(item))
}

使用 glob,配合相应的规范,例如 RESTful,我们自己也能封装一个简易的、基于约定的 Node.js 框架了。

放在最后

赠与小伙伴们的一点点小福利~

上一篇 下一篇

猜你喜欢

热点阅读