https://github.com/outstand/esbuild-postcss-plugin
https://github.com/outstand/esbuild-postcss-plugin
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/outstand/esbuild-postcss-plugin
- Owner: outstand
- License: mit
- Fork: true (kib357/esbuild-postcss-plugin)
- Created: 2022-09-19T20:17:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-25T19:18:06.000Z (over 3 years ago)
- Last Synced: 2025-03-19T23:09:53.777Z (about 1 year ago)
- Size: 102 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESBuild plugin for PostCSS with CSS modules
This plugin for postcss built with intention to create fast, high-performance, reliable and tested solution to ESBuild with postcss and post-css modules
## Installation
```
npm i esbuild-postcss-plugin
```
## Usage
Add plugin to ESBuild build config
```typescript
const postCSSPlugin = require("esbuild-postcss-plugin");
plugins: [postCSSPlugin()];
```
## Options
### filter
A regular expression to filter source files processed by plugin
**Default**: `/\.css$/`
```typescript
postCSSPlugin({ filter: /\.css$/ });
```
### disableCache
Cache gives more speed on rebuild. Unfortunately, in cases when postcss transform result depends on other files, cache will cause incorrect behavior. For example, tailwindcss scans template files to build final CSS, and changes in templates require CSS cache invalidation.
**Default**: `false`
```typescript
postCSSPlugin({ disableCache: true });
```
### modulesFilter
A regular expression to filter source files processed with postcss-modules
**Default**: `/\.module.css$/`
```
postCSSPlugin({ modulesFilter: /\.module.css$/ })
```
### modulesOptions
See postcss-modules package options: https://github.com/madyankin/postcss-modules
**Warning!** `Loader`, `resolve` and `root` options will be ignored.
**Default**: `empty`
```
postCSSPlugin({
modulesFilter: /\.css$/,
modulesOptions: {
globalModulePaths: [/index.css$/],
}
})
```
### plugins
List of AcceptedPlugin for postcss.
**Default**: `[]`
```
postCSSPlugin({
plugins: [require("autoprefixer")]
})
```