@rfgamaral/parcel-plugin-typings-for-css-modules

A plugin for the Parcel bundler to generate .d.ts (TypeScript type definitions) files for your CSS Modules, powered by typed-css-modules.

Installation

Just use your favorite 📦 package manager to install the plugin in your project's devDependencies:

npm:

npm install --save-dev @rfgamaral/parcel-plugin-typings-for-css-modules

Yarn:

yarn add --dev @rfgamaral/parcel-plugin-typings-for-css-modules

Usage

Parcel will handle everything for you automagically, just make sure it's configured to use PostCSS with CSS Modules by adding a .postcssrc file to your project root with:

{
    "modules": true
}

This plugin also includes support for naming local class names in camelCase, just pass the { camelCase: true } option to the .postcssrc file, like so:

{
    "modules": true,
    "plugins": {
        "postcss-modules": {
            "camelCase": true
        }
    }
}

Note: With camelCase option set to true, only kebab-case class names will be converted to camelCase, PascalCase class names will remain as is.

Credits

This plugin borrows heavily from the follwing similar Parcel plugins:

• parcel-plugin-css-modules-type-generator
• parcel-plugin-typed-css-modules

Thank you @garthenweb and @Place1 🙏

License

The use of this source code is governed by an MIT-style license that can be found in the LICENSE file.