Skip to content

Vite Plugin
Readable Classnames
Make your scoped CSS module class names clear and readable

This plugin automatically adds the module filename and other useful info to class names for easier development.

Getting Started

Add the plugin to your project using your favorite package manager!

sh
npm install -D vite-plugin-readable-classnames
sh
yarn add -D vite-plugin-readable-classnames
sh
pnpm add -D vite-plugin-readable-classnames
sh
bun add -d vite-plugin-readable-classnames

Migration from vite-plugin-pretty-module-classnames

vite-plugin-readable-classnames is the new identity for vite-plugin-pretty-module-classnames. This guide will help you migrate from vite-plugin-pretty-module-classnames to vite-plugin-readable-classnames.

  1. Uninstall the old plugin and install the new one
sh
npm uninstall vite-plugin-pretty-module-classnames
npm install -D vite-plugin-readable-classnames
sh
yarn remove vite-plugin-pretty-module-classnames
yarn add -D vite-plugin-readable-classnames
sh
pnpm remove vite-plugin-pretty-module-classnames
pnpm add -D vite-plugin-readable-classnames
sh
bun remove vite-plugin-pretty-module-classnames
bun add -d vite-plugin-readable-classnames
  1. Update the import and plugin usage in your vite.config.js or vite.config.ts
ts
import { defineConfig } from 'vite'
import prettyModuleClassnames from 'vite-plugin-pretty-module-classnames'
import readableClassnames from 'vite-plugin-readable-classnames'

export default defineConfig {
  plugins: [prettyModuleClassnames()], 
  plugins: [readableClassnames()], 
}

Released under the MIT License.