types(postcss): enhance PostCSS PluginOptions with default tags and configuration examples

This commit is contained in:
abdelrhmanahmed 2026-09-27 01:56:34 +03:00
parent ce0bb58124
commit 5c88d71ef9

View file

@ -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
}