怎么编写一个 webpack loader

  • 编写 loader 前需要知道 webpack loader 的执行循序?

    • 从右到左执行。
  • 为什么 webpack 的 loader 执行循序是从右到左

    • 因为 webpack 中是采用 Compose 的执行方式,Compose 是从右向左执行

loader-runner

  • loader-runner 允许在不安装 webpack 的情况下运行 loaders

作用

  • 作为 webpack 的依赖,webpack 中使用它执行 loader
  • 进行 loader 的开发和调试

利用 loader-runner 编写一个 demo loader

  • npm i loader-runner
// run.loader.js
const { runLoaders } = require('loader-runner')

const fs = require('fs')
const path = require('path')

runLoaders({
  resource: path.join(__dirname, './src/demo.txt'),
  loaders: [ path.join(__dirname, './src/loader.js')],
  context: {
    minimize: true
  },
  readResource: fs.readFile.bind(fs)
}, (err, result) => {
  console.log(result)
})
//loader.js
const json = JSON.stringify(source)
    .replace(/\u2028/g, '\\u2028')
    .replace(/\u2029/g, '\\u2029');

return `export default ${json}`

利用 loader-utils 获取 loader 参数

  • npm run loader-utils
// run.loader.js
const { runLoaders } = require('loader-runner')

const fs = require('fs')
const path = require('path')

runLoaders({
  resource: path.join(__dirname, './src/demo.txt'),
  loaders: [
    {
      loader: path.join(__dirname, './src/loader.js'),
      options: {
        name: '哈哈'
      }
    }
  ],
  context: {
    minimize: true
  },
  readResource: fs.readFile.bind(fs)
}, (err, result) => {
  console.log(result)
})
// loader.js
const loaderUtils = require('loader-utils')
const fs =  require('fs')
const path = require('path')

module.exports = function(source) {
  const { name } = loaderUtils.getOptions(this)
  // this.cacheable(false)
  console.log('name 参数-->', name)
  // 异步读取
  // const callback = this.async()
  const json = JSON.stringify(source)
    .replace(/\u2028/g, '\\u2028')
    .replace(/\u2029/g, '\\u2029');
  // return `export default ${json}`

  // fs.readFile(path.join(__dirname, './async.txt'), 'utf-8', (err, data) => {
  //   callback(err, data)
  // })
  // 第一个参数是抛出异常
  this.callback(null, json)
}

loader 同步抛出异常

  • throw new Error 抛出异常
  • 通过 this.callback 传递错误
  this.callback(err, conent, sourceMap?: SourceMap, meta?: any)

loader 抛出异步异常

  • 通过 this.async 来返回一个异常函数
    • 第一个参数是 Error,第二个参数是处理的结果
  • 例如:读一个文件
// loader.js
const loaderUtils = require('loader-utils')
const fs =  require('fs')
const path = require('path')

module.exports = function(source) {
  const { name } = loaderUtils.getOptions(this)
  // 异步读取
  const callback = this.async()
  fs.readFile(path.join(__dirname, './async.txt'), 'utf-8', (err, data) => {
    callback(err, data)
  })
}

loader 中使用缓存

  • webpack 中默认开启 loader 缓存

    • 可以使用 this.cacheable(false) 关掉缓存
  • 缓存条件:loader 的结果在相同的输入下有确定的输出

    • 有依赖的 loader 无法使用缓存

loader deom github

编写一个雪碧图 loader

  • 利用了 spritesmith 这个库
const fs = require('fs')
const path = require('path')
const Spritesmith = require('spritesmith')
module.exports = function (source) {
  const callback = this.async()
  // 匹配路径
  const imgs = source.match(/url\((\S*)\?_sprite/g)

  console.log('imgs --', imgs)

  const matchedImgs = []
  for (let i = 0; i < imgs.length; i++) {
    // 分别取出图片的路径
    const img = imgs[i].match(/url\((\S*)\?_sprite/)[1]
    matchedImgs.push(path.join(__dirname, img))    
  }

  Spritesmith.run({
    src: matchedImgs
  }, (err, result) => {
    // 把合成后雪碧图 写入到 目标文件中
    fs.writeFileSync(path.join(process.cwd(), 'build/sprite.jpg'), result.image)

    // 匹配 css 文件,替换图片 url 地址
    source = source.replace(/url\((\S*)\?_sprite/g, () => {
      return `url('build/sprite.jpg'`
    })
    // 将替换后的文件,写入到 目标文件中
    fs.writeFileSync(path.join(process.cwd(), 'build/index.css'), source)

    callback(null, source)
  })
}

prites-loader github

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容