@vanilla-extract/vite-plugin 2.0.0 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @vanilla-extract/vite-plugin
 
+## 2.1.1
+
+### Patch Changes
+
+- [#393](https://github.com/seek-oss/vanilla-extract/pull/393) [`2f379f1`](https://github.com/seek-oss/vanilla-extract/commit/2f379f118c2a2fe6dc08a1cc15a395dbc0f17ece) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Fix compilation errors in Vite 2.6
+
+- Updated dependencies [[`2f379f1`](https://github.com/seek-oss/vanilla-extract/commit/2f379f118c2a2fe6dc08a1cc15a395dbc0f17ece)]:
+  - @vanilla-extract/integration@1.4.2
+
+## 2.1.0
+
+### Minor Changes
+
+- [#373](https://github.com/seek-oss/vanilla-extract/pull/373) [`a55d2cf`](https://github.com/seek-oss/vanilla-extract/commit/a55d2cfd7c4ca9175a2c86557888df90907bfd0f) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Add `devStyleRuntime` option to allow switching between dev style runtimes
+
+  The built-in Vite dev style runtime (what adds styles to the page when running `vite serve`) doesn't seem to clean up old styles as expected. Passing `devStyleRuntime: 'vanilla-extract'` will instead use vanilla-extract's browser runtime. This pushes all style creation in development to the browser, but may give a better HMR experience.
+
+## 2.0.2
+
+### Patch Changes
+
+- [#341](https://github.com/seek-oss/vanilla-extract/pull/341) [`0b743e7`](https://github.com/seek-oss/vanilla-extract/commit/0b743e744447616f8daf0c6b88beff8ffef8d41b) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Refactor SSR file scoping to use centralised `addFileScope` implementation
+
+- Updated dependencies [[`50bae14`](https://github.com/seek-oss/vanilla-extract/commit/50bae14bf38c8a971ad1727cb8e827c86da06772), [`0b743e7`](https://github.com/seek-oss/vanilla-extract/commit/0b743e744447616f8daf0c6b88beff8ffef8d41b)]:
+  - @vanilla-extract/integration@1.3.0
+
+## 2.0.1
+
+### Patch Changes
+
+- [#327](https://github.com/seek-oss/vanilla-extract/pull/327) [`73b55f8`](https://github.com/seek-oss/vanilla-extract/commit/73b55f8e7e205701abdb1cbb029c3f2f5080b6fd) Thanks [@benjervis](https://github.com/benjervis)! - Fix bug where precompiled .css.ts files (.css.js) were treated differently in SSR mode.
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -56,7 +56,7 @@ export const exampleStyle = style({
 });
 ```
 
-> 💡 These `.css.ts` files will be evaluated at build time. None of the code in these files will be included in your final bundle. Think of it as using TypeScript as your preprocessor instead of Sass, Less, etc.
+> 💡 Once you've [configured your build tooling,](#setup) these `.css.ts` files will be evaluated at build time. None of the code in these files will be included in your final bundle. Think of it as using TypeScript as your preprocessor instead of Sass, Less, etc.
 
 **Then consume them in your markup.**
 
@@ -74,7 +74,7 @@ document.write(`
 
 ---
 
-Want to work at a higher level while maximising style re-use? Check out  🍨 [Sprinkles](https://github.com/seek-oss/vanilla-extract/tree/master/packages/sprinkles), our official zero-runtime atomic CSS framework, built on top of vanilla-extract.
+Want to work at a higher level while maximising style re-use? Check out  🍨 [Sprinkles](https://vanilla-extract.style/documentation/sprinkles-api), our official zero-runtime atomic CSS framework, built on top of vanilla-extract.
 
 ---
 
@@ -83,6 +83,7 @@ Want to work at a higher level while maximising style re-use? Check out  🍨 [S
   - [esbuild](#esbuild)
   - [Vite](#vite)
   - [Snowpack](#snowpack)
+  - [Next.js](#nextjs)
   - [Gatsby](#gatsby)
   - [Test environments](#test-environments)
   - [Configuration](#configuration)
@@ -91,7 +92,6 @@ Want to work at a higher level while maximising style re-use? Check out  🍨 [S
   - [style](#style)
   - [styleVariants](#stylevariants)
   - [globalStyle](#globalstyle)
-  - [composeStyles](#composestyles)
   - [createTheme](#createtheme)
   - [createGlobalTheme](#createglobaltheme)
   - [createThemeContract](#createthemecontract)
@@ -102,6 +102,8 @@ Want to work at a higher level while maximising style re-use? Check out  🍨 [S
   - [globalFontFace](#globalfontface)
   - [keyframes](#keyframes)
   - [globalKeyframes](#globalkeyframes)
+- [Recipes API](#recipes-api)
+  - [recipe](#recipe)
 - [Dynamic API](#dynamic-api)
   - [assignInlineVars](#assigninlinevars)
   - [setElementVars](#setelementvars)
@@ -121,18 +123,10 @@ There are currently a few integrations to choose from.
 1. Install the dependencies.
 
 ```bash
-npm install @vanilla-extract/css @vanilla-extract/babel-plugin @vanilla-extract/webpack-plugin
+npm install @vanilla-extract/css @vanilla-extract/webpack-plugin
 ```
 
-2. Add the [Babel](https://babeljs.io) plugin.
-
-```json
-{
-  "plugins": ["@vanilla-extract/babel-plugin"]
-}
-```
-
-3. Add the [webpack](https://webpack.js.org) plugin.
+2. Add the [webpack](https://webpack.js.org) plugin.
 
 > 💡 This plugin accepts an optional [configuration object](#configuration).
 
@@ -179,6 +173,18 @@ module.exports = {
   ```
 </details>
 
+3. If you'd like automatic debuggable identifiers, you can add the [Babel](https://babeljs.io) plugin.
+   
+```bash
+$ npm install @vanilla-extract/babel-plugin
+```
+
+```json
+{
+  "plugins": ["@vanilla-extract/babel-plugin"]
+}
+```
+
 ### esbuild
 
 1. Install the dependencies.
@@ -286,6 +292,55 @@ npm install @vanilla-extract/css @vanilla-extract/snowpack-plugin
 
 > Please note: There are currently no automatic readable class names during development. However, you can still manually provide a debug ID as the last argument to functions that generate scoped styles, e.g. `export const className = style({ ... }, 'className');`
 
+### Next.js
+
+1. Install the dependencies.
+
+```bash
+npm install @vanilla-extract/css @vanilla-extract/babel-plugin @vanilla-extract/next-plugin
+```
+
+2. If you don't have a `.babelrc` file in the root of your project, create one. Add the [Babel](https://babeljs.io) plugin to your `.babelrc` file, ensuring that you're also including `"next/babel"` in your `presets` array.
+
+```json
+{
+  "presets": ["next/babel"],
+  "plugins": ["@vanilla-extract/babel-plugin"]
+}
+```
+
+3. If you don't have a `next.config.js` file in the root of your project, create one. Add the [Next.js](https://nextjs.org) plugin to your `next.config.js` file.
+
+> 💡 This plugin accepts an optional [configuration object](#configuration).
+
+```js
+const {
+  createVanillaExtractPlugin
+} = require('@vanilla-extract/next-plugin');
+const withVanillaExtract = createVanillaExtractPlugin();
+
+const nextConfig = {};
+
+module.exports = withVanillaExtract(nextConfig);
+```
+
+If required, this plugin can be composed with other plugins.
+
+```js
+const {
+  createVanillaExtractPlugin
+} = require('@vanilla-extract/next-plugin');
+const withVanillaExtract = createVanillaExtractPlugin();
+
+const withMDX = require('@next/mdx')({
+  extension: /\.mdx$/
+});
+
+const nextConfig = {};
+
+module.exports = withVanillaExtract(withMDX(nextConfig));
+```
+
 ### Gatsby
 
 To add to your [Gatsby](https://www.gatsbyjs.com) site, use the [gatsby-plugin-vanilla-extract](https://github.com/KyleAMathews/gatsby-plugin-vanilla-extract) plugin.
@@ -393,11 +448,51 @@ export const childClass = style({
 });
 ```
 
-> 💡 To improve maintainability, each `style` block can only target a single element. To enforce this, all selectors must target the `&` character which is a reference to the current element. For example, `'&:hover:not(:active)'` is considered valid, while `'& > a'` and ``[`& ${childClass}`]`` are not.
+> 💡 To improve maintainability, each style block can only target a single element. To enforce this, all selectors must target the “&” character which is a reference to the current element.
+>
+> For example, `'&:hover:not(:active)'` and `` [`${parentClass} &`] `` are considered valid, while `'& a[href]'` and `` [`& ${childClass}`] `` are not.
+>
+> If you want to target another scoped class then it should be defined within the style block of that class instead.
 >
->If you want to target another scoped class then it should be defined within the `style` block of that class instead. For example, ``[`& ${childClass}`]`` is invalid since it targets `${childClass}`, so it should instead be defined in the `style` block for `childClass`.
+> For example, `` [`& ${childClass}`] `` is invalid since it doesn’t target “&”, so it should instead be defined in the style block for `childClass`.
 >
->If you want to globally target child nodes within the current element (e.g. `'& > a'`), you should use [`globalStyle`](#globalstyle) instead.
+> If you want to globally target child nodes within the current element (e.g. `'& a[href]'`), you should use [`globalStyle`](#globalstyle) instead.
+
+Multiple styles can be composed into a single rule by providing an array of styles.
+
+```ts
+import { style } from '@vanilla-extract/css';
+
+const base = style({ padding: 12 });
+
+export const primary = style([
+  base,
+  { background: 'blue' }
+]);
+
+export const secondary = style([
+  base,
+  { background: 'aqua' }
+]);
+```
+
+When composed styles are used in selectors, they are assigned an additional class if required so they can be uniquely identified. When selectors are processed internally, the composed classes are removed, only leaving behind the unique identifier classes. This allows you to treat them as if they were a single class within vanilla-extract selectors.
+
+```ts
+import {
+  style,
+  globalStyle,
+} from '@vanilla-extract/css';
+
+const background = style({ background: 'mintcream' });
+const padding = style({ padding: 12 });
+
+export const container = style([background, padding]);
+
+globalStyle(`${container} *`, {
+  boxSizing: 'border-box'
+});
+```
 
 ### styleVariants
 
@@ -414,20 +509,35 @@ export const variant = styleVariants({
 
 > 💡 This is useful for mapping component props to styles, e.g. `<button className={styles.variant[props.variant]}>`
 
+Multiple styles can be composed into a single rule by providing an array of styles.
+
+```ts
+import { styleVariants } from '@vanilla-extract/css';
+
+const base = style({ padding: 12 });
+
+export const variant = styleVariants({
+  primary: [base, { background: 'blue' }],
+  secondary: [base, { background: 'aqua' }],
+});
+```
+
 You can also transform the values by providing a map function as the second argument.
 
 ```ts
 import { styleVariants } from '@vanilla-extract/css';
 
-const spaceScale = {
-  small: 4,
-  medium: 8,
-  large: 16
-};
+const base = style({ padding: 12 });
+
+const backgrounds = {
+  primary: 'blue',
+  secondary: 'aqua'
+} as const;
 
-export const padding = styleVariants(spaceScale, (space) => ({
-  padding: space
-}));
+export const variant = styleVariants(
+  backgrounds,
+  (background) => [base, { background }]
+);
 ```
 
 ### globalStyle
@@ -445,7 +555,7 @@ globalStyle('html, body', {
 Global selectors can also contain references to other scoped class names.
 
 ```ts
-import { globalStyle } from '@vanilla-extract/css';
+import { style, globalStyle } from '@vanilla-extract/css';
 
 export const parentClass = style({});
 
@@ -454,50 +564,6 @@ globalStyle(`${parentClass} > a`, {
 });
 ```
 
-### composeStyles
-
-Combines multiple styles into a single class string, while also deduplicating and removing unnecessary spaces.
-
-```ts
-import { style, composeStyles } from '@vanilla-extract/css';
-
-const button = style({
-  padding: 12,
-  borderRadius: 8
-});
-
-export const primaryButton = composeStyles(
-  button,
-  style({ background: 'coral' })
-);
-
-export const secondaryButton = composeStyles(
-  button,
-  style({ background: 'peachpuff' })
-);
-```
-
-> 💡 Styles can also be provided in shallow and deeply nested arrays, similar to [classnames.](https://github.com/JedWatson/classnames)
-
-When style compositions are used in selectors, they are assigned an additional class so they can be uniquely identified. When selectors are processed internally, the composed classes are removed, only leaving behind the unique identifier classes. This allows you to treat them as if they were a single class within vanilla-extract selectors.
-
-```ts
-import {
-  style,
-  globalStyle,
-  composeStyles
-} from '@vanilla-extract/css';
-
-const background = style({ background: 'mintcream' });
-const padding = style({ padding: 12 });
-
-export const container = composeStyles(background, padding);
-
-globalStyle(`${container} *`, {
-  boxSizing: 'border-box'
-});
-```
-
 ### createTheme
 
 Creates a locally scoped theme class and a theme contract which can be consumed within your styles.
@@ -683,10 +749,7 @@ For example, you can automatically prefix all variable names.
 ```ts
 // themes.css.ts
 
-import {
-  createGlobalThemeContract,
-  createGlobalTheme
-} from '@vanilla-extract/css';
+import { createGlobalThemeContract } from '@vanilla-extract/css';
 
 export const vars = createGlobalThemeContract({
   color: {
@@ -703,10 +766,7 @@ You can also use the map function to automatically generate names from the objec
 ```ts
 // themes.css.ts
 
-import {
-  createGlobalThemeContract,
-  createGlobalTheme
-} from '@vanilla-extract/css';
+import { createGlobalThemeContract } from '@vanilla-extract/css';
 
 export const vars = createGlobalThemeContract({
   color: {
@@ -852,8 +912,8 @@ Creates a locally scoped set of keyframes.
 import { keyframes, style } from '@vanilla-extract/css';
 
 const rotate = keyframes({
-  '0%': { rotate: '0deg' },
-  '100%': { rotate: '360deg' },
+  '0%': { transform: 'rotate(0deg)' },
+  '100%': { transform: 'rotate(360deg)' }
 });
 
 export const animated = style({
@@ -869,8 +929,8 @@ Creates a globally scoped set of keyframes.
 import { globalKeyframes, style } from '@vanilla-extract/css';
 
 globalKeyframes('rotate', {
-  '0%': { rotate: '0deg' },
-  '100%': { rotate: '360deg' },
+  '0%': { transform: 'rotate(0deg)' },
+  '100%': { transform: 'rotate(360deg)' }
 });
 
 export const animated = style({
@@ -878,9 +938,117 @@ export const animated = style({
 });
 ```
 
+## Recipes API
+
+Create multi-variant styles with a type-safe runtime API, heavily inspired by [Stitches.](https://stitches.dev)
+
+As with the rest of vanilla-extract, all styles are generated at build time.
+
+```bash
+$ npm install @vanilla-extract/recipes
+```
+
+### recipe
+
+Creates a multi-variant style function that can be used at runtime or statically in `.css.ts` files.
+
+Accepts an optional set of `base` styles, `variants`, `compoundVariants` and `defaultVariants`.
+
+```ts
+import { recipe } from '@vanilla-extract/recipes';
+
+export const button = recipe({
+  base: {
+    borderRadius: 6
+  },
+
+  variants: {
+    color: {
+      neutral: { background: 'whitesmoke' },
+      brand: { background: 'blueviolet' },
+      accent: { background: 'slateblue' }
+    },
+    size: {
+      small: { padding: 12 },
+      medium: { padding: 16 },
+      large: { padding: 24 }
+    },
+    rounded: {
+      true: { borderRadius: 999 }
+    }
+  },
+
+  // Applied when multiple variants are set at once
+  compoundVariants: [
+    {
+      variants: {
+        color: 'neutral',
+        size: 'large'
+      },
+      style: {
+        background: 'ghostwhite'
+      }
+    }
+  ],
+
+  defaultVariants: {
+    color: 'accent',
+    size: 'medium'
+  }
+});
+```
+
+With this recipe configured, you can now use it in your templates.
+
+```ts
+import { button } from './button.css.ts';
+
+document.write(`
+  <button class="${button({
+    color: 'accent',
+    size: 'large',
+    rounded: true
+  })}">
+    Hello world
+  </button>
+`);
+```
+
+Your recipe configuration can also make use of existing variables, classes and styles.
+
+For example, you can pass in the result of your [`sprinkles`](https://vanilla-extract.style/documentation/sprinkles-api) function directly.
+
+```ts
+import { recipe } from '@vanilla-extract/recipes';
+import { reset } from './reset.css.ts';
+import { sprinkles } from './sprinkles.css.ts';
+
+export const button = recipe({
+  base: [reset, sprinkles({ borderRadius: 'round' })],
+
+  variants: {
+    color: {
+      neutral: sprinkles({ background: 'neutral' }),
+      brand: sprinkles({ background: 'brand' }),
+      accent: sprinkles({ background: 'accent' })
+    },
+    size: {
+      small: sprinkles({ padding: 'small' }),
+      medium: sprinkles({ padding: 'medium' }),
+      large: sprinkles({ padding: 'large' })
+    }
+  },
+
+  defaultVariants: {
+    color: 'accent',
+    size: 'medium'
+  }
+});
+```
+
 ## Dynamic API
 
-We also provide a lightweight standalone package to support dynamic runtime theming.
+Dynamically update theme variables at runtime.
 
 ```bash
 npm install @vanilla-extract/dynamic

package/dist/declarations/src/index.d.ts

@@ -2,6 +2,11 @@ import type { Plugin } from 'vite';
 import { IdentifierOption } from '@vanilla-extract/integration';
 interface Options {
     identifiers?: IdentifierOption;
+    /**
+     * Which CSS runtime to use when running `vite serve`.
+     * @default 'vite'
+     */
+    devStyleRuntime?: 'vite' | 'vanilla-extract';
 }
-export declare function vanillaExtractPlugin({ identifiers }?: Options): Plugin;
+export declare function vanillaExtractPlugin({ identifiers, devStyleRuntime, }?: Options): Plugin;
 export {};

package/dist/vanilla-extract-vite-plugin.cjs.dev.js

@@ -11,10 +11,12 @@ function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e };
 var path__default = /*#__PURE__*/_interopDefault(path);
 
 function vanillaExtractPlugin({
-  identifiers
+  identifiers,
+  devStyleRuntime = 'vite'
 } = {}) {
   let config;
   let packageInfo;
+  let useRuntime = false;
   const cssMap = new Map();
   return {
     name: 'vanilla-extract',
@@ -22,6 +24,7 @@ function vanillaExtractPlugin({
 
     configResolved(resolvedConfig) {
       config = resolvedConfig;
+      useRuntime = devStyleRuntime === 'vanilla-extract' && config.command === 'serve';
       packageInfo = integration.getPackageInfo(config.root);
     },
 
@@ -54,16 +57,12 @@ function vanillaExtractPlugin({
         return null;
       }
 
-      if (ssr && code.indexOf('@vanilla-extract/css/fileScope') === -1) {
-        const filePath = vite.normalizePath(path__default['default'].relative(packageInfo.dirname, id));
-        const packageName = packageInfo.name ? `"${packageInfo.name}"` : 'undefined';
-        return `
-          import { setFileScope, endFileScope } from "@vanilla-extract/css/fileScope";
-          setFileScope("${filePath}", ${packageName});
-  
-          ${code}
-          endFileScope();
-        `;
+      if (ssr || useRuntime) {
+        return integration.addFileScope({
+          source: code,
+          filePath: vite.normalizePath(path__default['default'].relative(packageInfo.dirname, id)),
+          packageInfo
+        }).source;
       }
 
       const {

package/dist/vanilla-extract-vite-plugin.cjs.prod.js

@@ -11,10 +11,12 @@ function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e };
 var path__default = /*#__PURE__*/_interopDefault(path);
 
 function vanillaExtractPlugin({
-  identifiers
+  identifiers,
+  devStyleRuntime = 'vite'
 } = {}) {
   let config;
   let packageInfo;
+  let useRuntime = false;
   const cssMap = new Map();
   return {
     name: 'vanilla-extract',
@@ -22,6 +24,7 @@ function vanillaExtractPlugin({
 
     configResolved(resolvedConfig) {
       config = resolvedConfig;
+      useRuntime = devStyleRuntime === 'vanilla-extract' && config.command === 'serve';
       packageInfo = integration.getPackageInfo(config.root);
     },
 
@@ -54,16 +57,12 @@ function vanillaExtractPlugin({
         return null;
       }
 
-      if (ssr && code.indexOf('@vanilla-extract/css/fileScope') === -1) {
-        const filePath = vite.normalizePath(path__default['default'].relative(packageInfo.dirname, id));
-        const packageName = packageInfo.name ? `"${packageInfo.name}"` : 'undefined';
-        return `
-          import { setFileScope, endFileScope } from "@vanilla-extract/css/fileScope";
-          setFileScope("${filePath}", ${packageName});
-  
-          ${code}
-          endFileScope();
-        `;
+      if (ssr || useRuntime) {
+        return integration.addFileScope({
+          source: code,
+          filePath: vite.normalizePath(path__default['default'].relative(packageInfo.dirname, id)),
+          packageInfo
+        }).source;
       }
 
       const {

package/dist/vanilla-extract-vite-plugin.esm.js

@@ -1,12 +1,14 @@
 import path from 'path';
 import { normalizePath } from 'vite';
-import { getPackageInfo, virtualCssFileFilter, getSourceFromVirtualCssFile, hash, cssFileFilter, compile, processVanillaFile } from '@vanilla-extract/integration';
+import { getPackageInfo, virtualCssFileFilter, getSourceFromVirtualCssFile, hash, cssFileFilter, addFileScope, compile, processVanillaFile } from '@vanilla-extract/integration';
 
 function vanillaExtractPlugin({
-  identifiers
+  identifiers,
+  devStyleRuntime = 'vite'
 } = {}) {
   let config;
   let packageInfo;
+  let useRuntime = false;
   const cssMap = new Map();
   return {
     name: 'vanilla-extract',
@@ -14,6 +16,7 @@ function vanillaExtractPlugin({
 
     configResolved(resolvedConfig) {
       config = resolvedConfig;
+      useRuntime = devStyleRuntime === 'vanilla-extract' && config.command === 'serve';
       packageInfo = getPackageInfo(config.root);
     },
 
@@ -46,16 +49,12 @@ function vanillaExtractPlugin({
         return null;
       }
 
-      if (ssr && code.indexOf('@vanilla-extract/css/fileScope') === -1) {
-        const filePath = normalizePath(path.relative(packageInfo.dirname, id));
-        const packageName = packageInfo.name ? `"${packageInfo.name}"` : 'undefined';
-        return `
-          import { setFileScope, endFileScope } from "@vanilla-extract/css/fileScope";
-          setFileScope("${filePath}", ${packageName});
-  
-          ${code}
-          endFileScope();
-        `;
+      if (ssr || useRuntime) {
+        return addFileScope({
+          source: code,
+          filePath: normalizePath(path.relative(packageInfo.dirname, id)),
+          packageInfo
+        }).source;
       }
 
       const {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vanilla-extract/vite-plugin",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Zero-runtime Stylesheets-in-TypeScript",
   "main": "dist/vanilla-extract-vite-plugin.cjs.js",
   "module": "dist/vanilla-extract-vite-plugin.esm.js",
@@ -15,10 +15,10 @@
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vanilla-extract/integration": "^1.2.0"
+    "@vanilla-extract/integration": "^1.4.2"
   },
   "devDependencies": {
-    "vite": "^2.2.3"
+    "vite": "^2.6.0"
   },
   "peerDependencies": {
     "vite": "^2.2.3"