@unocss/vite 0.27.6 → 0.28.2

package/README.md

@@ -16,8 +16,8 @@ import Unocss from 'unocss/vite'
 
 export default {
   plugins: [
-    Unocss({ /* options */ })
-  ]
+    Unocss({ /* options */ }),
+  ],
 }
 ```
 
@@ -81,7 +81,7 @@ export default {
     Unocss({
       /* options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -98,7 +98,7 @@ export default {
     Unocss({
       /* options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -116,8 +116,8 @@ export default {
     Unocss({
       /* options */
     }),
-    react()
-  ]
+    react(),
+  ],
 }
 ```
 
@@ -138,7 +138,7 @@ export default {
     Unocss({
       /* options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -155,7 +155,7 @@ export default {
     Unocss({
       /* options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -173,8 +173,8 @@ export default {
     Unocss({
       /* options */
     }),
-    preact()
-  ]
+    preact(),
+  ],
 }
 ```
 
@@ -200,8 +200,8 @@ export default {
       extractors: [extractorSvelte],
       /* more options */
     }),
-    svelte()
-  ]
+    svelte(),
+  ],
 }
 ```
 
@@ -224,9 +224,7 @@ const config = {
   // Consult https://github.com/sveltejs/svelte-preprocess
   // for more information about preprocessors
   preprocess: preprocess(),
-
   kit: {
-
     // hydrate the <div id="svelte"> element in src/app.html
     target: '#svelte',
     vite: {
@@ -234,11 +232,11 @@ const config = {
         UnoCss({
           extractors: [extractorSvelte],
           /* more options */
-        })
-      ]
-    }
-  }
-}  
+        }),
+      ],
+    },
+  },
+}
 ```
 
 You have a `SvelteKit` example project on [test/fixtures/sveltekit](https://github.com/unocss/unocss/tree/main/test/fixtures/sveltekit) directory.
@@ -259,7 +257,7 @@ export default {
       mode: 'shadow-dom',
       /* more options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -314,7 +312,7 @@ export default {
       ],
       /* more options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -358,7 +356,7 @@ export default {
     Unocss({
       /* options */
     }),
-  ]
+  ],
 }
 ```
 
@@ -379,8 +377,8 @@ export default defineConfig({
     elmPlugin(),
     Unocss({
       /* options */
-    })
-  ]
+    }),
+  ],
 })
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unocss/vite",
-  "version": "0.27.6",
+  "version": "0.28.2",
   "description": "The Vite plugin for UnoCSS",
   "keywords": [
     "unocss",
@@ -12,17 +12,16 @@
     "url": "https://github.com/unocss/unocss/issues"
   },
   "license": "MIT",
+  "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unocss/unocss.git",
     "directory": "packages/vite"
   },
   "funding": "https://github.com/sponsors/antfu",
