Skip to content
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

feat: add appendData option #336

Merged
merged 2 commits into from
Apr 20, 2020
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
70 changes: 69 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ module.exports = {
options: {
lessOptions: {
strictMath: true,
noIeCompat: true,
},
},
},
Expand Down Expand Up @@ -197,6 +196,75 @@ module.exports = {
};
```

### `appendData`

Type: `String|Function`
Default: `undefined`

AppendData `Less` code after the actual entry file.

This can be useful when you need to rewrite some of your Less variables.:

> ℹ Since you're injecting code, this will break the source mappings in your entry file. Often there's a simpler solution than this, like multiple Less entry files.

#### `String`

```js
module.exports = {
module: {
rules: [
{
test: /\.less$/,
use: [
'style-loader',
'css-loader',
{
loader: 'less-loader',
options: {
appendData: `@env: ${process.env.NODE_ENV};`,
},
},
],
},
],
},
};
```

#### `Function`

```js
module.exports = {
module: {
rules: [
{
test: /\.less$/,
use: [
'style-loader',
'css-loader',
{
loader: 'less-loader',
options: {
appendData: (loaderContext) => {
// More information about available properties https://webpack.js.org/api/loaders/
const { resourcePath, rootContext } = loaderContext;
const relativePath = path.relative(rootContext, resourcePath);

if (relativePath === 'styles/foo.less') {
return '@value: 100px;';
}

return '@value: 200px;';
},
},
},
],
},
],
},
};
```

### `sourceMap`

Type: `Boolean`
Expand Down
30 changes: 23 additions & 7 deletions src/getLessOptions.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import os from 'os';

import clone from 'clone';

import createWebpackLessPlugin from './createWebpackLessPlugin';
Expand All @@ -13,6 +11,26 @@ import createWebpackLessPlugin from './createWebpackLessPlugin';
* @returns {Object}
*/
function getLessOptions(loaderContext, loaderOptions, content) {
function prependData(target, addedData) {
if (!addedData) {
return target;
}

return typeof addedData === 'function'
? `${addedData(loaderContext)}\n${target}`
: `${addedData}\n${target}`;
}

function appendData(target, addedData) {
if (!addedData) {
return target;
}

return typeof addedData === 'function'
? `${target}\n${addedData(loaderContext)}`
: `${target}\n${addedData}`;
}

const options = clone(
loaderOptions.lessOptions
? typeof loaderOptions.lessOptions === 'function'
Expand All @@ -21,11 +39,9 @@ function getLessOptions(loaderContext, loaderOptions, content) {
: {}
);

const data = loaderOptions.prependData
? typeof loaderOptions.prependData === 'function'
? loaderOptions.prependData(loaderContext) + os.EOL + content
: loaderOptions.prependData + os.EOL + content
: content;
let data = content;
data = prependData(data, loaderOptions.prependData);
data = appendData(data, loaderOptions.appendData);

const lessOptions = {
plugins: [],
Expand Down
11 changes: 11 additions & 0 deletions src/options.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@
}
]
},
"appendData": {
"description": "Add `Less` code after the actual entry file (https://github.com/webpack-contrib/less-loader#postponeddata).",
"anyOf": [
{
"type": "string"
},
{
"instanceof": "Function"
}
]
},
"sourceMap": {
"description": "Enables/Disables generation of source maps (https://github.com/webpack-contrib/less-loader#sourcemap).",
"type": "boolean"
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/less/append-data.less
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
@color1: red;

.background {
color: @color1;
}
20 changes: 20 additions & 0 deletions test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,26 @@ test('should prepend data', async () => {
expect(css).toEqual('.background {\n color: red;\n}\n');
});

test('should append data', async () => {
const loaderOptions = {
appendData() {
return `@color1: coral;`;
},
};

let inspect;

const rules = moduleRules.basic(loaderOptions, {}, (i) => {
inspect = i;
});

await compile('append-data', rules).catch((e) => e);

const [css] = inspect.arguments;

expect(css).toEqual('.background {\n color: coral;\n}\n');
});

test('should allow a function to be passed through for `lessOptions`', async () => {
await compileAndCompare('import-paths', {
lessLoaderOptions: {
Expand Down