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編譯出來的結果。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 無意中看到zhangwnag大佬分享的webpack教程感覺受益匪淺,特此分享以備自己日后查看,也希望更多的人看到...
    小小字符閱讀 8,227評論 7 35
  • GitChat技術雜談 前言 本文較長,為了節省你的閱讀時間,在文前列寫作思路如下: 什么是 webpack,它要...
    蕭玄辭閱讀 12,715評論 7 110
  • 最近在學習 Webpack,網上大多數入門教程都是基于 Webpack 1.x 版本的,我學習 Webpack 的...
    My_Oh_My閱讀 8,209評論 40 247
  • 《紫薇花開了》 那一樹花是什么時候開的 昨夜我還在它的脈河里游泳 去年的秋波忘了蕩漾 致使一個冬天筋絡漲的又酥又麻...
    陳皮朵娃閱讀 399評論 0 0
  • 沒有風的院子 陽光安靜地灑滿每個角落 公婆坐在陽光里 晾曬著屬于他們的慈祥 時間 變得溫柔似水 院子里捉蟲的雞 成...
    明月穿行閱讀 342評論 2 6