tailwind-ctp-intellisense/packages/tailwindcss-language-service/src/util/find.ts

463 lines
14 KiB
TypeScript
Raw Normal View History

import type { TextDocument, Range, Position } from 'vscode-languageserver'
2021-05-04 11:40:50 +00:00
import { DocumentClassName, DocumentClassList, State, DocumentHelperFunction } from './state'
2020-04-17 17:59:19 +00:00
import lineColumn from 'line-column'
import { isCssContext, isCssDoc } from './css'
2021-05-04 11:41:13 +00:00
import { isHtmlContext } from './html'
import { isWithinRange } from './isWithinRange'
import { isJsxContext } from './js'
2022-11-04 10:56:23 +00:00
import { dedupeByRange, flatten } from './array'
2021-05-04 11:40:50 +00:00
import { getClassAttributeLexer, getComputedClassAttributeLexer } from './lexers'
import { getLanguageBoundaries } from './getLanguageBoundaries'
2020-08-12 17:45:36 +00:00
import { resolveRange } from './resolveRange'
import Regex from 'becke-ch--regex--s0-0-v1--base--pl--lib'
2022-09-01 14:06:47 +00:00
import { getTextWithoutComments } from './doc'
import { isSemicolonlessCssLanguage } from './languages'
2020-04-17 17:59:19 +00:00
2020-04-11 21:20:45 +00:00
export function findAll(re: RegExp, str: string): RegExpMatchArray[] {
let match: RegExpMatchArray
let matches: RegExpMatchArray[] = []
while ((match = re.exec(str)) !== null) {
matches.push({ ...match })
}
return matches
}
export function findLast(re: RegExp, str: string): RegExpMatchArray {
const matches = findAll(re, str)
if (matches.length === 0) {
return null
}
return matches[matches.length - 1]
}
export function getClassNamesInClassList(
{ classList, range, important }: DocumentClassList,
blocklist: State['blocklist']
): DocumentClassName[] {
const parts = classList.split(/(\s+)/)
const names: DocumentClassName[] = []
let index = 0
for (let i = 0; i < parts.length; i++) {
if (i % 2 === 0 && !blocklist.includes(parts[i])) {
const start = indexToPosition(classList, index)
const end = indexToPosition(classList, index + parts[i].length)
names.push({
className: parts[i],
2020-06-17 17:34:53 +00:00
classList: {
classList,
range,
important,
},
relativeRange: {
start,
end,
},
range: {
start: {
line: range.start.line + start.line,
2021-05-04 11:40:50 +00:00
character: (end.line === 0 ? range.start.character : 0) + start.character,
},
end: {
line: range.start.line + end.line,
2021-05-04 11:40:50 +00:00
character: (end.line === 0 ? range.start.character : 0) + end.character,
},
},
})
}
index += parts[i].length
}
return names
}
export async function findClassNamesInRange(
state: State,
2020-04-17 17:59:19 +00:00
doc: TextDocument,
range?: Range,
2022-09-01 14:06:47 +00:00
mode?: 'html' | 'css' | 'jsx',
includeCustom: boolean = true
): Promise<DocumentClassName[]> {
2021-05-04 11:40:50 +00:00
const classLists = await findClassListsInRange(state, doc, range, mode, includeCustom)
return flatten(
classLists.map((classList) => getClassNamesInClassList(classList, state.blocklist))
)
}
export async function findClassNamesInDocument(
state: State,
doc: TextDocument
): Promise<DocumentClassName[]> {
const classLists = await findClassListsInDocument(state, doc)
return flatten(
classLists.map((classList) => getClassNamesInClassList(classList, state.blocklist))
)
2020-04-17 17:59:19 +00:00
}
export function findClassListsInCssRange(
state: State,
doc: TextDocument,
range?: Range
): DocumentClassList[] {
2022-09-01 14:06:47 +00:00
const text = getTextWithoutComments(doc, 'css', range)
let regex = isSemicolonlessCssLanguage(doc.languageId, state.editor?.userLanguages)
? /(@apply\s+)(?<classList>[^}\r\n]+?)(?<important>\s*!important)?(?:\r|\n|}|$)/g
: /(@apply\s+)(?<classList>[^;}]+?)(?<important>\s*!important)?\s*[;}]/g
const matches = findAll(regex, text)
const globalStart: Position = range ? range.start : { line: 0, character: 0 }
2020-04-17 17:59:19 +00:00
return matches.map((match) => {
const start = indexToPosition(text, match.index + match[1].length)
2021-05-04 11:40:50 +00:00
const end = indexToPosition(text, match.index + match[1].length + match.groups.classList.length)
2020-04-17 17:59:19 +00:00
return {
classList: match.groups.classList,
2020-06-17 17:34:53 +00:00
important: Boolean(match.groups.important),
2020-04-17 17:59:19 +00:00
range: {
start: {
line: globalStart.line + start.line,
2021-05-04 11:40:50 +00:00
character: (end.line === 0 ? globalStart.character : 0) + start.character,
2020-04-17 17:59:19 +00:00
},
end: {
line: globalStart.line + end.line,
2021-05-04 11:40:50 +00:00
character: (end.line === 0 ? globalStart.character : 0) + end.character,
2020-04-17 17:59:19 +00:00
},
},
}
})
}
async function findCustomClassLists(
state: State,
doc: TextDocument,
range?: Range
): Promise<DocumentClassList[]> {
const settings = await state.editor.getConfiguration(doc.uri)
2022-09-13 16:31:09 +00:00
const regexes = settings.tailwindCSS.experimental.classRegex
if (!Array.isArray(regexes) || regexes.length === 0) return []
const text = doc.getText(range)
const result: DocumentClassList[] = []
for (let i = 0; i < regexes.length; i++) {
try {
let [containerRegexString, classRegexString] = Array.isArray(regexes[i])
? regexes[i]
: [regexes[i]]
let containerRegex = new Regex(containerRegexString, 'g')
let containerMatch: ReturnType<Regex['exec']>
while ((containerMatch = containerRegex.exec(text)) !== null) {
2021-05-04 11:40:50 +00:00
const searchStart = doc.offsetAt(range?.start || { line: 0, character: 0 })
const matchStart = searchStart + containerMatch.index[1]
const matchEnd = matchStart + containerMatch[1].length
if (classRegexString) {
let classRegex = new Regex(classRegexString, 'g')
let classMatch: ReturnType<Regex['exec']>
while ((classMatch = classRegex.exec(containerMatch[1])) !== null) {
const classMatchStart = matchStart + classMatch.index[1]
const classMatchEnd = classMatchStart + classMatch[1].length
result.push({
classList: classMatch[1],
range: {
start: doc.positionAt(classMatchStart),
end: doc.positionAt(classMatchEnd),
},
})
}
} else {
result.push({
classList: containerMatch[1],
range: {
start: doc.positionAt(matchStart),
end: doc.positionAt(matchEnd),
},
})
}
}
} catch (_) {}
}
return result
}
2021-10-08 15:51:14 +00:00
export function matchClassAttributes(text: string, attributes: string[]): RegExpMatchArray[] {
const attrs = attributes.filter((x) => typeof x === 'string').flatMap((a) => [a, `\\[${a}\\]`])
const re = /(?:\s|:|\()(ATTRS)\s*=\s*['"`{]/
return findAll(new RegExp(re.source.replace('ATTRS', attrs.join('|')), 'gi'), text)
}
export async function findClassListsInHtmlRange(
state: State,
doc: TextDocument,
2022-09-01 14:06:47 +00:00
type: 'html' | 'js' | 'jsx',
2021-10-08 15:51:14 +00:00
range?: Range
): Promise<DocumentClassList[]> {
2022-09-01 14:06:47 +00:00
const text = getTextWithoutComments(doc, type, range)
2021-10-08 15:51:14 +00:00
const matches = matchClassAttributes(
text,
(await state.editor.getConfiguration(doc.uri)).tailwindCSS.classAttributes
)
const result: DocumentClassList[] = []
matches.forEach((match) => {
2020-06-29 18:06:14 +00:00
const subtext = text.substr(match.index + match[0].length - 1)
let lexer =
2021-10-08 15:51:14 +00:00
match[0][0] === ':' || (match[1].startsWith('[') && match[1].endsWith(']'))
? getComputedClassAttributeLexer()
: getClassAttributeLexer()
lexer.reset(subtext)
let classLists: { value: string; offset: number }[] = []
let token: moo.Token
let currentClassList: { value: string; offset: number }
try {
for (let token of lexer) {
if (token.type === 'classlist' || token.type.startsWith('arb')) {
if (currentClassList) {
currentClassList.value += token.value
} else {
currentClassList = {
value: token.value,
offset: token.offset,
}
}
} else {
if (currentClassList) {
classLists.push({
value: currentClassList.value,
offset: currentClassList.offset,
})
}
currentClassList = undefined
}
}
} catch (_) {}
if (currentClassList) {
classLists.push({
value: currentClassList.value,
offset: currentClassList.offset,
})
}
result.push(
...classLists
.map(({ value, offset }) => {
if (value.trim() === '') {
return null
}
const before = value.match(/^\s*/)
const beforeOffset = before === null ? 0 : before[0].length
const after = value.match(/\s*$/)
const afterOffset = after === null ? 0 : -after[0].length
const start = indexToPosition(
text,
match.index + match[0].length - 1 + offset + beforeOffset
)
const end = indexToPosition(
text,
match.index + match[0].length - 1 + offset + value.length + afterOffset
)
return {
classList: value.substr(beforeOffset, value.length + afterOffset),
range: {
start: {
line: (range?.start.line || 0) + start.line,
character: (end.line === 0 ? range?.start.character || 0 : 0) + start.character,
},
end: {
line: (range?.start.line || 0) + end.line,
character: (end.line === 0 ? range?.start.character || 0 : 0) + end.character,
},
},
}
})
.filter((x) => x !== null)
)
})
return result
}
export async function findClassListsInRange(
state: State,
doc: TextDocument,
range?: Range,
2022-09-01 14:06:47 +00:00
mode?: 'html' | 'css' | 'jsx',
includeCustom: boolean = true
): Promise<DocumentClassList[]> {
let classLists: DocumentClassList[]
if (mode === 'css') {
classLists = findClassListsInCssRange(state, doc, range)
} else {
2022-09-01 14:06:47 +00:00
classLists = await findClassListsInHtmlRange(state, doc, mode, range)
}
2022-11-04 10:56:23 +00:00
return dedupeByRange([
...classLists,
...(includeCustom ? await findCustomClassLists(state, doc, range) : []),
])
}
export async function findClassListsInDocument(
state: State,
doc: TextDocument
): Promise<DocumentClassList[]> {
if (isCssDoc(state, doc)) {
return findClassListsInCssRange(state, doc)
}
let boundaries = getLanguageBoundaries(state, doc)
if (!boundaries) return []
2022-11-04 10:56:23 +00:00
return dedupeByRange(
flatten([
...(await Promise.all(
boundaries
.filter((b) => b.type === 'html' || b.type === 'jsx')
2022-09-01 14:06:47 +00:00
.map(({ type, range }) =>
findClassListsInHtmlRange(state, doc, type === 'html' ? 'html' : 'jsx', range)
)
)),
...boundaries
.filter((b) => b.type === 'css')
.map(({ range }) => findClassListsInCssRange(state, doc, range)),
await findCustomClassLists(state, doc),
])
)
}
2020-08-12 17:45:36 +00:00
export function findHelperFunctionsInDocument(
state: State,
doc: TextDocument
): DocumentHelperFunction[] {
if (isCssDoc(state, doc)) {
return findHelperFunctionsInRange(doc)
}
let boundaries = getLanguageBoundaries(state, doc)
if (!boundaries) return []
return flatten(
boundaries
.filter((b) => b.type === 'css')
.map(({ range }) => findHelperFunctionsInRange(doc, range))
)
2020-08-12 17:45:36 +00:00
}
function getFirstCommaIndex(str: string): number | null {
let quoteChar: string | undefined
for (let i = 0; i < str.length; i++) {
let char = str[i]
if (char === ',' && !quoteChar) {
return i
}
if (!quoteChar && (char === '"' || char === "'")) {
quoteChar = char
} else if (char === quoteChar) {
quoteChar = undefined
}
}
return null
}
2020-08-12 17:45:36 +00:00
export function findHelperFunctionsInRange(
doc: TextDocument,
range?: Range
): DocumentHelperFunction[] {
2022-09-01 14:06:47 +00:00
const text = getTextWithoutComments(doc, 'css', range)
2023-01-04 10:34:41 +00:00
let matches = findAll(
/(?<prefix>[\s:;/*(){}])(?<helper>config|theme)(?<innerPrefix>\(\s*)(?<path>[^)]*?)\s*\)/g,
text
)
2020-08-12 17:45:36 +00:00
return matches.map((match) => {
2022-10-17 16:56:00 +00:00
let quotesBefore = ''
let path = match.groups.path
let commaIndex = getFirstCommaIndex(path)
if (commaIndex !== null) {
path = path.slice(0, commaIndex).trimEnd()
}
path = path.replace(/['"]+$/, '').replace(/^['"]+/, (m) => {
2022-10-17 16:56:00 +00:00
quotesBefore = m
return ''
})
let matches = path.match(/^([^\s]+)(?![^\[]*\])(?:\s*\/\s*([^\/\s]+))$/)
if (matches) {
path = matches[1]
}
path = path.replace(/['"]*\s*$/, '')
2023-01-04 10:34:41 +00:00
let startIndex =
match.index +
match.groups.prefix.length +
match.groups.helper.length +
match.groups.innerPrefix.length
2022-10-17 16:56:00 +00:00
2020-08-12 17:45:36 +00:00
return {
helper: match.groups.helper === 'theme' ? 'theme' : 'config',
2022-10-17 16:56:00 +00:00
path,
ranges: {
full: resolveRange(
{
start: indexToPosition(text, startIndex),
end: indexToPosition(text, startIndex + match.groups.path.length),
},
range
),
path: resolveRange(
{
start: indexToPosition(text, startIndex + quotesBefore.length),
end: indexToPosition(text, startIndex + quotesBefore.length + path.length),
},
range
),
},
2020-08-12 17:45:36 +00:00
}
})
}
export function indexToPosition(str: string, index: number): Position {
2020-04-17 17:59:19 +00:00
const { line, col } = lineColumn(str + '\n', index)
return { line: line - 1, character: col - 1 }
}
export async function findClassNameAtPosition(
state: State,
doc: TextDocument,
position: Position
): Promise<DocumentClassName> {
let classNames = []
const positionOffset = doc.offsetAt(position)
const searchRange: Range = {
2023-04-17 11:09:05 +00:00
start: doc.positionAt(Math.max(0, positionOffset - 2000)),
end: doc.positionAt(positionOffset + 2000),
}
if (isCssContext(state, doc, position)) {
classNames = await findClassNamesInRange(state, doc, searchRange, 'css')
2022-09-01 14:06:47 +00:00
} else if (isHtmlContext(state, doc, position)) {
classNames = await findClassNamesInRange(state, doc, searchRange, 'html')
2022-09-01 14:06:47 +00:00
} else if (isJsxContext(state, doc, position)) {
classNames = await findClassNamesInRange(state, doc, searchRange, 'jsx')
}
if (classNames.length === 0) {
return null
}
2021-05-04 11:40:50 +00:00
const className = classNames.find(({ range }) => isWithinRange(position, range))
if (!className) return null
return className
}