{"id":32429485,"url":"https://github.com/mellowco/unplugin-transform-class","last_synced_at":"2026-02-27T09:10:46.528Z","repository":{"id":41822104,"uuid":"510399371","full_name":"MellowCo/unplugin-transform-class","owner":"MellowCo","description":"transform class by rules, support use in vite, rollup, webpack","archived":false,"fork":false,"pushed_at":"2025-05-10T08:04:05.000Z","size":2406,"stargazers_count":13,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-22T04:53:28.689Z","etag":null,"topics":["transformer","unplugin","vite","webpack"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/unplugin-transform-class","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MellowCo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-04T14:52:06.000Z","updated_at":"2025-05-10T08:04:08.000Z","dependencies_parsed_at":"2025-05-10T02:36:50.179Z","dependency_job_id":"4e72081c-393d-4b14-8790-7f17881f8afd","html_url":"https://github.com/MellowCo/unplugin-transform-class","commit_stats":{"total_commits":107,"total_committers":3,"mean_commits":"35.666666666666664","dds":0.05607476635514019,"last_synced_commit":"01da4fda73042fcb588e8536918f8824789f7694"},"previous_names":["mellowco/unplugin-transform-we-class"],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/MellowCo/unplugin-transform-class","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MellowCo%2Funplugin-transform-class","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MellowCo%2Funplugin-transform-class/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MellowCo%2Funplugin-transform-class/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MellowCo%2Funplugin-transform-class/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MellowCo","download_url":"https://codeload.github.com/MellowCo/unplugin-transform-class/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MellowCo%2Funplugin-transform-class/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281019441,"owners_count":26430647,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["transformer","unplugin","vite","webpack"],"created_at":"2025-10-25T20:52:29.229Z","updated_at":"2025-10-25T20:53:16.822Z","avatar_url":"https://github.com/MellowCo.png","language":"TypeScript","readme":"\u003cH1 align='center'\u003e\nunplugin-transform-class\n\u003c/H1\u003e\n\n\u003cp align='center'\u003e\n\u003cb\u003eEnglish\u003c/b\u003e | \u003ca href=\"https://github.com/MellowCo/unplugin-transform-class/blob/main/README.zh-CN.md\"\u003e简体中文\u003c/a\u003e\n\u003c/p\u003e\n\ntransfrom `html class` selector by custom rules\n\n---\n\nstatic class\n\n```html\n\u003cview class=\"tracking-[2/5] bg-teal-200:55\"\u003e\n  tracking-[2/5]\n\u003c/view\u003e\n```\n\nsetting rules\n\n```js\nconst rules = {\n  '/': '-s-',\n  ':': '-c-',\n  '[': '-fl-',\n  ']': '-fr-',\n}\n\ntransformClass({\n  rules\n})\n```\n\ntransfrom\n\n```html\n\u003cview class=\"tracking--fl-2-s-5-fr- bg-teal-200-c-55\"\u003e\n  tracking-[2/5]\n\u003c/view\u003e\n```\n\n---\n\ndynamic class\n\n```html\n\u003cview\n  :class=\"{'bg-blue-600:80': flag,'text-green-600/40': !flag}\"\n\u003e\n  111111111\n\u003c/view\u003e\n\n\u003cview\n  :class=\"[\n    flag ? 'bg-blue-600/40' : 'bg-blue-600:80',\n    !flag ? 'text-yellow-800/80' : 'text-yellow-800/40',\n  ]\"\n\u003e\n  111111111\n\u003c/view\u003e\n```\n\ntransfrom\n\n```html\n\n\u003cview\n  :class=\"{'bg-blue-600-c-80': flag,'text-green-600-s-40': !flag}\"\n\u003e\n  111111111\n\u003c/view\u003e\n\n  \u003cview\n  :class=\"[\n    flag ? 'bg-blue-600-s-40' : 'bg-blue-600-c-80',\n    !flag ? 'text-yellow-800-s-80' : 'text-yellow-800-s-40',\n  ]\"\n\u003e\n  111111111\n\u003c/view\u003e\n```\n\n## installation\n\n```shell\nnpm i unplugin-transform-class -D\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eVite\u003c/summary\u003e\u003cbr\u003e\n\n```ts\nimport transformClass from 'unplugin-transform-class/vite'\nimport { defineConfig } from 'vite'\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n  plugins: [\n    // https://github.com/MellowCo/unplugin-transform-class\n    transformClass(),\n  ],\n})\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ewebpack\u003c/summary\u003e\u003cbr\u003e\n\n```ts\nconst transformClass = require('unplugin-transform-class/webpack')\n\nmodule.exports = {\n  configureWebpack: {\n    plugins: [\n      // https://github.com/MellowCo/unplugin-transform-class\n      transformClass(),\n    ],\n  },\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n---\n## usage\n\n### options\n```ts\nexport interface Options {\n  /**\n   * custom transform Rules\n   * @default\n   * {\n      '.': '_dl_',\n      '/': '_sl_',\n      ':': '_cl_',\n      '%': '_pes_',\n      '!': '_el_',\n      '#': '_wn_',\n      '(': '_lbl_',\n      ')': '_lbr_',\n      '[': '_lfl_',\n      ']': '_lfr_',\n      '$': '_do_',\n      ',': '_lco_',\n      '=': '_eqe_',\n    }\n   */\n  rules?: Record\u003cstring, string\u003e\n\n  /**\n   * exclude\n   * @default [/[\\\\/]node_modules[\\\\/]/, /[\\\\/]\\.git[\\\\/]/]\n   */\n  exclude?: FilterPattern\n\n  /**\n   * include\n   * @default [/\\.[jt]sx?$/, /\\.vue$/,  /\\.vue\\?vue/]\n   */\n  include?: FilterPattern\n}\n```\n\n---\n### custom transform Rules\n\n```ts\n// webpack\n// const transformClass =  require('unplugin-transform-class/webpack')\n// import transformClass from 'unplugin-transform-class/webpack'\n\n// vite\nimport transformClass from 'unplugin-transform-class/vite'\n\nconst myRules = {\n  '.': '-ddd-',\n  '/': '-ss-',\n  ':': '-cc-',\n  '%': '-pp-'\n}\n\ntransformWeClass({\n  rules: myRules\n})\n```\n\n---\n### exclude include\n```ts\n// webpack\n// const transformClass =  require('unplugin-transform-class/webpack')\n// import transformClass from 'unplugin-transform-class/webpack'\n\n// vite\nimport transformClass from 'unplugin-transform-class/vite'\n\ntransformWeClass({\n  exclude: [/[\\\\/]node_modules[\\\\/]/, /[\\\\/]\\.git[\\\\/]/, /[\\\\/]my-folder[\\\\/]/],\n  include: [/\\.vue$/, /\\.vue\\?vue/]\n})\n```\n\n---\n### utils\n```ts\nimport { defaultRules, escapeRegExp, restoreSelector, transformCode, transformEscapESelector, transformSelector } from 'unplugin-transform-class/utils'\n\nconst code = `\n\u003cview class=\"tracking-[2/5] bg-teal-200:55\"\u003e\n  tracking-[2/5]\n\u003c/view\u003e`\n\nconst rules = {\n  '/': '-s-',\n  ':': '-c-',\n  '[': '-fl-',\n  ']': '-fr-',\n}\n\nconst newCode = transformCode(code, rules)\n```\n\n---\n## use case\n\n### use atomic css in miniprogram\n\n\u003e transfrom the escape class  not supported by miniprogram, like `\\\\`，`\\:` `\\[` `\\$`  `\\.` , implement the atomic css in miniprogram\n\n![](https://fastly.jsdelivr.net/gh/MellowCo/image-host/2022/202209181628083.png)\n\n\u003e for example use [unocss-preset-weapp](https://github.com/MellowCo/unocss-preset-weapp), use unocss development in miniprogram\n\n![image-20220703141301371](https://fastly.jsdelivr.net/gh/MellowCo/image-host/2022/202207031413496.png)\n\nrelated links\n* [unocss-preset-weapp](https://github.com/MellowCo/unocss-preset-weapp) - the unocss preset for wechat miniprogram.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmellowco%2Funplugin-transform-class","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmellowco%2Funplugin-transform-class","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmellowco%2Funplugin-transform-class/lists"}