Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve TypeScript plugin error when the configuration is not statically analyzable #42062

Merged
merged 1 commit into from Oct 30, 2022
Merged

Improve TypeScript plugin error when the configuration is not statically analyzable #42062

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
79 changes: 43 additions & 36 deletions packages/next/server/next-typescript.ts
View file
Open in desktop
Expand Up @@ -130,7 +130,7 @@ function getAPIDescription(api: string): string {
}

function removeStringQuotes(str: string): string {
return str.replace(/^['"]|['"]$/g, '')
return str.replace(/^['"`]|['"`]$/g, '')
}

export function createTSPlugin(modules: {
Expand Down Expand Up @@ -527,8 +527,16 @@ export function createTSPlugin(modules: {
} else if (API_DOCS[name.text]) {
// Check if the value is valid
const value = declarartion.initializer

if (value) {
if (value.kind === ts.SyntaxKind.StringLiteral) {
let displayedValue = ''
let errorMessage = ''
let isInvalid = false

if (
ts.isStringLiteral(value) ||
ts.isNoSubstitutionTemplateLiteral(value)
) {
const text = removeStringQuotes(value.getText())
const allowedValues = Object.keys(
API_DOCS[name.text].options
Expand All @@ -537,59 +545,58 @@ export function createTSPlugin(modules: {
.map(removeStringQuotes)

if (!allowedValues.includes(text)) {
prior.push({
file: source,
category: ts.DiagnosticCategory.Error,
code: 71003,
messageText: `"'${text}'" is not a valid value for the "${name.text}" option.`,
start: value.getStart(),
length: value.getEnd() - value.getStart(),
})
isInvalid = true
displayedValue = `'${text}'`
}
} else if (
value.kind === ts.SyntaxKind.NumericLiteral ||
(value.kind === ts.SyntaxKind.PrefixUnaryExpression &&
(value as any).operator ===
ts.SyntaxKind.MinusToken &&
(value as any).operand.kind ===
ts.SyntaxKind.NumericLiteral) ||
(value.kind === ts.SyntaxKind.Identifier &&
ts.isNumericLiteral(value) ||
(ts.isPrefixUnaryExpression(value) &&
ts.isMinusToken((value as any).operator) &&
(ts.isNumericLiteral((value as any).operand.kind) ||
(ts.isIdentifier((value as any).operand.kind) &&
(value as any).operand.kind.getText() ===
'Infinity'))) ||
(ts.isIdentifier(value) &&
value.getText() === 'Infinity')
) {
const v = value.getText()
if (API_DOCS[name.text].isValid?.(v) === false) {
prior.push({
file: source,
category: ts.DiagnosticCategory.Error,
code: 71003,
messageText: `"${v}" is not a valid value for the "${name.text}" option.`,
start: value.getStart(),
length: value.getEnd() - value.getStart(),
})
isInvalid = true
displayedValue = v
}
} else if (
value.kind === ts.SyntaxKind.TrueKeyword ||
value.kind === ts.SyntaxKind.FalseKeyword
) {
const v = value.getText()
if (API_DOCS[name.text].isValid?.(v) === false) {
prior.push({
file: source,
category: ts.DiagnosticCategory.Error,
code: 71003,
messageText: `"${v}" is not a valid value for the "${name.text}" option.`,
start: value.getStart(),
length: value.getEnd() - value.getStart(),
})
isInvalid = true
displayedValue = v
}
} else if (
// Other literals
ts.isBigIntLiteral(value) ||
ts.isArrayLiteralExpression(value) ||
ts.isObjectLiteralExpression(value) ||
ts.isRegularExpressionLiteral(value)
) {
isInvalid = true
displayedValue = value.getText()
} else {
// Not a literal, error because it's not statically analyzable
isInvalid = true
displayedValue = value.getText()
errorMessage = `"${displayedValue}" is not a valid value for the "${name.text}" option. The configuration must be statically analyzable.`
}

if (isInvalid) {
prior.push({
file: source,
category: ts.DiagnosticCategory.Error,
code: 71003,
messageText: `"${value.getText()}" is not a valid value for the "${
name.text
}" option.`,
messageText:
errorMessage ||
`"${displayedValue}" is not a valid value for the "${name.text}" option.`,
start: value.getStart(),
length: value.getEnd() - value.getStart(),
})
Expand Down