Rename the plugin

Author: teplostanski

.github/workflows/codecov.yml

@@ -26,4 +26,4 @@ jobs:
         uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          slug: teplostanski/vite-plugin-pretty-module-classnames
+          slug: teplostanski/vite-plugin-readable-classnames

CONTRIBUTING.md

@@ -1,10 +1,10 @@
-# Contributing to vite-plugin-pretty-module-classnames
+# Contributing to vite-plugin-readable-classnames
 
-We're excited that you're interested in contributing to the `vite-plugin-pretty-module-classnames`! All types of contributions are welcome: bug reports, feature requests, documentation updates, and code improvements.
+We're excited that you're interested in contributing to the `vite-plugin-readable-classnames`! All types of contributions are welcome: bug reports, feature requests, documentation updates, and code improvements.
 
 ## Reporting Bugs
 
-Before reporting a bug, please check if it has already been reported. You can search through existing issues [here](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/issues).
+Before reporting a bug, please check if it has already been reported. You can search through existing issues [here](https://github.com/teplostanski/vite-plugin-readable-classnames/issues).
 
 If you find a new issue and believe it's a bug, please open a new issue. Include as many details as possible, describe the problem, and provide steps to reproduce it, ideally with code or screenshots.
 

README.md

@@ -1,14 +1,14 @@
 English | [Russian](./README.ru.md)
 
 <div align='center'>
-<h1>vite-plugin-pretty-module-classnames</h1>
+<h1>vite-plugin-readable-classnames</h1>
 
-[<img alt="NPM Version" src="https://img.shields.io/npm/v/vite-plugin-pretty-module-classnames?style=flat-square&color=07912E&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM License" src="https://img.shields.io/npm/l/vite-plugin-pretty-module-classnames?style=flat-square&color=D3748F&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM Type Definitions" src="https://img.shields.io/npm/types/vite-plugin-pretty-module-classnames?style=flat-square&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/vite-plugin-pretty-module-classnames?style=flat-square&color=7F78D1&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/teplostanski/vite-plugin-pretty-module-classnames?style=flat-square&labelColor=1f2033">](https://github.com/teplostanski/vite-plugin-pretty-module-classnames)
-[<img alt="Coverage" src="https://codecov.io/gh/teplostanski/vite-plugin-pretty-module-classnames/graph/badge.svg?token=CQY9WXG41L">](https://codecov.io/gh/teplostanski/vite-plugin-pretty-module-classnames)
+[<img alt="NPM Version" src="https://img.shields.io/npm/v/vite-plugin-readable-classnames?style=flat-square&color=07912E&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM License" src="https://img.shields.io/npm/l/vite-plugin-readable-classnames?style=flat-square&color=D3748F&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM Type Definitions" src="https://img.shields.io/npm/types/vite-plugin-readable-classnames?style=flat-square&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/vite-plugin-readable-classnames?style=flat-square&color=7F78D1&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/teplostanski/vite-plugin-readable-classnames?style=flat-square&labelColor=1f2033">](https://github.com/teplostanski/vite-plugin-readable-classnames)
+[<img alt="Coverage" src="https://codecov.io/gh/teplostanski/vite-plugin-readable-classnames/graph/badge.svg?token=CQY9WXG41L">](https://codecov.io/gh/teplostanski/vite-plugin-readable-classnames)
 
 </a>
 
@@ -21,23 +21,23 @@ Included in the <a href='https://github.com/vitejs/awesome-vite'>Awesome Vite.js
 
 ## 📦 Installation
 
-[npmjs.com](https://npmjs.com/package/vite-plugin-pretty-module-classnames) • [yarnpkg.com](https://yarnpkg.com/package?q=vite-plugin-pretty-module-classnames&name=vite-plugin-pretty-module-classnames)
+[npmjs.com](https://npmjs.com/package/vite-plugin-readable-classnames) • [yarnpkg.com](https://yarnpkg.com/package?q=vite-plugin-readable-classnames&name=vite-plugin-readable-classnames)
 
 ```bash
-npm install -D vite-plugin-pretty-module-classnames
+npm install -D vite-plugin-readable-classnames
 
-yarn add -D vite-plugin-pretty-module-classnames
+yarn add -D vite-plugin-readable-classnames
 
-pnpm add -D vite-plugin-pretty-module-classnames
+pnpm add -D vite-plugin-readable-classnames
 
-bun add -d vite-plugin-pretty-module-classnames
+bun add -d vite-plugin-readable-classnames
 ```
 
 ## 🦾 Features
 
 - Framework-agnostic:
   - Tested on projects with ![VanillaJS](https://img.shields.io/badge/Vanilla_JS/TS-%231f2033.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E) ![React](https://img.shields.io/badge/react-%231f2033.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![Vue](https://img.shields.io/badge/vue-%231f2033.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D) <!--![Astro](https://img.shields.io/badge/Astro-%231f2033.svg?style=for-the-badge&logo=astro&logoColor=%23BC52EE)-->
-  - Potentially works with any framework. If you have any problems, write to the [Issue](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/issues)
+  - Potentially works with any framework. If you have any problems, write to the [Issue](https://github.com/teplostanski/vite-plugin-readable-classnames/issues)
 - Universal:
   - Compatible with both `CommonJS` and `ES Modules`
   - Support `Vite 2.x`
@@ -69,27 +69,27 @@ This plugin solves these problems and ensures predictable, readable class naming
 ```js
 // vite.config.js
 // ...
-import prettyModuleClassnames from 'vite-plugin-pretty-module-classnames'
+import readableClassnames from 'vite-plugin-readable-classnames'
 
 export default defineConfig({
-  plugins: [prettyModuleClassnames()],
+  plugins: [readableClassnames()],
 })
 ```
 
 ## 📚 Documentation
 
-For full documentation, visit [vite-plugin-pretty-module-classnames.teplostanski.dev](https://vite-plugin-pretty-module-classnames.teplostanski.dev) [ EN | RU ].
+For full documentation, visit [vite-plugin-readable-classnames.teplostanski.dev](https://vite-plugin-readable-classnames.teplostanski.dev) [ EN | RU ].
 
 ## 🤝 Contributing
 
-Want to contribute? Awesome! To show your support is to star the project, or to raise [issues on GitHub](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/issues).
+Want to contribute? Awesome! To show your support is to star the project, or to raise [issues on GitHub](https://github.com/teplostanski/vite-plugin-readable-classnames/issues).
 
-Before you contribute to the development of the project, read the [rules](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/blob/main/CONTRIBUTING.md).
+Before you contribute to the development of the project, read the [rules](https://github.com/teplostanski/vite-plugin-readable-classnames/blob/main/CONTRIBUTING.md).
 
 Thanks again for your support, it is much appreciated! 🙏
 
 <h2> © License</h2>
-<a href="https://github.com/teplostanski/vite-plugin-pretty-module-classnames/blob/main/LICENSE">MIT</a> License © 2024-2025 <a href="https://github.com/teplostanski">teplostanski</a>
+<a href="https://github.com/teplostanski/vite-plugin-readable-classnames/blob/main/LICENSE">MIT</a> License © 2024-2025 <a href="https://github.com/teplostanski">teplostanski</a>
 
 <h2> ❤ Fund this project</h2>
 <a href="https://donate.teplostanski.dev" target="_blank">donate.teplostanski.dev</a>

README.ru.md

@@ -1,14 +1,14 @@
 Русский | [English](./README.md)
 
 <div align='center'>
-<h1>vite-plugin-pretty-module-classnames</h1>
+<h1>vite-plugin-readable-classnames</h1>
 
-[<img alt="NPM Version" src="https://img.shields.io/npm/v/vite-plugin-pretty-module-classnames?style=flat-square&color=07912E&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM License" src="https://img.shields.io/npm/l/vite-plugin-pretty-module-classnames?style=flat-square&color=D3748F&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM Type Definitions" src="https://img.shields.io/npm/types/vite-plugin-pretty-module-classnames?style=flat-square&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/vite-plugin-pretty-module-classnames?style=flat-square&color=7F78D1&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-pretty-module-classnames)
-[<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/teplostanski/vite-plugin-pretty-module-classnames?style=flat-square&labelColor=1f2033">](https://github.com/teplostanski/vite-plugin-pretty-module-classnames)
-[<img alt="Coverage" src="https://codecov.io/gh/teplostanski/vite-plugin-pretty-module-classnames/graph/badge.svg?token=CQY9WXG41L">](https://codecov.io/gh/teplostanski/vite-plugin-pretty-module-classnames)
+[<img alt="NPM Version" src="https://img.shields.io/npm/v/vite-plugin-readable-classnames?style=flat-square&color=07912E&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM License" src="https://img.shields.io/npm/l/vite-plugin-readable-classnames?style=flat-square&color=D3748F&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM Type Definitions" src="https://img.shields.io/npm/types/vite-plugin-readable-classnames?style=flat-square&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/vite-plugin-readable-classnames?style=flat-square&color=7F78D1&labelColor=1f2033">](https://npmjs.com/package/vite-plugin-readable-classnames)
+[<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/teplostanski/vite-plugin-readable-classnames?style=flat-square&labelColor=1f2033">](https://github.com/teplostanski/vite-plugin-readable-classnames)
+[<img alt="Coverage" src="https://codecov.io/gh/teplostanski/vite-plugin-readable-classnames/graph/badge.svg?token=CQY9WXG41L">](https://codecov.io/gh/teplostanski/vite-plugin-readable-classnames)
 
 </a>
 
@@ -21,23 +21,23 @@
 
 ## 📦 Установка
 
-[npmjs.com](https://npmjs.com/package/vite-plugin-pretty-module-classnames) • [yarnpkg.com](https://yarnpkg.com/package?q=vite-plugin-pretty-module-classnames&name=vite-plugin-pretty-module-classnames)
+[npmjs.com](https://npmjs.com/package/vite-plugin-readable-classnames) • [yarnpkg.com](https://yarnpkg.com/package?q=vite-plugin-readable-classnames&name=vite-plugin-readable-classnames)
 
 ```bash
-npm install -D vite-plugin-pretty-module-classnames
+npm install -D vite-plugin-readable-classnames
 
-yarn add -D vite-plugin-pretty-module-classnames
+yarn add -D vite-plugin-readable-classnames
 
-pnpm add -D vite-plugin-pretty-module-classnames
+pnpm add -D vite-plugin-readable-classnames
 
-bun add -d vite-plugin-pretty-module-classnames
+bun add -d vite-plugin-readable-classnames
 ```
 
 ## 🦾 Функциональность
 
 - Не зависит от фреймворка:
   - Проверено на проектах с ![VanillaJS](https://img.shields.io/badge/Vanilla_JS/TS-%231f2033.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E) ![React](https://img.shields.io/badge/react-%231f2033.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![Vue](https://img.shields.io/badge/vue-%231f2033.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)
-  - Потенциально работает с любым фреймворком. Если возникнут проблемы — создайте [issue](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/issues)
+  - Потенциально работает с любым фреймворком. Если возникнут проблемы — создайте [issue](https://github.com/teplostanski/vite-plugin-readable-classnames/issues)
 - Универсальный:
   - Совместим с `CommonJS` и `ES Modules`
   - Совместим с `Vite 2.x`
@@ -68,27 +68,27 @@ bun add -d vite-plugin-pretty-module-classnames
 ```js
 // vite.config.js
 // ...
-import prettyModuleClassnames from 'vite-plugin-pretty-module-classnames'
+import readableClassnames from 'vite-plugin-readable-classnames'
 
 export default defineConfig({
-  plugins: [prettyModuleClassnames()],
+  plugins: [readableClassnames()],
 })
 ```
 
 ## 📚 Документация
 
-Полная документация доступна на [vite-plugin-pretty-module-classnames.teplostanski.dev](https://vite-plugin-pretty-module-classnames.teplostanski.dev/ru/) [ EN | RU ].
+Полная документация доступна на [vite-plugin-readable-classnames.teplostanski.dev](https://vite-plugin-readable-classnames.teplostanski.dev/ru/) [ EN | RU ].
 
 ## 🤝 Вклад в проект
 
-Хотите помочь проекту? Здорово! Поставьте звёздочку, расскажите друзьям или создайте [issue на GitHub](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/issues).
+Хотите помочь проекту? Здорово! Поставьте звёздочку, расскажите друзьям или создайте [issue на GitHub](https://github.com/teplostanski/vite-plugin-readable-classnames/issues).
 
-Перед тем как вносить изменения, ознакомьтесь с [правилами](https://github.com/teplostanski/vite-plugin-pretty-module-classnames/blob/main/CONTRIBUTING.md).
+Перед тем как вносить изменения, ознакомьтесь с [правилами](https://github.com/teplostanski/vite-plugin-readable-classnames/blob/main/CONTRIBUTING.md).
 
 Спасибо за вашу поддержку! 🙏
 
 <h2> © Лицензия</h2>
-<a href="https://github.com/teplostanski/vite-plugin-pretty-module-classnames/blob/main/LICENSE">MIT</a> License © 2024-2025 <a href="https://github.com/teplostanski">teplostanski</a>
+<a href="https://github.com/teplostanski/vite-plugin-readable-classnames/blob/main/LICENSE">MIT</a> License © 2024-2025 <a href="https://github.com/teplostanski">teplostanski</a>
 
 <h2> ❤ Поддержать проект</h2>
 <a href="https://donate.teplostanski.dev" target="_blank">donate.teplostanski.dev</a> 

docs/.vitepress/cache/deps/_metadata.json

@@ -1,25 +1,25 @@
 {
-  "hash": "4c52d601",
+  "hash": "906b49af",
   "configHash": "545b5610",
-  "lockfileHash": "d0d5f2ec",
-  "browserHash": "0769446e",
+  "lockfileHash": "54e80044",
+  "browserHash": "729cd11a",
   "optimized": {
     "vue": {
       "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
       "file": "vue.js",
-      "fileHash": "be50a0fc",
+      "fileHash": "e9ea50fc",
       "needsInterop": false
     },
     "vitepress > @vue/devtools-api": {
       "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
       "file": "vitepress___@vue_devtools-api.js",
-      "fileHash": "f456f16e",
+      "fileHash": "9fb72288",
       "needsInterop": false
     },
     "vitepress > @vueuse/core": {
       "src": "../../../../node_modules/@vueuse/core/index.mjs",
       "file": "vitepress___@vueuse_core.js",
-      "fileHash": "51fbbd77",
+      "fileHash": "ad2e106c",
       "needsInterop": false
     }
   },

docs/.vitepress/config.ts

@@ -13,9 +13,10 @@ export default defineConfig({
   lastUpdated: true,
   cleanUrls: true,
   metaChunk: true,
-  title: "Pretty Module Classnames",
+  title: "Readable Classnames",
   head: [
     ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
+    ['meta', { name: 'yandex-verification', content: 'b169cb710bf58bb1' }],
   ],
   locales: {
     root: {
@@ -62,8 +63,8 @@ export default defineConfig({
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/teplostanski/vite-plugin-pretty-module-classnames' },
-      { icon: 'npm', link: 'https://www.npmjs.com/package/vite-plugin-pretty-module-classnames' },
+      { icon: 'github', link: 'https://github.com/teplostanski/vite-plugin-readable-classnames' },
+      { icon: 'npm', link: 'https://www.npmjs.com/package/vite-plugin-readable-classnames' },
       { icon: 'awesomelists', link: 'https://github.com/vitejs/awesome-vite' }
     ],
   },

docs/guide/getting-started.md

@@ -3,19 +3,19 @@
 ::: code-group
 
 ```sh [npm]
-npm install -D vite-plugin-pretty-module-classnames
+npm install -D vite-plugin-readable-classnames
 ```
 
 ```sh [yarn]
-yarn add -D vite-plugin-pretty-module-classnames
+yarn add -D vite-plugin-readable-classnames
 ```
 
 ```sh [pnpm]
-pnpm add -D vite-plugin-pretty-module-classnames
+pnpm add -D vite-plugin-readable-classnames
 ```
 
 ```sh [bun]
-bun add -d vite-plugin-pretty-module-classnames
+bun add -d vite-plugin-readable-classnames
 ```
 
 :::

docs/index.md

@@ -3,7 +3,7 @@
 layout: home
 
 hero:
-  name: "Vite Plugin Pretty Module Classnames"
+  name: "Vite Plugin<br>Readable Classnames"
   text: "Make your scoped CSS module class names clear and readable"
   tagline: This plugin automatically adds the module filename and other useful info to class names for easier development.
   actions:
@@ -33,19 +33,62 @@ Add the plugin to your project using your favorite package manager!
 ::: code-group
 
 ```sh [npm]
-npm install -D vite-plugin-pretty-module-classnames
+npm install -D vite-plugin-readable-classnames
 ```
 
 ```sh [yarn]
-yarn add -D vite-plugin-pretty-module-classnames
+yarn add -D vite-plugin-readable-classnames
 ```
 
 ```sh [pnpm]
-pnpm add -D vite-plugin-pretty-module-classnames
+pnpm add -D vite-plugin-readable-classnames
 ```
 
 ```sh [bun]
-bun add -d vite-plugin-pretty-module-classnames
+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
+
+::: code-group
+
+```sh [npm]
+npm uninstall vite-plugin-pretty-module-classnames
+npm install -D vite-plugin-readable-classnames
+```
+
+```sh [yarn]
+yarn remove vite-plugin-pretty-module-classnames
+yarn add -D vite-plugin-readable-classnames
+```
+
+```sh [pnpm]
+pnpm remove vite-plugin-pretty-module-classnames
+pnpm add -D vite-plugin-readable-classnames
+```
+
+```sh [bun]
+bun remove vite-plugin-pretty-module-classnames
+bun add -d vite-plugin-readable-classnames
+```
+
+:::
+
+2. 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' // [!code --]
+import readableClassnames from 'vite-plugin-readable-classnames' // [!code ++]
+
+export default defineConfig {
+  plugins: [prettyModuleClassnames()], // [!code --]
+  plugins: [readableClassnames()], // [!code ++]
+}
+```

docs/options/index.md

@@ -9,11 +9,11 @@ Currently, the following parameters are available:
 Usage example:
 
 ```js
-import prettyModuleClassnames from 'vite-plugin-pretty-module-classnames'
+import readableClassnames from 'vite-plugin-readable-classnames'
 
 export default defineConfig({
   plugins: [
-    prettyModuleClassnames({
+    readableClassnames({
       lineNumber: true,
       separator: {
         beforeClassName: '--'