1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

Rename a preference item type to better communicate intent in UI

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
This commit is contained in:
Janne Savolainen 2022-10-19 14:08:16 +03:00
parent 95767e9d95
commit 81c748b7e8
No known key found for this signature in database
GPG Key ID: 8C6CFB2FFFE8F68A
33 changed files with 78 additions and 78 deletions

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { HelmCharts } from "./helm-charts";
import { preferenceItemInjectionToken } from "../../../../preferences/renderer/preference-items/preference-item-injection-token";
const helmChartsPreferenceItemInjectable = getInjectable({
id: "helm-charts-preference-item",
const helmChartsPreferenceBlockInjectable = getInjectable({
id: "helm-charts-preference-block",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "helm-charts",
parentId: "kubernetes-page",
orderNumber: 30,
@ -20,4 +20,4 @@ const helmChartsPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default helmChartsPreferenceItemInjectable;
export default helmChartsPreferenceBlockInjectable;

View File

@ -277,7 +277,7 @@ const testPreferenceItemInjectable = getInjectable({
id: "test-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "test-item",
parentId: "some-test-tab-id" as const,
Component: () => <div>irrelevant</div>,

View File

@ -116,7 +116,7 @@ describe("preferences - hiding-of-empty-branches, given in preferences page", ()
id: "some-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "some-preference-item-id",
parentId: "some-tab-id" as const,
testId: "some-preference-item",
@ -169,7 +169,7 @@ describe("preferences - hiding-of-empty-branches, given in preferences page", ()
id: "some-other-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "some-other-preference-item-id",
parentId: "some-other-tab-id" as const,
testId: "some-other-preference-item",

View File

@ -10,7 +10,7 @@ export interface ExtensionSettingsProps {
registration: AppPreferenceRegistration;
}
export function ExtensionPreferenceItem({ registration }: ExtensionSettingsProps) {
export function ExtensionPreferenceBlock({ registration }: ExtensionSettingsProps) {
const {
title,
id,

View File

@ -8,7 +8,7 @@ import type { LensRendererExtension } from "../../../../extensions/lens-renderer
import { preferenceItemInjectionToken } from "../preference-items/preference-item-injection-token";
import { extensionRegistratorInjectionToken } from "../../../../extensions/extension-loader/extension-registrator-injection-token";
import { PreferencePageComponent } from "../preference-page-component";
import { ExtensionPreferenceItem } from "./extension-preference-item";
import { ExtensionPreferenceBlock } from "./extension-preference-block";
import { computed } from "mobx";
import { HorizontalLine } from "../horizontal-line/horizontal-line";
@ -117,7 +117,7 @@ const registratorForPreferenceItemsInjectable = getInjectable({
id: itemId,
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: itemId,
// Note: Legacy extensions considered telemetry as magic string, and so does this code
@ -130,7 +130,7 @@ const registratorForPreferenceItemsInjectable = getInjectable({
orderNumber: i * 10,
Component: () => (
<ExtensionPreferenceItem registration={registration} />
<ExtensionPreferenceBlock registration={registration} />
),
childSeparator: HorizontalLine,

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { ExtensionInstallRegistry } from "./extension-install-registry";
const extensionInstallRegistryPreferenceItemInjectable = getInjectable({
const extensionInstallRegistryPreferenceBlockInjectable = getInjectable({
id: "extension-install-registry-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "extension-install-registry",
parentId: "application-page",
orderNumber: 20,
@ -20,4 +20,4 @@ const extensionInstallRegistryPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default extensionInstallRegistryPreferenceItemInjectable;
export default extensionInstallRegistryPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { StartUp } from "./start-up";
const startUpPreferenceItemInjectable = getInjectable({
const startUpPreferenceBlockInjectable = getInjectable({
id: "start-up-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "start-up",
parentId: "application-page",
orderNumber: 30,
@ -20,4 +20,4 @@ const startUpPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default startUpPreferenceItemInjectable;
export default startUpPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { Theme } from "./theme";
const themePreferenceItemInjectable = getInjectable({
const themePreferenceBlockInjectable = getInjectable({
id: "theme-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "theme",
parentId: "application-page",
orderNumber: 10,
@ -20,4 +20,4 @@ const themePreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default themePreferenceItemInjectable;
export default themePreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { Timezone } from "./timezone";
const timezonePreferenceItemInjectable = getInjectable({
const timezonePreferenceBlockInjectable = getInjectable({
id: "timezone-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "timezone",
parentId: "application-page",
orderNumber: 60,
@ -20,4 +20,4 @@ const timezonePreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default timezonePreferenceItemInjectable;
export default timezonePreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { UpdateChannel } from "./update-channel";
const updateChannelPreferenceItemInjectable = getInjectable({
const updateChannelPreferenceBlockInjectable = getInjectable({
id: "update-channel-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "update-channel",
parentId: "application-page",
orderNumber: 50,
@ -20,4 +20,4 @@ const updateChannelPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default updateChannelPreferenceItemInjectable;
export default updateChannelPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { EditorFontFamily } from "./editor-font-family";
const editorFontFamilyPreferenceItemInjectable = getInjectable({
const editorFontFamilyPreferenceBlockInjectable = getInjectable({
id: "editor-font-family-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "editor-font-family",
parentId: "editor-page",
orderNumber: 50,
@ -20,4 +20,4 @@ const editorFontFamilyPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default editorFontFamilyPreferenceItemInjectable;
export default editorFontFamilyPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { EditorFontSize } from "./editor-font-size";
const editorFontSizePreferenceItemInjectable = getInjectable({
const editorFontSizePreferenceBlockInjectable = getInjectable({
id: "editor-font-size-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "editor-font-size",
parentId: "editor-page",
orderNumber: 40,
@ -20,4 +20,4 @@ const editorFontSizePreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default editorFontSizePreferenceItemInjectable;
export default editorFontSizePreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { LineNumbers } from "./line-numbers";
const lineNumbersPreferenceItemInjectable = getInjectable({
const lineNumbersPreferenceBlockInjectable = getInjectable({
id: "line-numbers-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "line-numbers",
parentId: "editor-page",
orderNumber: 20,
@ -20,4 +20,4 @@ const lineNumbersPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default lineNumbersPreferenceItemInjectable;
export default lineNumbersPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { Minimap } from "./minimap";
const minimapPreferenceItemInjectable = getInjectable({
const minimapPreferenceBlockInjectable = getInjectable({
id: "minimap-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "minimap",
parentId: "editor-page",
orderNumber: 10,
@ -20,4 +20,4 @@ const minimapPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default minimapPreferenceItemInjectable;
export default minimapPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { TabSize } from "./tab-size";
const tabSizePreferenceItemInjectable = getInjectable({
const tabSizePreferenceBlockInjectable = getInjectable({
id: "tab-size-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "tab-size",
parentId: "editor-page",
orderNumber: 30,
@ -20,4 +20,4 @@ const tabSizePreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default tabSizePreferenceItemInjectable;
export default tabSizePreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { KubeconfigSync } from "./kubeconfig-sync";
const kubeconfigSyncPreferenceItemInjectable = getInjectable({
const kubeconfigSyncPreferenceBlockInjectable = getInjectable({
id: "kubeconfig-sync-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubeconfig-sync",
parentId: "kubernetes-page",
orderNumber: 20,
@ -20,4 +20,4 @@ const kubeconfigSyncPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default kubeconfigSyncPreferenceItemInjectable;
export default kubeconfigSyncPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../../preference-item-injection-token";
import { KubectlBinaryDownload } from "./kubectl-binary-download";
const kubectlBinaryDownloadPreferenceItemInjectable = getInjectable({
const kubectlBinaryDownloadPreferenceBlockInjectable = getInjectable({
id: "kubectl-binary-download-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubectl-binary-download",
parentId: "kubectl",
orderNumber: 10,
@ -20,4 +20,4 @@ const kubectlBinaryDownloadPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default kubectlBinaryDownloadPreferenceItemInjectable;
export default kubectlBinaryDownloadPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../../preference-item-injection-token";
import { KubectlDirectoryForBinaries } from "./kubectl-directory-for-binaries";
const kubectlDirectoryForBinariesPreferenceItemInjectable = getInjectable({
const kubectlDirectoryForBinariesPreferenceBlockInjectable = getInjectable({
id: "kubectl-directory-for-binaries-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubectl-directory-for-binaries",
parentId: "kubectl",
orderNumber: 30,
@ -20,4 +20,4 @@ const kubectlDirectoryForBinariesPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default kubectlDirectoryForBinariesPreferenceItemInjectable;
export default kubectlDirectoryForBinariesPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../../preference-item-injection-token";
import { KubectlDownloadMirror } from "./kubectl-download-mirror";
const kubectlDownloadMirrorPreferenceItemInjectable = getInjectable({
const kubectlDownloadMirrorPreferenceBlockInjectable = getInjectable({
id: "kubectl-download-mirror-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubectl-download-mirror",
parentId: "kubectl",
orderNumber: 20,
@ -20,4 +20,4 @@ const kubectlDownloadMirrorPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default kubectlDownloadMirrorPreferenceItemInjectable;
export default kubectlDownloadMirrorPreferenceBlockInjectable;

View File

@ -20,7 +20,7 @@ const kubectlGroupPreferenceItemInjectable = getInjectable({
id: "kubectl-group-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubectl",
parentId: "kubernetes-page",
orderNumber: 10,

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../../preference-item-injection-token";
import { KubectlPathToBinary } from "./kubectl-path-to-binary";
const kubectlPathToBinaryPreferenceItemInjectable = getInjectable({
const kubectlPathToBinaryPreferenceBlockInjectable = getInjectable({
id: "kubectl-path-to-binary-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "kubectl-path-to-binary",
parentId: "kubectl",
orderNumber: 40,
@ -20,4 +20,4 @@ const kubectlPathToBinaryPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default kubectlPathToBinaryPreferenceItemInjectable;
export default kubectlPathToBinaryPreferenceBlockInjectable;

View File

@ -40,17 +40,17 @@ export interface PreferencePage {
Component: PreferenceItemComponent<PreferencePage>;
}
export interface PreferenceItem {
kind: "item";
export interface PreferenceBlock {
kind: "block";
id: string;
parentId: string;
orderNumber: number;
isShown?: IComputedValue<boolean> | boolean;
childSeparator?: () => React.ReactElement;
Component: PreferenceItemComponent<PreferenceItem>;
Component: PreferenceItemComponent<PreferenceBlock>;
}
export type PreferenceTypes = PreferenceTabGroup | PreferenceTab | PreferenceItem | PreferencePage;
export type PreferenceTypes = PreferenceTabGroup | PreferenceTab | PreferenceBlock | PreferencePage;
export const preferenceItemInjectionToken = getInjectionToken<PreferenceTypes>({
id: "preference-item-injection-token",

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { AllowUntrustedCertificates } from "./allow-untrusted-certificates";
const allowUntrustedCertificatesPreferenceItemInjectable = getInjectable({
const allowUntrustedCertificatesPreferenceBlockInjectable = getInjectable({
id: "allow-untrusted-certificates-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "allow-untrusted-certificates",
parentId: "proxy-page",
orderNumber: 20,
@ -20,4 +20,4 @@ const allowUntrustedCertificatesPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default allowUntrustedCertificatesPreferenceItemInjectable;
export default allowUntrustedCertificatesPreferenceBlockInjectable;

View File

@ -6,11 +6,11 @@ import { getInjectable } from "@ogre-tools/injectable";
import { preferenceItemInjectionToken } from "../../preference-item-injection-token";
import { HttpProxyUrl } from "./http-proxy-url";
const httpProxyUrlPreferenceItemInjectable = getInjectable({
const httpProxyUrlPreferenceBlockInjectable = getInjectable({
id: "http-proxy-url-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "http-proxy-url",
parentId: "proxy-page",
orderNumber: 10,
@ -20,4 +20,4 @@ const httpProxyUrlPreferenceItemInjectable = getInjectable({
injectionToken: preferenceItemInjectionToken,
});
export default httpProxyUrlPreferenceItemInjectable;
export default httpProxyUrlPreferenceBlockInjectable;

View File

@ -14,7 +14,7 @@ const automaticErrorReportingPreferenceItemInjectable = getInjectable({
const sentryDnsUrl = di.inject(sentryDataSourceNameInjectable);
return {
kind: "item" as const,
kind: "block" as const,
id: "automatic-error-reporting",
parentId: "telemetry-page",
orderNumber: 20,

View File

@ -10,7 +10,7 @@ const copyPasteFromTerminalPreferenceItemInjectable = getInjectable({
id: "copy-paste-from-terminal-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "copy-paste-from-terminal-preference-item",
parentId: "terminal-page",
orderNumber: 20,

View File

@ -10,7 +10,7 @@ const terminalFontFamilyPreferenceItemInjectable = getInjectable({
id: "terminal-font-family-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "terminal-font-family-preference-item",
parentId: "terminal-page",
orderNumber: 50,

View File

@ -10,7 +10,7 @@ const terminalFontSizePreferenceItemInjectable = getInjectable({
id: "terminal-font-size-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "terminal-font-size-preference-item",
parentId: "terminal-page",
orderNumber: 40,

View File

@ -10,7 +10,7 @@ const terminalShellPathPreferenceItemInjectable = getInjectable({
id: "terminal-shell-path-preference-item",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "terminal-shell-path",
parentId: "terminal-page",
orderNumber: 10,

View File

@ -10,7 +10,7 @@ const terminalThemePreferenceItemInjectable = getInjectable({
id: "terminal-theme",
instantiate: () => ({
kind: "item" as const,
kind: "block" as const,
id: "terminal-theme",
parentId: "terminal-page",
orderNumber: 30,

View File

@ -52,7 +52,7 @@ const toNavigationHierarchy = (composite: Composite<PreferenceTypes | Preference
return emptyRender;
}
case "item": {
case "block": {
return emptyRender;
}
@ -103,7 +103,7 @@ const toNavigationHierarchy = (composite: Composite<PreferenceTypes | Preference
};
const hasContent = compositeHasDescendant<PreferenceTypes | PreferenceTabsRoot>(
(composite) => composite.value.kind === "item",
(composite) => composite.value.kind === "block",
);
const emptyRender = <></>;

View File

@ -53,7 +53,7 @@ const toPreferenceItemHierarchy = (composite: Composite<PreferenceTypes>) => {
const value = composite.value;
switch (value.kind) {
case "item": {
case "block": {
const Component = value.Component;
return (

View File

@ -9,7 +9,7 @@ import { observer } from "mobx-react";
import React from "react";
import type { RegisteredAppPreference } from "./app-preferences/app-preference-registration";
import extensionPreferencesModelInjectable from "./extension-preference-model.injectable";
import { ExtensionPreferenceItem } from "../../../features/preferences/renderer/compliance-for-legacy-extension-api/extension-preference-item";
import { ExtensionPreferenceBlock } from "../../../features/preferences/renderer/compliance-for-legacy-extension-api/extension-preference-block";
interface Dependencies {
model: IComputedValue<{
@ -36,7 +36,7 @@ const NonInjectedExtensions = ({ model }: Dependencies) => {
</div>
)}
{preferenceItems.map((preferenceItem, index) => (
<ExtensionPreferenceItem
<ExtensionPreferenceBlock
key={`${preferenceItem.id}-${index}`}
registration={preferenceItem}
data-testid={`extension-preference-item-for-${preferenceItem.id}`}