fix(editor): format PostgreSQL SQL with backticks

Closes #6741
This commit is contained in:
t8y2 committed 2026-08-20 06:18:51 +00:00
1 parent dc74d2a77f
commit 12a2dd07f7
2 files changed
+40 -1

No files matched your search

+25
View File
@@ -114,6 +114,31 @@ describe("sqlFormatter", () => {
expect(formatted).toContain("AS id"); expect(formatted).toContain("AS id");
}); });
it("formats complete backtick-quoted spans with the PostgreSQL dialect", async () => {
const formatted = await formatSqlText("select `schema`.`odd``name` from user;", "postgres");
expect(formatted).toBe("SELECT\n `schema`.`odd``name`\nFROM\n user;");
});
it("keeps PostgreSQL double-quoted identifiers and casts unchanged", async () => {
const formatted = await formatSqlText('select "display""name" from records where payload::jsonb is not null;', "postgres");
expect(formatted).toBe('SELECT\n "display""name"\nFROM\n records\nWHERE\n payload::jsonb IS NOT NULL;');
});
it("keeps MySQL backtick formatting unchanged", async () => {
const formatted = await formatSqlText("select `schema`.`odd``name` from `user`;", "mysql");
expect(formatted).toBe("SELECT\n `schema`.`odd``name`\nFROM\n `user`;");
});
it("keeps malformed PostgreSQL backtick input unchanged while editing", async () => {
const sql = "select `id from user;";
await expect(formatSqlText(sql, "postgres")).rejects.toThrow("Parse error: Unexpected");
await expect(formatSqlForEditing(sql, "postgres")).resolves.toBe(sql);
});
it("formats Dameng SQL with a standalone trailing dot without changing the invalid token", async () => { it("formats Dameng SQL with a standalone trailing dot without changing the invalid token", async () => {
const sql = `SELECT JS1.REC_CREATOR as "recCreator", JS1.REC_CREATOR_JOB_ID as "recCreatorJobId" FROM APSSC.TMPJS01 JS1 WHERE 1=1 AND JS1.SUBSTR(REC_CREATE_TIME,1,8) = ? ORDER BY DECODE(JS1.STATUS,'DRAFT',1,'PENDING_APPROVAL',2,'APPROVED',3,'POSTED',4,'REJECTED',5,'DELETED',6), JS1.REC_CREATE_TIME DESC .`; const sql = `SELECT JS1.REC_CREATOR as "recCreator", JS1.REC_CREATOR_JOB_ID as "recCreatorJobId" FROM APSSC.TMPJS01 JS1 WHERE 1=1 AND JS1.SUBSTR(REC_CREATE_TIME,1,8) = ? ORDER BY DECODE(JS1.STATUS,'DRAFT',1,'PENDING_APPROVAL',2,'APPROVED',3,'POSTED',4,'REJECTED',5,'DELETED',6), JS1.REC_CREATE_TIME DESC .`;
+15 -1
View File
@@ -105,9 +105,23 @@ export async function formatSqlText(sql: string, dialect: SqlFormatDialect = "ge
const normalizedSettings = normalizeSqlFormatterSettings(settings); const normalizedSettings = normalizeSqlFormatterSettings(settings);
const options = sqlFormatterOptions(normalizedSettings); const options = sqlFormatterOptions(normalizedSettings);
const language = formatterLanguage(dialect); const language = formatterLanguage(dialect);
const formatterOptions =
language === "postgresql"
? {
...options,
paramTypes: {
...options.paramTypes,
// PostgreSQL itself uses double quotes, but users commonly format
// imported MySQL-style SQL before correcting it. Treat complete
// backtick spans as opaque tokens so the PostgreSQL lexer can keep
// formatting the surrounding statement without rewriting them.
custom: [...options.paramTypes.custom, { regex: "`(?:``|[^`])*`" }],
},
}
: options;
const formatWithFallback = (input: string): string => { const formatWithFallback = (input: string): string => {
try { try {
return format(input, { language, ...options }); return format(input, { language, ...formatterOptions });
} catch (err) { } catch (err) {
// The generic "sql" dialect can't parse many real-world constructs (PostgreSQL // The generic "sql" dialect can't parse many real-world constructs (PostgreSQL
// `::` casts, GaussDB/openGauss materialized-view DDL, T-SQL specifics, ...). // `::` casts, GaussDB/openGauss materialized-view DDL, T-SQL specifics, ...).