fix: minor refactor of message / command definitions. (#549)

* fix: minor refactor of message / command definitions. * Update snapshots
streetsidesoftware · Sep 20, 2020 · 99c8570 · 99c8570
1 parent ebcb513
commit 99c8570
Show file tree

Hide file tree

Showing 6 changed files with 232 additions and 28 deletions.
diff --git a/packages/_settingsViewer/src/api/MessageBus.ts b/packages/_settingsViewer/src/api/MessageBus.ts
@@ -3,13 +3,13 @@ import { Message, Commands, isMessage, Messages } from './message';
 
 export interface Listener {
     cmd: Commands;
-    fn: (message: Message) => any;
+    fn: (message: Message) => void;
     dispose(): void;
 }
 
 export interface Messenger {
-    listenFor<M extends Messages>(cmd: M['command'], fn: (message: M) => any): Listener;
-    postMessage<M extends Messages>(msg: M): any;
+    listenFor<M extends Messages>(cmd: M['command'], fn: (message: M) => void): Listener;
+    postMessage<M extends Messages>(msg: M): void;
 }
 
 export class MessageBus implements Messenger {

diff --git a/packages/_settingsViewer/src/api/message.ts b/packages/_settingsViewer/src/api/message.ts
@@ -1,26 +1,22 @@
 import { Settings, ConfigTarget } from './settings';
-export type Commands = 'ConfigurationChangeMessage'
-| 'EnableLanguageIdMessage'
-| 'EnableLocaleMessage'
-| 'RequestConfigurationMessage'
-| 'SelectFileMessage'
-| 'SelectFolderMessage'
-| 'SelectTabMessage'
-;
+
+interface DefinedCommands {
+    ConfigurationChangeMessage: ConfigurationChangeMessage;
+    EnableLanguageIdMessage: EnableLanguageIdMessage;
+    EnableLocaleMessage: EnableLocaleMessage;
+    RequestConfigurationMessage: RequestConfigurationMessage;
+    SelectFileMessage: SelectFileMessage;
+    SelectFolderMessage: SelectFolderMessage;
+    SelectTabMessage: SelectTabMessage;
+}
+
+export type Commands = keyof DefinedCommands;
 
 export interface Message {
     command: Commands;
 }
 
-export type Messages =
-    ConfigurationChangeMessage
-    | EnableLanguageIdMessage
-    | EnableLocaleMessage
-    | RequestConfigurationMessage
-    | SelectFileMessage
-    | SelectFolderMessage
-    | SelectTabMessage
-    ;
+export type Messages = DefinedCommands[Commands];
 
 export function isMessage(data: unknown): data is Message {
     return !!(data
@@ -95,7 +91,5 @@ export const isSelectFileMessage = isA<SelectFileMessage>('SelectFileMessage', [
 export const isSelectFolderMessage = isA<SelectFolderMessage>('SelectFolderMessage', [['value', isString]]);
 export const isSelectTabMessage = isA<SelectTabMessage>('SelectTabMessage', [['value', isString]]);
 
-interface Record {}
-
-function isObject(v: any): v is Record { return typeof v === 'object' && v !== null; }
-function isString(v: any): v is string { return typeof v === 'string'; }
+function isObject(v: unknown): v is Record<string, unknown> { return typeof v === 'object' && v !== null; }
+function isString(v: unknown): v is string { return typeof v === 'string'; }
diff --git a/packages/_settingsViewer/src/test/samples/sampleSettings.ts b/packages/_settingsViewer/src/test/samples/sampleSettings.ts
@@ -7,14 +7,14 @@ const languageIdsA = [
     'c', 'cpp', 'csharp', 'css',
     'go', 'handlebars', 'html',
     'jade', 'javascript', 'javascriptreact', 'json',
-    'latex', 'less',
+    'latex', 'less', 'literate haskell',
     'markdown',
     'php', 'plaintext', 'pub', 'python',
     'restructuredtext', 'rust',
     'scss',
     'text', 'typescript', 'typescriptreact',
-    'yml'].sort();
-const languageIdsB = languageIdsA.concat(['cfml', 'java', 'scala', 'yaml']).sort();
+    'yml'];
+const languageIdsB = languageIdsA.concat(['cfml', 'java', 'scala', 'yaml']);
 const languageIdsUser = languageIdsB;
 const languageIdsWorkspace = languageIdsA;
 const knownLanguageIds = languageIdsA.concat(languageIdsB).concat(['jsonc', 'perl', 'sh', 'bash', 'avro']).filter(uniqueFilter()).sort();

diff --git a/packages/_settingsViewer/src/viewer/components/__snapshots__/panelConfig.test.tsx.snap b/packages/_settingsViewer/src/viewer/components/__snapshots__/panelConfig.test.tsx.snap
@@ -993,6 +993,40 @@ exports[`Config Panel Verification tests the snapshot 1`] = `
           less
         </span>
       </div>
+      <div
+        className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
+        id="literate haskell"
+        onBlur={[Function]}
+        onClick={[Function]}
+        onDragLeave={[Function]}
+        onFocus={[Function]}
+        onKeyDown={[Function]}
+        onKeyUp={[Function]}
+        onMouseDown={[Function]}
+        onMouseLeave={[Function]}
+        onMouseUp={[Function]}
+        onTouchEnd={[Function]}
+        onTouchMove={[Function]}
+        onTouchStart={[Function]}
+        role="button"
+        tabIndex={0}
+      >
+        <svg
+          aria-hidden={true}
+          className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-15"
+          focusable="false"
+          viewBox="0 0 24 24"
+        >
+          <path
+            d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+          />
+        </svg>
+        <span
+          className="MuiChip-label WithStyles(ForwardRef(Chip))-label-14"
+        >
+          literate haskell
+        </span>
+      </div>
       <div
         className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
         id="markdown"
@@ -2604,6 +2638,43 @@ exports[`Config Panel Verification tests the snapshot 2`] = `
           className="MuiTouchRipple-root"
         />
       </div>
+      <div
+        className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
+        id="literate haskell"
+        onBlur={[Function]}
+        onClick={[Function]}
+        onDragLeave={[Function]}
+        onFocus={[Function]}
+        onKeyDown={[Function]}
+        onKeyUp={[Function]}
+        onMouseDown={[Function]}
+        onMouseLeave={[Function]}
+        onMouseUp={[Function]}
+        onTouchEnd={[Function]}
+        onTouchMove={[Function]}
+        onTouchStart={[Function]}
+        role="button"
+        tabIndex={0}
+      >
+        <svg
+          aria-hidden={true}
+          className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-15"
+          focusable="false"
+          viewBox="0 0 24 24"
+        >
+          <path
+            d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+          />
+        </svg>
+        <span
+          className="MuiChip-label WithStyles(ForwardRef(Chip))-label-14"
+        >
+          literate haskell
+        </span>
+        <span
+          className="MuiTouchRipple-root"
+        />
+      </div>
       <div
         className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
         id="markdown"
@@ -4194,6 +4265,40 @@ exports[`Config Panel Verification tests the snapshot 3`] = `
           less
         </span>
       </div>
+      <div
+        className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
+        id="literate haskell"
+        onBlur={[Function]}
+        onClick={[Function]}
+        onDragLeave={[Function]}
+        onFocus={[Function]}
+        onKeyDown={[Function]}
+        onKeyUp={[Function]}
+        onMouseDown={[Function]}
+        onMouseLeave={[Function]}
+        onMouseUp={[Function]}
+        onTouchEnd={[Function]}
+        onTouchMove={[Function]}
+        onTouchStart={[Function]}
+        role="button"
+        tabIndex={0}
+      >
+        <svg
+          aria-hidden={true}
+          className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-15"
+          focusable="false"
+          viewBox="0 0 24 24"
+        >
+          <path
+            d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+          />
+        </svg>
+        <span
+          className="MuiChip-label WithStyles(ForwardRef(Chip))-label-14"
+        >
+          literate haskell
+        </span>
+      </div>
       <div
         className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-12 MuiChip-clickable"
         id="markdown"

diff --git a/packages/_settingsViewer/src/viewer/components/__snapshots__/sectionFiletypes.test.tsx.snap b/packages/_settingsViewer/src/viewer/components/__snapshots__/sectionFiletypes.test.tsx.snap
@@ -665,6 +665,40 @@ exports[`SectionFileTypes Verification tests the snapshots: <SectionFiletypes> f
         less
       </span>
     </div>
+    <div
+      className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
+      id="literate haskell"
+      onBlur={[Function]}
+      onClick={[Function]}
+      onDragLeave={[Function]}
+      onFocus={[Function]}
+      onKeyDown={[Function]}
+      onKeyUp={[Function]}
+      onMouseDown={[Function]}
+      onMouseLeave={[Function]}
+      onMouseUp={[Function]}
+      onTouchEnd={[Function]}
+      onTouchMove={[Function]}
+      onTouchStart={[Function]}
+      role="button"
+      tabIndex={0}
+    >
+      <svg
+        aria-hidden={true}
+        className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-5"
+        focusable="false"
+        viewBox="0 0 24 24"
+      >
+        <path
+          d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+        />
+      </svg>
+      <span
+        className="MuiChip-label WithStyles(ForwardRef(Chip))-label-4"
+      >
+        literate haskell
+      </span>
+    </div>
     <div
       className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
       id="markdown"
@@ -1868,6 +1902,40 @@ exports[`SectionFileTypes Verification tests the snapshots: <SectionFiletypes> f
         less
       </span>
     </div>
+    <div
+      className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
+      id="literate haskell"
+      onBlur={[Function]}
+      onClick={[Function]}
+      onDragLeave={[Function]}
+      onFocus={[Function]}
+      onKeyDown={[Function]}
+      onKeyUp={[Function]}
+      onMouseDown={[Function]}
+      onMouseLeave={[Function]}
+      onMouseUp={[Function]}
+      onTouchEnd={[Function]}
+      onTouchMove={[Function]}
+      onTouchStart={[Function]}
+      role="button"
+      tabIndex={0}
+    >
+      <svg
+        aria-hidden={true}
+        className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-5"
+        focusable="false"
+        viewBox="0 0 24 24"
+      >
+        <path
+          d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+        />
+      </svg>
+      <span
+        className="MuiChip-label WithStyles(ForwardRef(Chip))-label-4"
+      >
+        literate haskell
+      </span>
+    </div>
     <div
       className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
       id="markdown"
@@ -3128,6 +3196,43 @@ exports[`SectionFileTypes Verification tests the snapshots: <SectionFiletypes> f
         className="MuiTouchRipple-root"
       />
     </div>
+    <div
+      className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
+      id="literate haskell"
+      onBlur={[Function]}
+      onClick={[Function]}
+      onDragLeave={[Function]}
+      onFocus={[Function]}
+      onKeyDown={[Function]}
+      onKeyUp={[Function]}
+      onMouseDown={[Function]}
+      onMouseLeave={[Function]}
+      onMouseUp={[Function]}
+      onTouchEnd={[Function]}
+      onTouchMove={[Function]}
+      onTouchStart={[Function]}
+      role="button"
+      tabIndex={0}
+    >
+      <svg
+        aria-hidden={true}
+        className="MuiSvgIcon-root MuiChip-icon WithStyles(ForwardRef(Chip))-icon-5"
+        focusable="false"
+        viewBox="0 0 24 24"
+      >
+        <path
+          d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"
+        />
+      </svg>
+      <span
+        className="MuiChip-label WithStyles(ForwardRef(Chip))-label-4"
+      >
+        literate haskell
+      </span>
+      <span
+        className="MuiTouchRipple-root"
+      />
+    </div>
     <div
       className="MuiButtonBase-root MuiChip-root WithStyles(ForwardRef(Chip))-root-2 MuiChip-clickable"
       id="markdown"

diff --git a/packages/_settingsViewer/src/viewer/vsCodeTestWrapper.tsx b/packages/_settingsViewer/src/viewer/vsCodeTestWrapper.tsx
@@ -65,7 +65,7 @@ const localeDisplay: [ConfigTarget, string][] = [
 ];
 
 @observer
-class VsCodeTestWrapperView extends React.Component<{appState: AppState}, {}> {
+class VsCodeTestWrapperView extends React.Component<{appState: AppState}> {
     render() {
         const appState = this.props.appState;
         const settings = appState.settings;