@farmfe/js-plugin-postcss
v1.11.0
Published
support postcss for farm.
Downloads
8,272
Readme
Postcss Plugin for Farm
Getting Started
To begin, you'll need to install postcss
and @farmfe/js-plugin-postcss
:
npm install postcss @farmfe/js-plugin-postcss --save-dev
or
yarn add -D postcss @farmfe/js-plugin-postcss
or
pnpm add -D postcss @farmfe/js-plugin-postcss
Configuring the plugin in farm.config.ts
:
import { defineFarmConfig } from '@farmfe/core/dist/config';
import postcss from '@farmfe/js-plugin-postcss'; // import the plugin
export default defineFarmConfig({
compilation: {
input: {
index: './index.html'
},
output: {
path: './build'
}
},
plugins: [
// use the less plugin.
postcss({
// custom options here
})
]
});
Options
lessOptions
Type:
type lessOptions = import('less').options | ((loaderContext: LoaderContext) => import('less').options})
Default: { relativeUrls: true }
Here you can pass any Less specific options to the @farm/js-plugin-less
.See the Less options for any available options you need.
additionalData
Type:
type additionalData =
| string
| ((content: string, resolvePath: string) => string);
Default: undefined
Appends Less
code to the actual entry file.
In this case, the @farm/js-plugin-less
will not override the source but just prepend the entry's content.
In actual development, this becomes useful, we don't need to add new files.
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
export default defineFarmConfig({
compilation: {
input: {
index: './index.html'
},
output: {
path: './build'
}
},
plugins: [
// use the less plugin.
Less({
additionalData: `@hoverColor: #f10215;`
})
]
});
function
export default defineFarmConfig({
compilation: {
input: {
index: './index.html'
},
output: {
path: './build'
}
},
plugins: [
farmLessPlugin({
additionalData: (content: string, resolvePath: string) => {
if (path.basename(resolvePath, '.less') === 'index') {
return `@hoverColor: #f10215;` + content;
}
}
})
]
});
sourceMap
Type: boolean
Default: false
Whether to generate sourceMap
If not set, it will read the compilation.sourcemap configuration in the farm configuration
implementation
Type: string | undefined
Default: undefined
@farm/js-plugin-less
compatible with Less 3 and 4 versions
The special implementation
option determines which implementation of Less to use. If you not config, it will find the less in you local node_modules.