mirror of
https://github.com/tailwindlabs/tailwindcss.git
synced 2025-12-08 21:36:08 +00:00
* implement `getSortOrder` instead of `sortClassList` * rename `getSortOrder` to `getClassOrder` * update changelog
116 lines
3.6 KiB
JavaScript
116 lines
3.6 KiB
JavaScript
import resolveConfig from '../src/public/resolve-config'
|
|
import { createContext } from '../src/lib/setupContextUtils'
|
|
import bigSign from '../src/util/bigSign'
|
|
|
|
/**
|
|
* This is a function that the prettier-plugin-tailwindcss would use. It would
|
|
* do the actual sorting based on the classes and order we return from `getClassOrder`.
|
|
*
|
|
* This way the actual sorting logic is done in the plugin which allows you to
|
|
* put unknown classes at the end for example.
|
|
*
|
|
* @param {Array<[string, bigint]>} arrayOfTuples
|
|
* @returns {string}
|
|
*/
|
|
function defaultSort(arrayOfTuples) {
|
|
return arrayOfTuples
|
|
.sort(([, a], [, z]) => {
|
|
if (a === z) return 0
|
|
if (a === null) return -1
|
|
if (z === null) return 1
|
|
return bigSign(a - z)
|
|
})
|
|
.map(([className]) => className)
|
|
.join(' ')
|
|
}
|
|
|
|
it('should return a list of tuples with the sort order', () => {
|
|
let input = 'font-bold underline hover:font-medium unknown'
|
|
let config = {}
|
|
let context = createContext(resolveConfig(config))
|
|
expect(context.getClassOrder(input.split(' '))).toEqual([
|
|
['font-bold', expect.any(BigInt)],
|
|
['underline', expect.any(BigInt)],
|
|
['hover:font-medium', expect.any(BigInt)],
|
|
|
|
// Unknown values receive `null`
|
|
['unknown', null],
|
|
])
|
|
})
|
|
|
|
it.each([
|
|
// Utitlies
|
|
['px-3 p-1 py-3', 'p-1 px-3 py-3'],
|
|
|
|
// Utitlies and components
|
|
['px-4 container', 'container px-4'],
|
|
|
|
// Utilities with variants
|
|
['px-3 focus:hover:p-3 hover:p-1 py-3', 'px-3 py-3 hover:p-1 focus:hover:p-3'],
|
|
|
|
// Utitlies with important
|
|
['px-3 !py-4', 'px-3 !py-4'],
|
|
['!py-4 px-3', '!py-4 px-3'],
|
|
|
|
// Components with variants
|
|
['hover:container container', 'container hover:container'],
|
|
|
|
// Components and utilities with variants
|
|
[
|
|
'focus:hover:container hover:underline hover:container p-1',
|
|
'p-1 hover:container hover:underline focus:hover:container',
|
|
],
|
|
|
|
// Leave user css order alone, and move to the front
|
|
['b p-1 a', 'b a p-1'],
|
|
['hover:b focus:p-1 a', 'hover:b a focus:p-1'],
|
|
|
|
// Add special treatment for `group` and `peer`
|
|
['a peer container underline', 'a peer container underline'],
|
|
])('should sort "%s" based on the order we generate them in to "%s"', (input, output) => {
|
|
let config = {}
|
|
let context = createContext(resolveConfig(config))
|
|
expect(defaultSort(context.getClassOrder(input.split(' ')))).toEqual(output)
|
|
})
|
|
|
|
it.each([
|
|
// Utitlies
|
|
['tw-px-3 tw-p-1 tw-py-3', 'tw-p-1 tw-px-3 tw-py-3'],
|
|
|
|
// Utitlies and components
|
|
['tw-px-4 tw-container', 'tw-container tw-px-4'],
|
|
|
|
// Utilities with variants
|
|
[
|
|
'tw-px-3 focus:hover:tw-p-3 hover:tw-p-1 tw-py-3',
|
|
'tw-px-3 tw-py-3 hover:tw-p-1 focus:hover:tw-p-3',
|
|
],
|
|
|
|
// Utitlies with important
|
|
['tw-px-3 !tw-py-4', 'tw-px-3 !tw-py-4'],
|
|
['!tw-py-4 tw-px-3', '!tw-py-4 tw-px-3'],
|
|
|
|
// Components with variants
|
|
['hover:tw-container tw-container', 'tw-container hover:tw-container'],
|
|
|
|
// Components and utilities with variants
|
|
[
|
|
'focus:hover:tw-container hover:tw-underline hover:tw-container tw-p-1',
|
|
'tw-p-1 hover:tw-container hover:tw-underline focus:hover:tw-container',
|
|
],
|
|
|
|
// Leave user css order alone, and move to the front
|
|
['b tw-p-1 a', 'b a tw-p-1'],
|
|
['hover:b focus:tw-p-1 a', 'hover:b a focus:tw-p-1'],
|
|
|
|
// Add special treatment for `group` and `peer`
|
|
['a tw-peer tw-container tw-underline', 'a tw-peer tw-container tw-underline'],
|
|
])(
|
|
'should sort "%s" with prefixex based on the order we generate them in to "%s"',
|
|
(input, output) => {
|
|
let config = { prefix: 'tw-' }
|
|
let context = createContext(resolveConfig(config))
|
|
expect(defaultSort(context.getClassOrder(input.split(' ')))).toEqual(output)
|
|
}
|
|
)
|