feat(editor): show column hints for INSERT values
This commit is contained in:
Freedom authored and GitHub committed
1 parent
ff570d5268
commit
86dad5db9f
18 files changed
+1076
-5
No files matched your search
@@ -0,0 +1,499 @@
|
||||
import { findActiveSqlStatementSpan, tokenizeSqlSemantic, tokenIsIdentifier, unquoteSqlSemanticIdentifier } from "@/lib/sql/semantic/tokens";
|
||||
import type { SqlSemanticSpan, SqlSemanticToken } from "@/lib/sql/semantic/types";
|
||||
|
||||
export interface InsertValueHint {
|
||||
/** Document offset where the inlay widget is inserted (before the value expression). */
|
||||
from: number;
|
||||
column: string;
|
||||
}
|
||||
|
||||
export interface InsertValuesClause {
|
||||
table: string;
|
||||
schema?: string;
|
||||
/** Catalog/database qualifier for three-part names like OtherDb.dbo.Users. */
|
||||
database?: string;
|
||||
/** Explicit column list, or null when `INSERT INTO t VALUES` has no column list. */
|
||||
columns: string[] | null;
|
||||
/** For each VALUES row, start offsets of top-level value expressions. */
|
||||
rows: number[][];
|
||||
span: SqlSemanticSpan;
|
||||
}
|
||||
|
||||
export interface ParseInsertValueHintsOptions {
|
||||
/** Resolve table columns when the INSERT has no explicit column list. */
|
||||
resolveTableColumns?: (table: string, schema?: string, database?: string) => string[] | undefined;
|
||||
}
|
||||
|
||||
export interface TextRange {
|
||||
from: number;
|
||||
to: number;
|
||||
}
|
||||
|
||||
function significantTokens(tokens: readonly SqlSemanticToken[]): SqlSemanticToken[] {
|
||||
return tokens.filter((item) => item.kind !== "comment");
|
||||
}
|
||||
|
||||
function statementSpans(sql: string, tokens: readonly SqlSemanticToken[]): SqlSemanticSpan[] {
|
||||
const spans: SqlSemanticSpan[] = [];
|
||||
let start = 0;
|
||||
for (const item of tokens) {
|
||||
if (item.kind !== "punctuation" || item.text !== ";" || item.depth !== 0) continue;
|
||||
const span = trimSpan(sql, start, item.span.start);
|
||||
if (span.end > span.start) spans.push(span);
|
||||
start = item.span.end;
|
||||
}
|
||||
const last = trimSpan(sql, start, sql.length);
|
||||
if (last.end > last.start) spans.push(last);
|
||||
return spans;
|
||||
}
|
||||
|
||||
function trimSpan(sql: string, start: number, end: number): SqlSemanticSpan {
|
||||
let from = start;
|
||||
let to = end;
|
||||
while (from < to && /\s/.test(sql[from] ?? "")) from += 1;
|
||||
while (to > from && /\s/.test(sql[to - 1] ?? "")) to -= 1;
|
||||
return { start: from, end: to };
|
||||
}
|
||||
|
||||
function tokensInSpan(tokens: readonly SqlSemanticToken[], span: SqlSemanticSpan): SqlSemanticToken[] {
|
||||
return tokens.filter((item) => item.span.end > span.start && item.span.start < span.end);
|
||||
}
|
||||
|
||||
function findWordIndex(tokens: readonly SqlSemanticToken[], word: string, from = 0): number {
|
||||
const needle = word.toLowerCase();
|
||||
for (let index = from; index < tokens.length; index += 1) {
|
||||
const item = tokens[index];
|
||||
if (item?.kind === "word" && item.normalized === needle) return index;
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
export function readQualifiedName(tokens: readonly SqlSemanticToken[], startIndex: number): { name: string; schema?: string; database?: string; nextIndex: number } | null {
|
||||
const first = tokens[startIndex];
|
||||
if (!tokenIsIdentifier(first)) return null;
|
||||
const parts = [unquoteSqlSemanticIdentifier(first)];
|
||||
let index = startIndex + 1;
|
||||
while (tokens[index]?.text === "." && tokenIsIdentifier(tokens[index + 1])) {
|
||||
parts.push(unquoteSqlSemanticIdentifier(tokens[index + 1]!));
|
||||
index += 2;
|
||||
}
|
||||
if (parts.length >= 3) {
|
||||
return {
|
||||
database: parts[parts.length - 3],
|
||||
schema: parts[parts.length - 2],
|
||||
name: parts[parts.length - 1]!,
|
||||
nextIndex: index,
|
||||
};
|
||||
}
|
||||
if (parts.length === 2) {
|
||||
return { schema: parts[0], name: parts[1]!, nextIndex: index };
|
||||
}
|
||||
return { name: parts[0]!, nextIndex: index };
|
||||
}
|
||||
|
||||
function parseColumnList(tokens: readonly SqlSemanticToken[], openIndex: number): { columns: string[]; nextIndex: number } | null {
|
||||
const open = tokens[openIndex];
|
||||
if (!open || open.text !== "(") return null;
|
||||
const columns: string[] = [];
|
||||
let index = openIndex + 1;
|
||||
while (index < tokens.length) {
|
||||
const item = tokens[index];
|
||||
if (!item) break;
|
||||
if (item.text === ")" && item.depth === open.depth) {
|
||||
return { columns, nextIndex: index + 1 };
|
||||
}
|
||||
if (tokenIsIdentifier(item) && item.depth === open.depth + 1) {
|
||||
columns.push(unquoteSqlSemanticIdentifier(item));
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
index += 1;
|
||||
}
|
||||
return { columns, nextIndex: index };
|
||||
}
|
||||
|
||||
function valueStartsInRow(tokens: readonly SqlSemanticToken[], openIndex: number): { starts: number[]; nextIndex: number } | null {
|
||||
const open = tokens[openIndex];
|
||||
if (!open || open.text !== "(") return null;
|
||||
const contentDepth = open.depth + 1;
|
||||
const starts: number[] = [];
|
||||
let expectValue = true;
|
||||
let index = openIndex + 1;
|
||||
|
||||
while (index < tokens.length) {
|
||||
const item = tokens[index];
|
||||
if (!item) break;
|
||||
if (item.text === ")" && item.depth === open.depth) {
|
||||
return { starts, nextIndex: index + 1 };
|
||||
}
|
||||
if (expectValue && item.depth === contentDepth) {
|
||||
starts.push(item.span.start);
|
||||
expectValue = false;
|
||||
}
|
||||
if (item.text === "," && item.depth === contentDepth) {
|
||||
expectValue = true;
|
||||
}
|
||||
index += 1;
|
||||
}
|
||||
return { starts, nextIndex: index };
|
||||
}
|
||||
|
||||
function parseValuesRows(tokens: readonly SqlSemanticToken[], valuesIndex: number): number[][] {
|
||||
const rows: number[][] = [];
|
||||
let index = valuesIndex + 1;
|
||||
while (index < tokens.length) {
|
||||
const item = tokens[index];
|
||||
if (!item) break;
|
||||
if (item.kind === "word" && (item.normalized === "returning" || item.normalized === "on" || item.normalized === "select")) break;
|
||||
if (item.text === "(") {
|
||||
const row = valueStartsInRow(tokens, index);
|
||||
if (!row) break;
|
||||
if (row.starts.length > 0) rows.push(row.starts);
|
||||
index = row.nextIndex;
|
||||
continue;
|
||||
}
|
||||
if (item.text === ",") {
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
break;
|
||||
}
|
||||
return rows;
|
||||
}
|
||||
|
||||
function parseInsertClause(tokens: readonly SqlSemanticToken[], span: SqlSemanticSpan): InsertValuesClause | null {
|
||||
const insertIndex = findWordIndex(tokens, "insert");
|
||||
if (insertIndex < 0) return null;
|
||||
const intoIndex = findWordIndex(tokens, "into", insertIndex + 1);
|
||||
if (intoIndex < 0) return null;
|
||||
|
||||
const tableInfo = readQualifiedName(tokens, intoIndex + 1);
|
||||
if (!tableInfo) return null;
|
||||
|
||||
let index = tableInfo.nextIndex;
|
||||
let columns: string[] | null = null;
|
||||
|
||||
// SQL Server table hints appear between the target table and INSERT column list.
|
||||
if (tokens[index]?.normalized === "with" && tokens[index + 1]?.text === "(") {
|
||||
const hintList = parseColumnList(tokens, index + 1);
|
||||
if (!hintList) return null;
|
||||
index = hintList.nextIndex;
|
||||
}
|
||||
|
||||
// Optional alias between table and column list / VALUES / SELECT
|
||||
if (tokenIsIdentifier(tokens[index]) && tokens[index]?.normalized !== "values" && tokens[index]?.normalized !== "select" && tokens[index]?.normalized !== "default") {
|
||||
const maybeAs = tokens[index];
|
||||
if (maybeAs?.normalized === "as" && tokenIsIdentifier(tokens[index + 1])) {
|
||||
index += 2;
|
||||
} else if (tokens[index]?.text !== "(") {
|
||||
index += 1;
|
||||
}
|
||||
}
|
||||
|
||||
if (tokens[index]?.text === "(") {
|
||||
const columnList = parseColumnList(tokens, index);
|
||||
if (!columnList) return null;
|
||||
columns = columnList.columns;
|
||||
index = columnList.nextIndex;
|
||||
}
|
||||
|
||||
const valuesIndex = findWordIndex(tokens, "values", index);
|
||||
const selectIndex = findWordIndex(tokens, "select", index);
|
||||
if (valuesIndex < 0) return null;
|
||||
if (selectIndex >= 0 && selectIndex < valuesIndex) return null;
|
||||
|
||||
const rows = parseValuesRows(tokens, valuesIndex);
|
||||
if (rows.length === 0) return null;
|
||||
|
||||
return {
|
||||
table: tableInfo.name,
|
||||
schema: tableInfo.schema,
|
||||
database: tableInfo.database,
|
||||
columns,
|
||||
rows,
|
||||
span,
|
||||
};
|
||||
}
|
||||
|
||||
function shiftClause(clause: InsertValuesClause, offset: number): InsertValuesClause {
|
||||
if (offset === 0) return clause;
|
||||
return {
|
||||
...clause,
|
||||
span: { start: clause.span.start + offset, end: clause.span.end + offset },
|
||||
rows: clause.rows.map((row) => row.map((from) => from + offset)),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Expand [from, to) to the nearest top-level statement window (quote/comment aware).
|
||||
* Scans at most LOOKBACK bytes before `from` and LOOKAHEAD after `to` so large scripts
|
||||
* do not pay O(document) on every keystroke.
|
||||
*/
|
||||
const STATEMENT_LOOKBACK = 32 * 1024;
|
||||
const STATEMENT_LOOKAHEAD = 32 * 1024;
|
||||
|
||||
export function expandToSqlStatementWindow(sql: string, from: number, to: number): TextRange {
|
||||
const safeFrom = Math.max(0, Math.min(from, sql.length));
|
||||
const safeTo = Math.max(safeFrom, Math.min(to, sql.length));
|
||||
const scanFrom = Math.max(0, safeFrom - STATEMENT_LOOKBACK);
|
||||
const scanTo = Math.min(sql.length, safeTo + STATEMENT_LOOKAHEAD);
|
||||
const slice = scanFrom === 0 && scanTo === sql.length ? sql : sql.slice(scanFrom, scanTo);
|
||||
const localFrom = safeFrom - scanFrom;
|
||||
const localTo = safeTo - scanFrom;
|
||||
const start = findStatementStart(slice, localFrom) + scanFrom;
|
||||
const end = findStatementEnd(slice, Math.max(localFrom, localTo)) + scanFrom;
|
||||
const trimmed = trimSpan(sql, start, Math.min(end, scanTo));
|
||||
return { from: trimmed.start, to: trimmed.end };
|
||||
}
|
||||
|
||||
function findStatementStart(sql: string, pos: number): number {
|
||||
let index = 0;
|
||||
let start = 0;
|
||||
let depth = 0;
|
||||
let inLineComment = false;
|
||||
let inBlockComment = false;
|
||||
let quote: string | null = null;
|
||||
|
||||
while (index < pos) {
|
||||
const ch = sql[index] ?? "";
|
||||
const next = sql[index + 1] ?? "";
|
||||
|
||||
if (inLineComment) {
|
||||
if (ch === "\n") inLineComment = false;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (inBlockComment) {
|
||||
if (ch === "*" && next === "/") {
|
||||
inBlockComment = false;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (quote) {
|
||||
if (ch === quote) {
|
||||
if (next === quote) {
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
quote = null;
|
||||
}
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (ch === "-" && next === "-") {
|
||||
inLineComment = true;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
if (ch === "#") {
|
||||
inLineComment = true;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "/" && next === "*") {
|
||||
inBlockComment = true;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
if (ch === "'" || ch === '"' || ch === "`") {
|
||||
quote = ch;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "[") {
|
||||
quote = "]";
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "(") {
|
||||
depth += 1;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === ")") {
|
||||
depth = Math.max(0, depth - 1);
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === ";" && depth === 0) {
|
||||
start = index + 1;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
index += 1;
|
||||
}
|
||||
return start;
|
||||
}
|
||||
|
||||
function findStatementEnd(sql: string, pos: number): number {
|
||||
let index = pos;
|
||||
let depth = 0;
|
||||
let inLineComment = false;
|
||||
let inBlockComment = false;
|
||||
let quote: string | null = null;
|
||||
|
||||
while (index < sql.length) {
|
||||
const ch = sql[index] ?? "";
|
||||
const next = sql[index + 1] ?? "";
|
||||
|
||||
if (inLineComment) {
|
||||
if (ch === "\n") inLineComment = false;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (inBlockComment) {
|
||||
if (ch === "*" && next === "/") {
|
||||
inBlockComment = false;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (quote) {
|
||||
if ((quote === "]" && ch === "]") || (quote !== "]" && ch === quote)) {
|
||||
if (next === (quote === "]" ? "]" : quote)) {
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
quote = null;
|
||||
}
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (ch === "-" && next === "-") {
|
||||
inLineComment = true;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
if (ch === "#") {
|
||||
inLineComment = true;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "/" && next === "*") {
|
||||
inBlockComment = true;
|
||||
index += 2;
|
||||
continue;
|
||||
}
|
||||
if (ch === "'" || ch === '"' || ch === "`") {
|
||||
quote = ch;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "[") {
|
||||
quote = "]";
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === "(") {
|
||||
depth += 1;
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === ")") {
|
||||
depth = Math.max(0, depth - 1);
|
||||
index += 1;
|
||||
continue;
|
||||
}
|
||||
if (ch === ";" && depth === 0) {
|
||||
return index;
|
||||
}
|
||||
index += 1;
|
||||
}
|
||||
return sql.length;
|
||||
}
|
||||
|
||||
function mergeTextRanges(ranges: readonly TextRange[]): TextRange[] {
|
||||
if (ranges.length === 0) return [];
|
||||
const sorted = [...ranges].sort((a, b) => a.from - b.from || a.to - b.to);
|
||||
const merged: TextRange[] = [{ ...sorted[0]! }];
|
||||
for (let index = 1; index < sorted.length; index += 1) {
|
||||
const current = sorted[index]!;
|
||||
const last = merged[merged.length - 1]!;
|
||||
if (current.from <= last.to) {
|
||||
last.to = Math.max(last.to, current.to);
|
||||
} else {
|
||||
merged.push({ ...current });
|
||||
}
|
||||
}
|
||||
return merged;
|
||||
}
|
||||
|
||||
/** Parse INSERT ... VALUES clauses only inside the given document ranges (expanded to statement windows). */
|
||||
export function parseInsertValuesClausesInRanges(sql: string, ranges: readonly TextRange[]): InsertValuesClause[] {
|
||||
if (!sql.trim() || ranges.length === 0) return [];
|
||||
const windows = mergeTextRanges(ranges.map((range) => expandToSqlStatementWindow(sql, range.from, range.to)));
|
||||
const clauses: InsertValuesClause[] = [];
|
||||
for (const window of windows) {
|
||||
if (window.to <= window.from) continue;
|
||||
const slice = sql.slice(window.from, window.to);
|
||||
for (const clause of parseInsertValuesClauses(slice)) {
|
||||
clauses.push(shiftClause(clause, window.from));
|
||||
}
|
||||
}
|
||||
return clauses;
|
||||
}
|
||||
|
||||
/** Parse all INSERT ... VALUES clauses in `sql` (multi-statement aware). Prefer ranged parsing for editors. */
|
||||
export function parseInsertValuesClauses(sql: string): InsertValuesClause[] {
|
||||
if (!sql.trim()) return [];
|
||||
const allTokens = tokenizeSqlSemantic(sql);
|
||||
const spans = statementSpans(sql, allTokens);
|
||||
const clauses: InsertValuesClause[] = [];
|
||||
for (const span of spans) {
|
||||
const tokens = significantTokens(tokensInSpan(allTokens, span));
|
||||
const clause = parseInsertClause(tokens, span);
|
||||
if (clause) clauses.push(clause);
|
||||
}
|
||||
return clauses;
|
||||
}
|
||||
|
||||
/** Build inlay hint positions from parsed clauses and optional table-column resolver. */
|
||||
export function buildInsertValueHints(clauses: readonly InsertValuesClause[], options: ParseInsertValueHintsOptions = {}): InsertValueHint[] {
|
||||
const hints: InsertValueHint[] = [];
|
||||
for (const clause of clauses) {
|
||||
const columns = clause.columns ?? options.resolveTableColumns?.(clause.table, clause.schema, clause.database);
|
||||
if (!columns || columns.length === 0) continue;
|
||||
for (const row of clause.rows) {
|
||||
const count = Math.min(row.length, columns.length);
|
||||
for (let index = 0; index < count; index += 1) {
|
||||
const from = row[index];
|
||||
const column = columns[index];
|
||||
if (from === undefined || !column) continue;
|
||||
hints.push({ from, column });
|
||||
}
|
||||
}
|
||||
}
|
||||
return hints;
|
||||
}
|
||||
|
||||
/** Parse SQL and return insert-value inlay hints. */
|
||||
export function parseInsertValueHints(sql: string, options: ParseInsertValueHintsOptions = {}): InsertValueHint[] {
|
||||
return buildInsertValueHints(parseInsertValuesClauses(sql), options);
|
||||
}
|
||||
|
||||
/** Parse only the statements covering `ranges` and return insert-value inlay hints. */
|
||||
export function parseInsertValueHintsInRanges(sql: string, ranges: readonly TextRange[], options: ParseInsertValueHintsOptions = {}): InsertValueHint[] {
|
||||
return buildInsertValueHints(parseInsertValuesClausesInRanges(sql, ranges), options);
|
||||
}
|
||||
|
||||
/** True when the document still needs table metadata for at least one INSERT without a column list. */
|
||||
export function insertValueHintsNeedTableColumns(sql: string): InsertValuesClause[] {
|
||||
return parseInsertValuesClauses(sql).filter((clause) => clause.columns === null);
|
||||
}
|
||||
|
||||
/** Convenience: hints for the statement containing `cursor` only. */
|
||||
export function parseInsertValueHintsAtCursor(sql: string, cursor: number, options: ParseInsertValueHintsOptions = {}): InsertValueHint[] {
|
||||
const tokens = tokenizeSqlSemantic(sql);
|
||||
const span = findActiveSqlStatementSpan(sql, tokens, cursor);
|
||||
const statementTokens = significantTokens(tokensInSpan(tokens, span));
|
||||
const clause = parseInsertClause(statementTokens, span);
|
||||
if (!clause) return [];
|
||||
return buildInsertValueHints([clause], options);
|
||||
}
|
||||
Reference in new issue
Block a user