Webpack Loader源码导读之less-loader

原文地址:http://hiihl.com/articles/2018/1/17/lessloader.md

本篇是Webpack Loader源码导读系列中关于less-loader的解读,主要阐述loader的工作,less编译部份的内容未来将单独讲解。

源码结构

源码 v4.0.5,src目录如下:

src
|____cjs.js
|____createWebpackLessPlugin.js
|____formatLessError.js
|____getOptions.js
|____index.js
|____processResult.js
|____removeSourceMappingUrl.js
|____stringifyLoader.js

options说明

进入index.js首先看到的是getOptions(loaderContext),这一步的作用是将webpack相关配置及loader的query或options部份配置合并,得到编译过程的可选项

  • paths 模块解析的路径,默认使用webpack的resolver,必须是个绝对路径数组;举例,在less中我们想引用node_modules下bootstrap的less文件,可以这样写
    @import "~bootstrap/less/bootstrap";,默认的模块解析将和webpack一致,但如果loader配置paths,则webpack的解析路径和alias配置在这里将无效。
  • plugins 数组,编译时使用的插件,已有的插件见plugins
  • sourceMap 源码映射,需要同css-loader一同配置;可以是boolean类型,也可以是对象,sourceMap相关配置如下:
    • {String} sourceMapFilename,对应lessc中属性值为String的--source-map选项;
    • {String} sourceMapRootPath,对应lessc的--source-map-rootpath选项;
    • {String} sourceMapURL,对应lessc的--source-map-url选项;
    • {String} sourceMapBasePath,对应lessc的--source-map-basepath选项;
    • {Boolean} sourceMapLessInline 对应lessc的--source-map-less-inline选项;
    • {Boolean} sourceMapMapInline 对应lessc的--source-map-map-inline选项;
    • {Boolean} outputSourceFiles 对应lessc的--source-map-map-inline选项;注意在less-loader中会将该值默认设置成true

less-loader其他的配置,都可以从less的配置选项中找到,全部转成驼峰式即可。

有两个重要的配置globalVarsmodifyVars,这两个是用于添加或修改less变量的,一起看个例子。

main.less

@import "./other.less";

.box:extend(.hotpink) {
  width: @boxWidth;
  height: @boxHeight;
}

other.less

@boxHeight: 10px;

.hotpink {
  background: hotpink;
  width: @boxWidth;
}

上面的例子中,other.less中定义了变量@boxHeight在main.less中会使用到,值为10px;main.less和other.less中都使用到了@boxWidth,但是并没有定义;
现在我们在webpack.config.js中配置

{
  loader: "less-loader",
  query: {
    sourceMap: true,
    globalVars: {
      "boxWidth": '200px'
    },
    modifyVars: {
      "boxHeight": '200px'
    }
  }
}

最后编译没有出错,结果为

.hotpink,
.box {
  background: hotpink;
  width: 200px;
}
.box {
  width: 200px;
  height: 200px;
}

在这个例子中,globalVars的作用相当于给每个less文件顶部增加一行@boxWidth: 200px,所以编译出来的width都为200px,而modifyVars的作用相当于在
每个文件底部增加一行@boxHeight: 200px,这样就会覆盖已有的@boxHeight: 10px,所以最后编译出来的height是200px而不是10px;

这有什么作用呢?
有了这两个配置项,我们就可以把部份样式抽出变量,通过不同的变量组合成不同的主题,例如:
default.less

@primary-color: #003cee;

themes/pink.js

module.exports = {
  "@primary-color": 'pink'
};

webpack.config.js

{
  loader: 'less-loader',
  query: {
    modifyVars: require('./themes/pink')
  }
}

loader中解析了配置以后,就直接调用了less的render方法进行编译,render方法有三个入参var render = function (input, options, callback)
第三个参数是个callback,看render.js源码可以知道,如果不传callback,则render方法会返回一个promise。

编译结果处理

看下processResult.js如何处理编译结果,resultPromise就是前面提到的render返回的promise。

function processResult(loaderContext, resultPromise) {
  const { callback } = loaderContext;

  resultPromise
    .then(({ css, map, imports }) => {
      imports.forEach(loaderContext.addDependency, loaderContext);
      return {
        // Removing the sourceMappingURL comment.
        // See removeSourceMappingUrl.js for the reasoning behind this.
        css: removeSourceMappingUrl(css),
        map: typeof map === 'string' ? JSON.parse(map) : map,
      };
    }, (lessError) => {
      throw formatLessError(lessError);
    })
    .then(({ css, map }) => {
      callback(null, css, map);
    }, callback);
}

编译后的结果包括css,map和imports三个,css是less编译成的css内容,map则是sourceMap相关信息,imports是编译过程中所有的依赖文件路径。
拿到编译结果后,首先是调用addDependency把所有imports中的文件添加到依赖里面,这个方法的作用时在watch模式时,依赖的这些文件变化时会出发编译更新。
然后是removeSourceMappingUrl(css),这个方法的作用是移除结果中的sourceMappingURL=,理由是less-loader无法知道最终的sourceMap会在哪里。
最后调用callback(null, css, map)把结果传给下一个loader去执行,less-loader的的工作就完成了。

下一篇我们将继续将css-loader,如何继续处理less-loader编译出来的结果。

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

推荐阅读更多精彩内容

  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,147评论 7 35
  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,681评论 7 110
  • 最近在学习 Webpack,网上大多数入门教程都是基于 Webpack 1.x 版本的,我学习 Webpack 的...
    My_Oh_My阅读 8,173评论 40 247
  • 《紫薇花开了》 那一树花是什么时候开的 昨夜我还在它的脉河里游泳 去年的秋波忘了荡漾 致使一个冬天筋络涨的又酥又麻...
    陈皮朵娃阅读 385评论 0 0
  • 没有风的院子 阳光安静地洒满每个角落 公婆坐在阳光里 晾晒着属于他们的慈祥 时间 变得温柔似水 院子里捉虫的鸡 成...
    明月穿行阅读 333评论 2 6