Skip to content

feat: Include the sourceMappingURL & sourceURL when toString() #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,33 @@ They are not enabled by default because they expose a runtime overhead and incre
}
```

### toString

You can also use the css-loader results directly as string, such as in Angular's component style.

**webpack.config.js**

```js
{
   test: /\.css$/,
   use: [
     {
       loaders: ['to-string-loader', 'css-loader']
     }
   ]
}
```

or

```js
const cssText = require('./test.css').toString();

console.log(cssText);
```

If there are SourceMaps, they will also be included in the result string.

### ImportLoaders

The query parameter `importLoaders` allow to configure which loaders should be applied to `@import`ed resources.
Expand Down
26 changes: 19 additions & 7 deletions lib/css-base.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@ module.exports = function() {

// return the list of modules as css string
list.toString = function toString() {
var result = [];
for(var i = 0; i < this.length; i++) {
var item = this[i];
return this.map(function (item) {
const content = cssWithMappingToString(item);
if(item[2]) {
result.push("@media " + item[2] + "{" + item[1] + "}");
return "@media " + item[2] + "{" + content + "}";
} else {
result.push(item[1]);
return content;
}
}
return result.join("");
}).join("");
};

// import a list of modules into the list
Expand Down Expand Up @@ -48,3 +46,17 @@ module.exports = function() {
};
return list;
};

function cssWithMappingToString(item) {
var content = item[1] || '';
var cssMapping = item[3];
if (!cssMapping) {
return content;
}
var convertSourceMap = require('convert-source-map');
var sourceMapping = convertSourceMap.fromObject(cssMapping).toComment({multiline: true});
var sourceURLs = cssMapping.sources.map(function (source) {
return '/*# sourceURL=' + cssMapping.sourceRoot + source + ' */'
});
return [content].concat(sourceURLs).concat([sourceMapping]).join('\n');
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
],
"dependencies": {
"babel-code-frame": "^6.11.0",
"convert-source-map": "^1.3.0",
"css-selector-tokenizer": "^0.7.0",
"cssnano": ">=2.6.1 <4",
"loader-utils": "^1.0.2",
Expand Down
12 changes: 12 additions & 0 deletions test/cssBaseTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,16 @@ describe("css-base", function() {
"@media print{body { d: 4; }}" +
"@media screen{body { a: 1; }}");
});
it("should toString with source mapping", function() {
var m = base();
m.push([1, "body { a: 1; }", "", {
file: "test.scss",
sources: [
'./path/to/test.scss'
],
mappings: "AAAA;",
sourceRoot: "webpack://"
}]);
m.toString().should.be.eql("body { a: 1; }\n/*# sourceURL=webpack://./path/to/test.scss */\n/*# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJmaWxlIjoidGVzdC5zY3NzIiwic291cmNlcyI6WyIuL3BhdGgvdG8vdGVzdC5zY3NzIl0sIm1hcHBpbmdzIjoiQUFBQTsiLCJzb3VyY2VSb290Ijoid2VicGFjazovLyJ9 */");
});
});