No description
5a4a7eba3a
## Summary fixes https://github.com/schoero/eslint-plugin-better-tailwindcss/issues/321 This PR fixes an order-sensitive canonicalization bug. This bug caused issues when running eslint-plugin-better-tailwindcss as the order in which files are linted in is not consistent. This caused, in some scenarios, `canonicalizeCandidates(..., { collapse: true, logicalToPhysical: true, rem: 16 })` to stop collapsing valid combinations (for example `h-4 + w-4 -> size-4`) after unrelated prior calls. To reproduce this issue: ``` # checkout this branch $ git checkout c/fix-canonicalizeCandidates # Revert the fix to the current `main` branch $ git checkout main ./packages/tailwindcss/src/canonicalize-candidates.ts # Run the tests $ pnpm run test ``` This should produce a failure like so: ``` FAIL tailwindcss src/canonicalize-candidates.test.ts > regressions > collapse canonicalization is not affected by previous calls AssertionError: expected [ 'underline', 'h-4', 'w-4' ] to deeply equal [ 'underline', 'size-4' ] - Expected + Received [ "underline", - "size-4", + "h-4", + "w-4", ] ❯ src/canonicalize-candidates.test.ts:1167:66 1165| designSystem.canonicalizeCandidates(['underline', 'mb-4'], options) 1166| 1167| expect(designSystem.canonicalizeCandidates(target, options)).toEqual(['underline', 'size-4']) | ^ 1168| }) 1169| }) ``` ``` # reset all changes on this branch git reset --hard # run the tests again (they should now pass) pnpm run test ``` The cause of this bug is that the canonicalization caches used `DefaultMap` in places where lookups were expected to be read-only. `DefaultMap.get` inserts missing entried, which mutated shared cache state during intermediate lookups and made later canonicalization results depend on prior calls. By replacing the use of `DefaultMap` with a plain `Map`, it avoids inserting into the map on lookup paths. I've polyfilled [`Map#getOrInsert`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/getOrInsert) as it is not widely available yet, and used that where appropriate. ## Test plan I wrote a test that fails on `main` branch, I then fixed the issue, and validated that the test now passes. --------- Co-authored-by: Robin Malfait <malfait.robin@gmail.com> |
||
|---|---|---|
| .github | ||
| crates | ||
| integrations | ||
| packages | ||
| patches | ||
| playgrounds | ||
| scripts | ||
| .gitignore | ||
| .prettierignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| rust-toolchain.toml | ||
| turbo.json | ||
| vitest.config.ts | ||
A utility-first CSS framework for rapidly building custom user interfaces.
Documentation
For full documentation, visit tailwindcss.com.
Community
For help, discussion about best practices, or feature ideas:
Discuss Tailwind CSS on GitHub
Contributing
If you're interested in contributing to Tailwind CSS, please read our contributing docs before submitting a pull request.