-  "author": "Anthony Fu <anthonyfu117@hotmail.com>",
-  "sideEffects": false,
-  "files": [
-    "dist"
-  ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "require": "./dist/index.cjs",
@@ -30,16 +29,17 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
   "dependencies": {
-    "@rollup/pluginutils": "^4.1.2",
-    "@unocss/config": "0.27.6",
-    "@unocss/core": "0.27.6",
-    "@unocss/inspector": "0.27.6",
-    "@unocss/scope": "0.27.6",
-    "@unocss/transformer-directives": "0.27.6",
+    "@rollup/pluginutils": "^4.2.0",
+    "@unocss/config": "0.28.2",
+    "@unocss/core": "0.28.2",
+    "@unocss/inspector": "0.28.2",
+    "@unocss/scope": "0.28.2",
+    "@unocss/transformer-directives": "0.28.2",
     "magic-string": "^0.26.1"
   },
   "devDependencies": {
@@ -48,5 +48,6 @@
   "scripts": {
     "build": "unbuild",
     "stub": "unbuild --stub"
-  }
+  },
+  "readme": "# @unocss/vite\n\nThe Vite plugin for UnoCSS. Ships with the `unocss` package.\n\n> This plugin does not come with any default presets. You are building a meta framework on top of UnoCSS, see [this file](https://github.com/unocss/unocss/blob/main/packages/unocss/src/vite.ts) for an example to bind the default presets.\n\n## Installation\n\n```bash\nnpm i -D unocss\n```\n\n```ts\n// vite.config.ts\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    Unocss({ /* options */ }),\n  ],\n}\n```\n\nAdd `uno.css` to your main entry:\n\n```ts\n// main.ts\nimport 'uno.css'\n```\n\n## Modes\n\nThe Vite plugin comes with a set of modes that enable different behaviors.\n\n### global (default)\n\nThis is the default mode for the plugin: in this mode you need to add the import of `uno.css` on your entry point.\n\nThis mode enables a set of Vite plugins for `build` and for `dev` with `HMR` support.\n\nThe generated `css` will be a global stylesheet injected on the `index.html`.\n\n### vue-scoped (WIP)\n\nThis mode will inject generated CSS to Vue SFC's `<style scoped>` for isolation.\n\n### svelte-scoped (WIP)\n\nThis mode will inject generated CSS to Svelte's `<style>` for isolation.\n\n### per-module (WIP)\n\nThis mode will generate a CSS sheet for each module, can be scoped.\n\n### dist-chunk (WIP)\n\nThis mode will generate a CSS sheet for each code chunk on build, great for MPA.\n\n### shadow-dom\n\nSince `Web Components` uses `Shadow DOM`, there is no way to style content directly from a global stylesheet (unless you use `custom css vars`, those will penetrate the `Shadow DOM`), you need to inline the generated css by the plugin into the `Shadow DOM` style.\n\nTo inline the generated css, you only need to configure the plugin mode to `shadow-dom` and include `@unocss-placeholder` magic placeholder on each web component style css block.\n\n## Frameworks\n\nSome UI/App frameworks have some caveats that must be fixed to make it work, if you're using one of the following frameworks, just apply the suggestions.\n\n### React\n\nIf you're using `@vitejs/plugin-react`:\n\n```ts\n// vite.config.js\nimport react from '@vitejs/plugin-react'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    react(),\n    Unocss({\n      /* options */\n    }),\n  ],\n}\n```\n\nor if you're using `@vitejs/plugin-react-refresh`:\n\n```ts\n// vite.config.js\nimport reactRefresh from '@vitejs/plugin-react-refresh'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    reactRefresh(),\n    Unocss({\n      /* options */\n    }),\n  ],\n}\n```\n\nIf you're using `@unocss/preset-attributify` you should remove `tsc` from the `build` script.\n\nIf you are using `@vitejs/plugin-react` with `@unocss/preset-attributify`, you must add the plugin before `@vitejs/plugin-react`.\n\n```ts\n// vite.config.js\nimport react from '@vitejs/plugin-react'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    Unocss({\n      /* options */\n    }),\n    react(),\n  ],\n}\n```\n\nYou have a `React` example project on [test/fixtures/vite-react](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-react) directory  using both plugins, check the scripts on `package.json` and its Vite configuration file.\n\n### Preact\n\nIf you're using `@preact/preset-vite`:\n\n```ts\n// vite.config.js\nimport preact from '@preact/preset-vite'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    preact(),\n    Unocss({\n      /* options */\n    }),\n  ],\n}\n```\n\nor if you're using `@prefresh/vite`:\n\n```ts\n// vite.config.js\nimport prefresh from '@prefresh/vite'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    prefresh(),\n    Unocss({\n      /* options */\n    }),\n  ],\n}\n```\n\nIf you're using `@unocss/preset-attributify` you should remove `tsc` from the `build` script.\n\nIf you are using `@preact/preset-vite` with `@unocss/preset-attributify`, you must add the plugin before `@preact/preset-vite`.\n\n```ts\n// vite.config.js\nimport preact from '@preact/preset-vite'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    Unocss({\n      /* options */\n    }),\n    preact(),\n  ],\n}\n```\n\nYou have a `Preact` example project on [test/fixtures/vite-preact](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-preact) directory  using both plugins, check the scripts on `package.json` and its Vite configuration file.\n\n### Svelte\n\nYou must add the plugin before `@sveltejs/vite-plugin-svelte`.\n\nTo support `class:foo` and `class:foo={bar}` add the plugin and configure `extractorSvelte` on `extractors` option.\n\nYou can use simple rules with `class:`, for example `class:bg-red-500={foo}` or using `shorcuts` to include multiples rules, see `src/App.svelte` on linked example project bellow.\n\n```ts\n// vite.config.js\nimport { svelte } from '@sveltejs/vite-plugin-svelte'\nimport Unocss from 'unocss/vite'\nimport { extractorSvelte } from '@unocss/core'\n\nexport default {\n  plugins: [\n    Unocss({\n      extractors: [extractorSvelte],\n      /* more options */\n    }),\n    svelte(),\n  ],\n}\n```\n\nYou have a `Vite + Svelte` example project on [test/fixtures/vite-svelte](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-svelte) directory.\n\n###  Sveltekit\n\nTo support `class:foo` and `class:foo={bar}` add the plugin and configure `extractorSvelte` on `extractors` option.\n\nYou can use simple rules with `class:`, for example `class:bg-red-500={foo}` or using `shorcuts` to include multiples rules, see `src/routes/__layout.svelte` on linked example project bellow.\n\n```ts\n// svelte.config.js\nimport preprocess from 'svelte-preprocess'\nimport UnoCss from 'unocss/vite'\nimport { extractorSvelte } from '@unocss/core'\n\n/** @type {import('@sveltejs/kit').Config} */\nconst config = {\n  // Consult https://github.com/sveltejs/svelte-preprocess\n  // for more information about preprocessors\n  preprocess: preprocess(),\n  kit: {\n    // hydrate the <div id=\"svelte\"> element in src/app.html\n    target: '#svelte',\n    vite: {\n      plugins: [\n        UnoCss({\n          extractors: [extractorSvelte],\n          /* more options */\n        }),\n      ],\n    },\n  },\n}\n```\n\nYou have a `SvelteKit` example project on [test/fixtures/sveltekit](https://github.com/unocss/unocss/tree/main/test/fixtures/sveltekit) directory.\n\n### Web Components\n\nTo work with web components you need to enable `shadow-dom` mode on the plugin.\n\nDon't forget to remove the import for `uno.css` since the `shadow-dom` mode will not expose it and the application will not work.\n\n```ts\n// vite.config.js\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    Unocss({\n      mode: 'shadow-dom',\n      /* more options */\n    }),\n  ],\n}\n```\n\nOn each `web component` just add `@unocss-placeholder` to its style css block:\n```ts\nconst template = document.createElement('template')\ntemplate.innerHTML = `\n<style>\n:host {...}\n@unocss-placeholder\n</style>\n<div class=\"m-1em\">\n...\n</div>\n`\n```\n\nIf you're using [Lit](https://lit.dev/):\n\n```ts\n@customElement('my-element')\nexport class MyElement extends LitElement {\n  static styles = css`\n    :host {...}\n    @unocss-placeholder\n  `\n  ...\n}\n```\n\nYou have a `Web Components` example project on [test/fixtures/vite-lit](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-lit) directory.\n\n#### `::part` built-in support\n\nYou can use `::part` since the plugin supports it via `shortcuts` and using `part-[<part-name>]:<rule|shortcut>` rule from `preset-mini`, for example using it with simple rules like `part-[<part-name>]:bg-green-500` or using some `shortcut`: check `src/my-element.ts` on linked example project bellow.\n\nThe `part-[<part-name>]:<rule|shortcut>` will work only with this plugin using the `shadow-dom` mode.\n\nThe plugin uses `nth-of-type` to avoid collisions with multiple parts in the same web component and for the same parts on distinct web components, you don't need to worry about it, the plugin will take care for you.\n\n```ts\n// vite.config.js\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    Unocss({\n      mode: 'shadow-dom',\n      shortcuts: [\n        { 'cool-blue': 'bg-blue-500 text-white' },\n        { 'cool-green': 'bg-green-500 text-black' },\n      ],\n      /* more options */\n    }),\n  ],\n}\n```\n\nthen in your web components:\n\n```ts\n// my-container-wc.ts\nconst template = document.createElement('template')\ntemplate.innerHTML = `\n<style>\n@unocss-placeholder\n</style>\n<my-wc-with-parts class=\"part-[cool-part]:cool-blue part-[another-cool-part]:cool-green\">...</my-wc-with-parts>\n`\n```\n\n```ts\n// my-wc-with-parts.ts\nconst template = document.createElement('template')\ntemplate.innerHTML = `\n<style>\n@unocss-placeholder\n</style>\n<div>\n  <div part=\"cool-part\">...</div>\n  <div part=\"another-cool-part\">...</div>\n</div>\n`\n```\n\n### Solid\n\n```ts\n// vite.config.js\nimport solidPlugin from 'vite-plugin-solid'\nimport Unocss from 'unocss/vite'\n\nexport default {\n  plugins: [\n    solidPlugin(),\n    Unocss({\n      /* options */\n    }),\n  ],\n}\n```\n\nYou have a `Vite + Solid` example project on [test/fixtures/vite-solid](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-solid) directory.\n\n### Elm\n\nYou need to add the `vite-plugin-elm` plugin before UnoCSS's plugin.\n\n```ts\n// vite.config.js\nimport { defineConfig } from 'vite'\nimport elmPlugin from 'vite-plugin-elm'\nimport Unocss from 'unocss/vite'\n\nexport default defineConfig({\n  plugins: [\n    elmPlugin(),\n    Unocss({\n      /* options */\n    }),\n  ],\n})\n```\n\nYou have a `Vite + Elm` example project on [test/fixtures/vite-elm](https://github.com/unocss/unocss/tree/main/test/fixtures/vite-elm) directory.\n\n## License\n\nMIT License © 2021-PRESENT [Anthony Fu](https://github.com/antfu)\n"
 }