Skip to content

Expand classRegex search range #840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 16, 2023
Merged

Expand classRegex search range #840

merged 1 commit into from
Aug 16, 2023

Conversation

bradlc
Copy link
Contributor

@bradlc bradlc commented Aug 16, 2023

Fixes #832
Fixes #837

This PR expands the classRegex search range so that longer matches can be found (#837). Additionally the search range now always starts at the very beginning of the document, so that patterns match as expected. An example of why this matters is a simple string pattern: '[^']*'. Consider the following document:

'' + 'hello world'

If we start searching from the beginning the matches would be: '', 'hello world', but if we start from the second character the only match would be: ' + '

@bradlc bradlc merged commit 47d512e into master Aug 16, 2023
@bradlc bradlc deleted the fix-832-837 branch August 16, 2023 16:03
start: document.positionAt(Math.max(0, positionOffset - 1000)),
end: document.positionAt(positionOffset + 1000),
start: document.positionAt(0),
end: document.positionAt(positionOffset + 2000),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR @bradlc, it makes the situation with #837 much better.

Do you think if it’s possible to expose 2000 as an extension option? In our codebase, we have several instances of cva() which are pretty heavy on comments, so they end up being more than 2K characters long.

I guess that if we look for cva( + ), the regexp might still not work. Or is it necessary to rewrite it? What do you reckon?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'm open to adding it as a config option. Can you share an example from your project that wouldn't be caught within the new range?

Copy link

@kachkaev kachkaev Aug 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The project is closed sourced, so I can’t share the snippet, sorry. You can imagine chadcn → button.tsx (which is 1000 chars long), but with:

  • a few more variants, including compoundVariants
  • extra spacing between groups of lines
  • comments explaining the difference between variants
  • a few more class names with selectors (hover:, sm:, data-[some-state=some-value]:, [&>svg]: and so on)

It’s quite easy to go beyond 2K symbols with all these.

Copy link

@kachkaev kachkaev Aug 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is an ‘aerial view’ of a real-life cva() call with 10,724 characters in-between 😁

thecrypticace added a commit that referenced this pull request Feb 12, 2025
After doing an admittedly quite small amount of benchmarking it seems
that expanding the search range _does_ have a perf impact but it's not
so much of one that we shouldn't increase it. Though this very likely
depends on the regex in use.

I've done a few major things in this PR:
- Searching for class lists when hovering now starts at the beginning of
the document. This important for users who are using things like `cva`
(the same reason it was expanded for completions in #840)
- The search range for completions inside a class attribute have been
expanded to 15k characters. This is useful if you're using a really
large cva definition in one class list.
- Ditto for searching for custom regexes which is useful when using CVA
with separate variables in a JSX/TSX document.

Fixes #1032
Fixes #984

This is a mostly a stop-gap measure until I can land a better system for
"parsing" documents that aims to make most class detection trivial and
quite fast.

Custom regexes won't necessarily be able to take advantage of that but
if I can get some perf wins elsewhere I might be able to expand the
search range even further. Ideally I'd figure out a way to run regexes
in a worker thread and allow them to be "cancelled" when they take too
long but that is a fairly major-ish undertaking.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants