Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 17.7k
UI: Rework Monaco editor theme to match Chakra UI palette#64748
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.
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
Uh oh!
There was an error while loading. Please reload this page.
Changes from all commits
674e615eff86d17dba46a2f7abcbb854cdbFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -19,3 +19,4 @@ | ||
| export * from "./ColorModeProvider"; | ||
| export * from "./useColorMode"; | ||
| export * from "./useMonacoTheme"; | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /*! | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import type { Monaco } from "@monaco-editor/react"; | ||
| import { renderHook } from "@testing-library/react"; | ||
| import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; | ||
| // `useColorMode` is the only dependency of the hook we want to test. We mock | ||
| // it with a mutable return so individual tests can drive light/dark behaviour. | ||
| const colorModeMock = vi.fn<() => { colorMode: "dark" | "light" | undefined }>(); | ||
| vi.mock("./useColorMode", () => ({ | ||
| useColorMode: () => colorModeMock(), | ||
| })); | ||
| // The hook registers Monaco themes exactly once via a module-level flag. We | ||
| // reset modules between tests so each test starts with a fresh flag state. | ||
| const loadHook = async () => { | ||
| const module = await import("./useMonacoTheme"); | ||
| return module.useMonacoTheme; | ||
| }; | ||
| const createFakeMonaco = () => { | ||
| const defineTheme = vi.fn(); | ||
| return { defineTheme, monaco: { editor: { defineTheme } } as unknown as Monaco }; | ||
| }; | ||
| // happy-dom does not resolve Chakra's CSS custom properties, so the hook's | ||
| // `getPropertyValue` calls would return empty strings. Stub it to return a | ||
| // parseable value — culori accepts plain hex, so the exact string doesn't | ||
| // matter as long as it's a valid CSS color the parser recognizes. | ||
| const stubComputedStyle = () => { | ||
| vi.spyOn(globalThis, "getComputedStyle").mockReturnValue({ | ||
| getPropertyValue: () => "#abcdef", | ||
| } as unknown as CSSStyleDeclaration); | ||
| }; | ||
| describe("useMonacoTheme", () => { | ||
| beforeEach(() => { | ||
| vi.resetModules(); | ||
| colorModeMock.mockReturnValue({ colorMode: "light" }); | ||
| stubComputedStyle(); | ||
| }); | ||
| afterEach(() => { | ||
| vi.restoreAllMocks(); | ||
| }); | ||
| it("returns the airflow-light theme name when color mode is light", async () => { | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| expect(result.current.theme).toBe("airflow-light"); | ||
| }); | ||
| it("returns the airflow-dark theme name when color mode is dark", async () => { | ||
| colorModeMock.mockReturnValue({ colorMode: "dark" }); | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| expect(result.current.theme).toBe("airflow-dark"); | ||
| }); | ||
| it("falls back to airflow-light when color mode is undefined", async () => { | ||
| colorModeMock.mockReturnValue({ colorMode: undefined }); | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| expect(result.current.theme).toBe("airflow-light"); | ||
| }); | ||
| it("registers both airflow themes when beforeMount runs for the first time", async () => { | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| const { defineTheme, monaco } = createFakeMonaco(); | ||
| result.current.beforeMount(monaco); | ||
| expect(defineTheme).toHaveBeenCalledTimes(2); | ||
| expect(defineTheme).toHaveBeenCalledWith("airflow-light", expect.objectContaining({ base: "vs" })); | ||
| expect(defineTheme).toHaveBeenCalledWith("airflow-dark", expect.objectContaining({ base: "vs-dark" })); | ||
| }); | ||
| it("does not re-register themes on subsequent beforeMount calls", async () => { | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| const first = createFakeMonaco(); | ||
| const second = createFakeMonaco(); | ||
| result.current.beforeMount(first.monaco); | ||
| result.current.beforeMount(second.monaco); | ||
| expect(first.defineTheme).toHaveBeenCalledTimes(2); | ||
| expect(second.defineTheme).not.toHaveBeenCalled(); | ||
| }); | ||
| it("inherits from the base theme and adds no syntax token rules", async () => { | ||
| const useMonacoTheme = await loadHook(); | ||
| const { result } = renderHook(() => useMonacoTheme()); | ||
| const { defineTheme, monaco } = createFakeMonaco(); | ||
| result.current.beforeMount(monaco); | ||
| for (const call of defineTheme.mock.calls) { | ||
| const [, themeData] = call as [string, { inherit: boolean; rules: Array<unknown> }]; | ||
| expect(themeData.inherit).toBe(true); | ||
| expect(themeData.rules).toEqual([]); | ||
| } | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| /*! | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import type { Monaco } from "@monaco-editor/react"; | ||
| import { formatHex, parse } from "culori"; | ||
| import { useColorMode } from "./useColorMode"; | ||
| const LIGHT_THEME_NAME = "airflow-light"; | ||
| const DARK_THEME_NAME = "airflow-dark"; | ||
| let themesRegistered = false; | ||
| // Convert any CSS color (including modern color spaces like OKLCH that Chakra | ||
| // UI uses) to a #rrggbb string that Monaco's `defineTheme` accepts. culori | ||
| // handles parsing and gamut mapping; we fall back to black for unset or | ||
| // unparsable values so Monaco never sees an invalid color. | ||
| const toHex = (cssVar: string): string => { | ||
| const value = getComputedStyle(document.documentElement).getPropertyValue(cssVar).trim(); | ||
| return formatHex(parse(value)) ?? "#000000"; | ||
| }; | ||
| const defineAirflowMonacoThemes = (monaco: Monaco) => { | ||
| if (themesRegistered) { | ||
| return; | ||
| } | ||
| monaco.editor.defineTheme(LIGHT_THEME_NAME, { | ||
| base: "vs", | ||
| colors: { | ||
| "editor.background": toHex("--chakra-colors-gray-50"), | ||
| "editor.foreground": toHex("--chakra-colors-gray-900"), | ||
| "editor.inactiveSelectionBackground": toHex("--chakra-colors-gray-200"), | ||
| "editor.lineHighlightBackground": toHex("--chakra-colors-gray-100"), | ||
| "editor.selectionBackground": toHex("--chakra-colors-brand-200"), | ||
| "editorGutter.background": toHex("--chakra-colors-gray-50"), | ||
| "editorLineNumber.activeForeground": toHex("--chakra-colors-gray-700"), | ||
| "editorLineNumber.foreground": toHex("--chakra-colors-gray-400"), | ||
| "editorSuggestWidget.background": toHex("--chakra-colors-gray-50"), | ||
| "editorWidget.background": toHex("--chakra-colors-gray-50"), | ||
| "editorWidget.border": toHex("--chakra-colors-gray-300"), | ||
| "scrollbarSlider.activeBackground": `${toHex("--chakra-colors-gray-500")}c0`, | ||
| "scrollbarSlider.background": `${toHex("--chakra-colors-gray-300")}80`, | ||
| "scrollbarSlider.hoverBackground": `${toHex("--chakra-colors-gray-400")}a0`, | ||
| }, | ||
| inherit: true, | ||
| rules: [], | ||
| }); | ||
| monaco.editor.defineTheme(DARK_THEME_NAME, { | ||
| base: "vs-dark", | ||
| colors: { | ||
| "editor.background": toHex("--chakra-colors-gray-900"), | ||
| "editor.foreground": toHex("--chakra-colors-gray-100"), | ||
| "editor.inactiveSelectionBackground": toHex("--chakra-colors-gray-800"), | ||
| "editor.lineHighlightBackground": toHex("--chakra-colors-gray-800"), | ||
| "editor.selectionBackground": toHex("--chakra-colors-brand-800"), | ||
| "editorGutter.background": toHex("--chakra-colors-gray-900"), | ||
| "editorLineNumber.activeForeground": toHex("--chakra-colors-gray-300"), | ||
| "editorLineNumber.foreground": toHex("--chakra-colors-gray-600"), | ||
| "editorSuggestWidget.background": toHex("--chakra-colors-gray-900"), | ||
| "editorWidget.background": toHex("--chakra-colors-gray-900"), | ||
| "editorWidget.border": toHex("--chakra-colors-gray-700"), | ||
| "scrollbarSlider.activeBackground": `${toHex("--chakra-colors-gray-500")}c0`, | ||
| "scrollbarSlider.background": `${toHex("--chakra-colors-gray-700")}80`, | ||
| "scrollbarSlider.hoverBackground": `${toHex("--chakra-colors-gray-600")}a0`, | ||
| }, | ||
| inherit: true, | ||
| rules: [], | ||
| }); | ||
| themesRegistered = true; | ||
| }; | ||
| export const useMonacoTheme = () => { | ||
| const { colorMode } = useColorMode(); | ||
| return { | ||
| beforeMount: defineAirflowMonacoThemes, | ||
| theme: colorMode === "dark" ? DARK_THEME_NAME : LIGHT_THEME_NAME, | ||
| }; | ||
| }; | ||
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.