types(postcss): enhance PostCSS PluginOptions with default tags and configuration examples
This commit is contained in:
parent
ce0bb58124
commit
5c88d71ef9
1 changed files with 37 additions and 2 deletions
|
|
@ -53,19 +53,54 @@ export type PluginOptions = {
|
|||
/**
|
||||
* The base directory to scan for class candidates.
|
||||
*
|
||||
* Defaults to the current working directory.
|
||||
* @default process.cwd()
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* export default {
|
||||
* plugins: {
|
||||
* '@tailwindcss/postcss': {
|
||||
* base: './src',
|
||||
* },
|
||||
* },
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
base?: string
|
||||
|
||||
/**
|
||||
* Optimize and minify the output CSS.
|
||||
*
|
||||
* @default true in production, false in development
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* export default {
|
||||
* plugins: {
|
||||
* '@tailwindcss/postcss': {
|
||||
* optimize: { minify: true },
|
||||
* },
|
||||
* },
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
optimize?: boolean | { minify?: boolean }
|
||||
|
||||
/**
|
||||
* Enable or disable asset URL rewriting.
|
||||
*
|
||||
* Defaults to `true`.
|
||||
* @default true
|
||||
*
|
||||
* @example
|
||||
* ```js
|
||||
* export default {
|
||||
* plugins: {
|
||||
* '@tailwindcss/postcss': {
|
||||
* transformAssetUrls: false,
|
||||
* },
|
||||
* },
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
transformAssetUrls?: boolean
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue