Merge pull request #290 from dcastil/breaking-feature/170/move-separa…

…tor-to-default-config Move separator to config
dcastil · Aug 19, 2023 · cf4cd80 · cf4cd80
2 parents 18e2c71 + 1c41660
commit cf4cd80
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 2 deletions.
diff --git a/src/lib/default-config.ts b/src/lib/default-config.ts
@@ -92,6 +92,7 @@ export function getDefaultConfig() {
 
     return {
         cacheSize: 500,
+        separator: ':',
         theme: {
             colors: [isAny],
             spacing: [isLength],

diff --git a/src/lib/modifier-utils.ts b/src/lib/modifier-utils.ts
@@ -3,7 +3,7 @@ import { Config } from './types'
 export const IMPORTANT_MODIFIER = '!'
 
 export function createSplitModifiers(config: Config) {
-    const separator = config.separator || ':'
+    const separator = config.separator
     const isSeparatorSingleCharacter = separator.length === 1
     const firstSeparatorCharacter = separator[0]
     const separatorLength = separator.length

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -14,7 +14,7 @@ export interface Config {
      * Custom separator for modifiers in Tailwind classes
      * @see https://tailwindcss.com/docs/configuration#separator
      */
-    separator?: string
+    separator: string
     /**
      * Theme scales used in classGroups.
      * The keys are the same as in the Tailwind config but the values are sometimes defined more broadly.

diff --git a/tests/create-tailwind-merge.test.ts b/tests/create-tailwind-merge.test.ts
@@ -3,6 +3,7 @@ import { createTailwindMerge } from '../src'
 test('createTailwindMerge works with single config function', () => {
     const tailwindMerge = createTailwindMerge(() => ({
         cacheSize: 20,
+        separator: ':',
         theme: {},
         classGroups: {
             fooKey: [{ fooKey: ['bar', 'baz'] }],
@@ -42,6 +43,7 @@ test('createTailwindMerge works with multiple config functions', () => {
     const tailwindMerge = createTailwindMerge(
         () => ({
             cacheSize: 20,
+            separator: ':',
             theme: {},
             classGroups: {
                 fooKey: [{ fooKey: ['bar', 'baz'] }],

diff --git a/tests/merge-configs.test.ts b/tests/merge-configs.test.ts
@@ -5,6 +5,7 @@ test('mergeConfigs has correct behavior', () => {
         mergeConfigs(
             {
                 cacheSize: 50,
+                separator: ':',
                 theme: {
                     hi: ['ho'],
                 },
@@ -28,6 +29,7 @@ test('mergeConfigs has correct behavior', () => {
         ),
     ).toEqual({
         cacheSize: 50,
+        separator: ':',
         theme: {
             hi: ['ho'],
         },

diff --git a/tests/modifiers.test.ts b/tests/modifiers.test.ts
@@ -17,6 +17,7 @@ test('conflicts across postfix modifiers', () => {
 
     const customTwMerge = createTailwindMerge(() => ({
         cacheSize: 10,
+        separator: ':',
         theme: {},
         classGroups: {
             foo: ['foo-1/2', 'foo-2/3'],

diff --git a/tests/public-api.test.ts b/tests/public-api.test.ts
@@ -84,6 +84,7 @@ test('createTailwindMerge() has correct inputs and outputs', () => {
     expect(
         createTailwindMerge(() => ({
             cacheSize: 0,
+            separator: ':',
             theme: {},
             classGroups: {},
             conflictingClassGroups: {},
@@ -92,6 +93,7 @@ test('createTailwindMerge() has correct inputs and outputs', () => {
 
     const tailwindMerge = createTailwindMerge(() => ({
         cacheSize: 20,
+        separator: ':',
         theme: {},
         classGroups: {
             fooKey: [{ fooKey: ['bar', 'baz'] }],
@@ -156,6 +158,7 @@ test('mergeConfigs has correct inputs and outputs', () => {
         mergeConfigs(
             {
                 cacheSize: 50,
+                separator: ':',
                 theme: {},
                 classGroups: {
                     fooKey: [{ fooKey: ['one', 'two'] }],