|
| 1 | +import { useEffect, useRef } from "react"; |
| 2 | +import type { IDisposable } from "monaco-editor"; |
| 3 | +import type * as Monaco from "monaco-editor"; |
| 4 | +import { format as formatSql } from "sql-formatter"; |
| 5 | +import type { FormatOptionsWithLanguage } from "sql-formatter"; |
| 6 | + |
| 7 | +type UseSqlFormattingProvidersOptions = { |
| 8 | + languageId: string; |
| 9 | + getOptions?: () => FormatOptionsWithLanguage; |
| 10 | +}; |
| 11 | + |
| 12 | +const getDefaultSqlFormatOptions = (): FormatOptionsWithLanguage => ({ |
| 13 | + language: "sqlite", |
| 14 | + keywordCase: "upper", |
| 15 | +}); |
| 16 | + |
| 17 | +export function useSqlFormattingProviders( |
| 18 | + monaco: typeof Monaco | null, |
| 19 | + { languageId, getOptions }: UseSqlFormattingProvidersOptions, |
| 20 | +) { |
| 21 | + const disposablesRef = useRef<IDisposable[]>([]); |
| 22 | + |
| 23 | + useEffect(() => { |
| 24 | + if (!monaco) return; |
| 25 | + |
| 26 | + // Dispose any previous providers |
| 27 | + disposablesRef.current.forEach((d) => d.dispose()); |
| 28 | + disposablesRef.current = []; |
| 29 | + |
| 30 | + const getOpts = getOptions ?? getDefaultSqlFormatOptions; |
| 31 | + |
| 32 | + const documentProvider = |
| 33 | + monaco.languages.registerDocumentFormattingEditProvider(languageId, { |
| 34 | + provideDocumentFormattingEdits: (model) => { |
| 35 | + const fullRange = model.getFullModelRange(); |
| 36 | + const text = model.getValue(); |
| 37 | + try { |
| 38 | + const formatted = formatSql(text, getOpts()); |
| 39 | + return [ |
| 40 | + { |
| 41 | + range: fullRange, |
| 42 | + text: formatted, |
| 43 | + }, |
| 44 | + ]; |
| 45 | + } catch (err) { |
| 46 | + // Keep UX stable if formatting fails |
| 47 | + // eslint-disable-next-line no-console |
| 48 | + console.error("SQL formatting error (document)", err); |
| 49 | + return []; |
| 50 | + } |
| 51 | + }, |
| 52 | + }); |
| 53 | + |
| 54 | + const rangeProvider = |
| 55 | + monaco.languages.registerDocumentRangeFormattingEditProvider(languageId, { |
| 56 | + provideDocumentRangeFormattingEdits: (model, range) => { |
| 57 | + const text = model.getValueInRange(range); |
| 58 | + try { |
| 59 | + const formatted = formatSql(text, getOpts()); |
| 60 | + return [ |
| 61 | + { |
| 62 | + range, |
| 63 | + text: formatted, |
| 64 | + }, |
| 65 | + ]; |
| 66 | + } catch (err) { |
| 67 | + // eslint-disable-next-line no-console |
| 68 | + console.error("SQL formatting error (range)", err); |
| 69 | + return []; |
| 70 | + } |
| 71 | + }, |
| 72 | + }); |
| 73 | + |
| 74 | + disposablesRef.current = [documentProvider, rangeProvider]; |
| 75 | + |
| 76 | + return () => { |
| 77 | + disposablesRef.current.forEach((d) => d.dispose()); |
| 78 | + disposablesRef.current = []; |
| 79 | + }; |
| 80 | + }, [monaco, languageId, getOptions]); |
| 81 | +} |
0 commit comments