-
Notifications
You must be signed in to change notification settings - Fork 16.9k
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
Open
shivaam
wants to merge
4
commits into
apache:main
Choose a base branch
from
shivaam:fix/monaco-theme-64253
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
674e615
UI: Rework Monaco editor theme to match Chakra UI palette
shivaam eff86d1
UI: Remove unnecessary useCallback in useMonacoTheme
shivaam 7dba46a
UI: Use culori for Monaco theme color conversion
shivaam 2f7abcb
UI: Fix codespell typo in useMonacoTheme comment
shivaam File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,3 +19,4 @@ | |
|
|
||
| export * from "./ColorModeProvider"; | ||
| export * from "./useColorMode"; | ||
| export * from "./useMonacoTheme"; | ||
128 changes: 128 additions & 0 deletions
128
airflow-core/src/airflow/ui/src/context/colorMode/useMonacoTheme.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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([]); | ||
| } | ||
| }); | ||
| }); |
98 changes: 98 additions & 0 deletions
98
airflow-core/src/airflow/ui/src/context/colorMode/useMonacoTheme.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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, | ||
| }; | ||
| }; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.