typescript should throw an error when passed compoundVariants or defa…

…ultVariants with non-existing variants
Jackardios · Mar 28, 2023 · d57c9b7 · d57c9b7
1 parent 21d20ab
commit d57c9b7
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 17 deletions.
diff --git a/.changeset/smooth-humans-appear.md b/.changeset/smooth-humans-appear.md
@@ -0,0 +1,5 @@
+---
+'react-tailwind-variants': patch
+---
+
+typescript should throw an error when passed compoundVariants or defaultVariants with non-existing variants
diff --git a/src/react.ts b/src/react.ts
@@ -14,6 +14,7 @@ import {
   type VariantsSchema,
   type VariantOptions,
   variants,
+  Simplify,
 } from './variants';
 
 const StyledComponentConfigKey = '$$tailwindVariantsConfig';
@@ -30,7 +31,7 @@ export type StyledComponent<
 export function variantProps<
   C extends VariantsConfig<V>,
   V extends VariantsSchema = NonNullable<C['variants']>
->(config: C) {
+>(config: Simplify<C>) {
   const variantsHandler = variants(config);
 
   type Props = VariantOptions<C> & {
@@ -45,7 +46,7 @@ export function variantProps<
       if (
         !('variants' in config) ||
         !config.variants ||
-        !(prop in config.variants)
+        !(prop in (config.variants as V))
       ) {
         result[prop] = props[prop];
       }
@@ -71,7 +72,7 @@ export function styled<
   T extends ElementType,
   C extends VariantsConfig<V>,
   V extends VariantsSchema = NonNullable<C['variants']>
->(baseType: T, config: C) {
+>(baseType: T, config: Simplify<C>) {
   const propsHandler = variantProps(config);
 
   type ConfigVariants = VariantOptions<C>;

diff --git a/src/variants.ts b/src/variants.ts
@@ -12,6 +12,7 @@ type OmitByValue<T, Value> = {
   [P in keyof T as T[P] extends Value ? never : P]: T[P];
 };
 type StringToBoolean<T> = T extends 'true' | 'false' ? boolean : T;
+export type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
 
 export type ClassNameValue = string | null | undefined | ClassNameValue[];
 
@@ -31,12 +32,14 @@ export type ClassNameValue = string | null | undefined | ClassNameValue[];
  */
 export type VariantsSchema = Record<string, Record<string, ClassNameValue>>;
 
-export interface VariantsConfig<V extends VariantsSchema> {
+export type VariantsConfig<V extends VariantsSchema> = {
   base?: ClassNameValue;
   variants?: V;
-  defaultVariants?: keyof V extends never ? never : Partial<Variants<V>>;
-  compoundVariants?: keyof V extends never ? never : CompoundVariant<V>[];
-}
+  defaultVariants?: keyof V extends never
+    ? Record<string, never>
+    : Partial<Variants<V>>;
+  compoundVariants?: keyof V extends never ? never[] : CompoundVariant<V>[];
+};
 
 /**
  * Rules for class names that are applied for certain variant combinations.
@@ -109,7 +112,7 @@ type VariantsHandlerFn<P> = PickRequiredKeys<P> extends never
 export function variants<
   C extends VariantsConfig<V>,
   V extends VariantsSchema = NonNullable<C['variants']>
->(config: C) {
+>(config: Simplify<C>) {
   const { base, variants, compoundVariants, defaultVariants } = config;
 
   if (!('variants' in config) || !config.variants) {
@@ -118,7 +121,7 @@ export function variants<
   }
 
   function isBooleanVariant(name: keyof V) {
-    const variant = variants?.[name];
+    const variant = (variants as V)?.[name];
     return variant && ('false' in variant || 'true' in variant);
   }
 

diff --git a/test/react.spec.tsx b/test/react.spec.tsx
@@ -144,6 +144,19 @@ styled('div', {
   },
 });
 
+styled('div', {
+  variants: {
+    color: {
+      neutral: 'grey',
+      accent: 'hotpink',
+    },
+  },
+  defaultVariants: {
+    // @ts-expect-error
+    test: 'invalid',
+  },
+});
+
 styled('div', {
   variants: {
     color: {

diff --git a/test/variants.spec.ts b/test/variants.spec.ts
@@ -9,8 +9,13 @@ describe('variants', () => {
     describe('without variants', () => {
       test('with compoundVariants', () => {
         const withoutBaseWithCompoundVariants = variants({
-          // @ts-expect-error
-          compoundVariants: [],
+          compoundVariants: [
+            // @ts-expect-error
+            {
+              variants: { color: 'primary' },
+              className: 'text-primary-500',
+            },
+          ],
         });
         expect(
           withoutBaseWithCompoundVariants({ className: 'bg-blue-500 foobar' })
@@ -23,8 +28,10 @@ describe('variants', () => {
 
       test('with defaultVariants', () => {
         const withoutBaseWithDefaultVariants = variants({
-          // @ts-expect-error
-          defaultVariants: {},
+          defaultVariants: {
+            // @ts-expect-error
+            color: 'primary',
+          },
         });
         expect(
           withoutBaseWithDefaultVariants({ className: 'bg-blue-500 foobar' })
@@ -496,8 +503,13 @@ describe('variants', () => {
       test('with compoundVariants', () => {
         const withoutBaseWithCompoundVariants = variants({
           base: 'text-white bg-black',
-          // @ts-expect-error
-          compoundVariants: [],
+          compoundVariants: [
+            // @ts-expect-error
+            {
+              variants: { color: 'primary' },
+              className: 'text-primary-500',
+            },
+          ],
         });
         expect(
           withoutBaseWithCompoundVariants({ className: 'bg-blue-500 foobar' })
@@ -517,8 +529,10 @@ describe('variants', () => {
       test('with defaultVariants', () => {
         const withoutBaseWithDefaultVariants = variants({
           base: 'text-white bg-black',
-          // @ts-expect-error
-          defaultVariants: {},
+          defaultVariants: {
+            // @ts-expect-error
+            color: 'primary',
+          },
         });
         expect(
           withoutBaseWithDefaultVariants({ className: 'bg-blue-500 foobar' })