/esbuild-style-loader

A style loader for esbuild, support for CSS, SCSS, LESS, Stylus, and CSS Modules.

Primary LanguageTypeScript

esbuild-style-loader

npm version License: MIT issues PRs Welcome downloads Code Coverage Node.js CI

A style loader for esbuild, support for CSS, SCSS, LESS, Stylus, and CSS Modules.

Features

  • Zero configuration
  • Support for CSS Modules
  • Support for LESS builtin
  • Support for CSS
  • Autoprefixer for CSS
    • default: ios >= 11, android >= 5, chrome >= 54
  • Support sourceMap
  • Fast compiler engine by lightningcss

Default behavior

The following rules enable css-modules

  1. The file name ends with /.modules?\.(css|less|scss|sass|styl)/
  2. The file query contains modules or modules=true 
import styles from './style.css?modules';
import styles from './style.module.css';
import styles from './style.modules.css';
import styles from './style.less?modules';
import styles from './style.module.less';
import styles from './style.modules.less';

Normal CSS files are not treated as CSS Modules

import './style.css';
import './style.less';
import styles from './style.css';
import styles from './style.less';

Usage

import { build } from 'esbuild';
import { styleLoader } from 'esbuild-style-loader';

const buildOptions = {
  plugins: [
    styleLoader({
      filter: /\.(css|less|scss|sass|tyss)(\?.*)?$/,
      /**
       * Process file results from other plugins namespace
       */
      namespace: ['native-component', 'file'],
      /**
       * The browser setting for lightningcss
       */
      browsers: 'ios >= 11, android >= 5, chrome >= 54',
      cssModules: {
        pattern: process.env.CI_TEST === 'test' ? '[name]__[local]' : '[local]__[hash]',
      },
      /**
       * The public path for absolute paths in css
       */
      publicPath: __dirname,
    }),
  ],
};

if you want to use absolute paths, you can specify the publicPath option

TODO