1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

import { State, Settings } from '../util/state'
import type { TextDocument, Range, DiagnosticSeverity } from 'vscode-languageserver'
import { InvalidConfigPathDiagnostic, DiagnosticKind } from './types'
import { isCssDoc } from '../util/css'
import { getLanguageBoundaries } from '../util/getLanguageBoundaries'
import { findAll, indexToPosition } from '../util/find'
import { stringToPath } from '../util/stringToPath'
import isObject from '../util/isObject'
import { closest } from '../util/closest'
import { absoluteRange } from '../util/absoluteRange'
import { combinations } from '../util/combinations'
import dlv from 'dlv'
import { getTextWithoutComments } from '../util/doc'

function pathToString(path: string | string[]): string {
  if (typeof path === 'string') return path
  return path.reduce((acc, cur, i) => {
    if (i === 0) return cur
    if (cur.includes('.')) return `${acc}[${cur}]`
    return `${acc}.${cur}`
  }, '')
}

export function validateConfigPath(
  state: State,
  path: string | string[],
  base: string[] = []
): { isValid: true; value: any } | { isValid: false; reason: string; suggestions: string[] } {
  let keys = Array.isArray(path) ? path : stringToPath(path)
  let value = dlv(state.config, [...base, ...keys])
  let suggestions: string[] = []

  function findAlternativePath(): string[] {
    let points = combinations('123456789'.substr(0, keys.length - 1)).map((x) =>
      x.split('').map((x) => parseInt(x, 10))
    )

    let possibilities: string[][] = points
      .map((p) => {
        let result = []
        let i = 0
        p.forEach((x) => {
          result.push(keys.slice(i, x).join('.'))
          i = x
        })
        result.push(keys.slice(i).join('.'))
        return result
      })
      .slice(1) // skip original path

    return possibilities.find((possibility) => validateConfigPath(state, possibility, base).isValid)
  }

  if (typeof value === 'undefined') {
    let reason = `'${pathToString(path)}' does not exist in your theme config.`
    let parentPath = [...base, ...keys.slice(0, keys.length - 1)]
    let parentValue = dlv(state.config, parentPath)

    if (isObject(parentValue)) {
      let closestValidKey = closest(
        keys[keys.length - 1],
        Object.keys(parentValue).filter(
          (key) => validateConfigPath(state, [...parentPath, key]).isValid
        )
      )
      if (closestValidKey) {
        suggestions.push(pathToString([...keys.slice(0, keys.length - 1), closestValidKey]))
        reason += ` Did you mean '${suggestions[0]}'?`
      }
    } else {
      let altPath = findAlternativePath()
      if (altPath) {
        return {
          isValid: false,
          reason: `${reason} Did you mean '${pathToString(altPath)}'?`,
          suggestions: [pathToString(altPath)],
        }
      }
    }

    return {
      isValid: false,
      reason,
      suggestions,
    }
  }

  if (
    !(
      typeof value === 'string' ||
      typeof value === 'number' ||
      value instanceof String ||
      value instanceof Number ||
      Array.isArray(value) ||
      typeof value === 'function'
    )
  ) {
    let reason = `'${pathToString(path)}' was found but does not resolve to a valid theme value.`

    if (isObject(value)) {
      let validKeys = Object.keys(value).filter(
        (key) => validateConfigPath(state, [...keys, key], base).isValid
      )
      if (validKeys.length) {
        suggestions.push(...validKeys.map((validKey) => pathToString([...keys, validKey])))
        reason += ` Did you mean something like '${suggestions[0]}'?`
      }
    }
    return {
      isValid: false,
      reason,
      suggestions,
    }
  }

  // The value resolves successfully, but we need to check that there
  // wasn't any funny business. If you have a theme object:
  // { msg: 'hello' } and do theme('msg.0')
  // this will resolve to 'h', which is probably not intentional, so we
  // check that all of the keys are object or array keys (i.e. not string
  // indexes)
  let isValid = true
  for (let i = keys.length - 1; i >= 0; i--) {
    let key = keys[i]
    let parentValue = dlv(state.config, [...base, ...keys.slice(0, i)])
    if (/^[0-9]+$/.test(key)) {
      if (!isObject(parentValue) && !Array.isArray(parentValue)) {
        isValid = false
        break
      }
    } else if (!isObject(parentValue)) {
      isValid = false
      break
    }
  }
  if (!isValid) {
    let reason = `'${pathToString(path)}' does not exist in your theme config.`

    let altPath = findAlternativePath()
    if (altPath) {
      return {
        isValid: false,
        reason: `${reason} Did you mean '${pathToString(altPath)}'?`,
        suggestions: [pathToString(altPath)],
      }
    }

    return {
      isValid: false,
      reason,
      suggestions: [],
    }
  }

  return {
    isValid: true,
    value,
  }
}

export function getInvalidConfigPathDiagnostics(
  state: State,
  document: TextDocument,
  settings: Settings
): InvalidConfigPathDiagnostic[] {
  let severity = settings.tailwindCSS.lint.invalidConfigPath
  if (severity === 'ignore') return []

  let diagnostics: InvalidConfigPathDiagnostic[] = []
  let ranges: Range[] = []

  if (isCssDoc(state, document)) {
    ranges.push(undefined)
  } else {
    let boundaries = getLanguageBoundaries(state, document)
    if (!boundaries) return []
    ranges.push(...boundaries.filter((b) => b.type === 'css').map(({ range }) => range))
  }

  ranges.forEach((range) => {
    let text = getTextWithoutComments(document, 'css', range)
    let matches = findAll(
      /(?<prefix>\s|^)(?<helper>config|theme)\((?<quote>['"])(?<key>[^)]+)\k<quote>[^)]*\)/g,
      text
    )

    matches.forEach((match) => {
      let base = match.groups.helper === 'theme' ? ['theme'] : []
      let result = validateConfigPath(state, match.groups.key, base)

      if (result.isValid === true) {
        return null
      }

      let startIndex =
        match.index +
        match.groups.prefix.length +
        match.groups.helper.length +
        1 + // open paren
        match.groups.quote.length

      diagnostics.push({
        code: DiagnosticKind.InvalidConfigPath,
        range: absoluteRange(
          {
            start: indexToPosition(text, startIndex),
            end: indexToPosition(text, startIndex + match.groups.key.length),
          },
          range
        ),
        severity:
          severity === 'error'
            ? 1 /* DiagnosticSeverity.Error */
            : 2 /* DiagnosticSeverity.Warning */,
        message: result.reason,
        suggestions: result.suggestions,
      })
    })
  })

  return diagnostics
}