Restructuring extension local types

Author: stricklandrbls

src/dataEditor/dataEditorClient.ts

@@ -64,15 +64,8 @@ import path from 'path'
 import * as vscode from 'vscode'
 import XDGAppPaths from 'xdg-app-paths'
 import { extractDaffodilEvent } from '../daffodilDebugger/daffodil'
-import {
-  EditByteModes,
-  VIEWPORT_CAPACITY_MAX,
-} from '../svelte/src/stores/configuration'
-import {
-  EditorMessage,
-  MessageCommand,
-  MessageLevel,
-} from '../svelte/src/utilities/message'
+import { VIEWPORT_CAPACITY_MAX } from '../svelte/src/stores/configuration'
+import { MessageCommand, EditByteModes } from 'ext_types'
 import * as editor_config from './config'
 import { configureOmegaEditPort, ServerInfo } from './include/server/ServerInfo'
 import { SvelteWebviewInitializer } from './svelteWebviewInitializer'

src/svelte/src/utilities/message.ts src/ext_types/formattypes.tssrc/svelte/src/utilities/message.ts renamed to src/ext_types/formattypes.ts

@@ -15,37 +15,27 @@
  * limitations under the License.
  */
 
-export enum MessageCommand {
-  clearChanges,
-  applyChanges,
-  editorOnChange,
-  fileInfo,
-  heartbeat,
-  profile,
-  redoChange,
-  replaceResults,
-  requestEditedData,
-  save,
-  saveAs,
-  saveSegment,
-  scrollViewport,
-  search,
-  replace,
-  searchResults,
-  setUITheme,
-  showMessage,
-  undoChange,
-  updateLogicalDisplay,
-  viewportRefresh,
-}
+export type Radixes = 'Hexadecimal' | 'Decimal' | 'Octal' | 'Binary'
+
+export type RadixValues = 16 | 10 | 8 | 2
 
-export enum MessageLevel {
-  Error,
-  Info,
-  Warn,
+export type BytesPerRow = 16 | 8 | 24
+
+export enum EditByteModes {
+  Single = 'single',
+  Multiple = 'multiple',
 }
+export type AvailableStrEncodings =
+  | 'hex'
+  | 'binary'
+  | 'ascii'
+  | 'latin1'
+  | 'utf-8'
+  | 'utf-16'
 
-export type EditorMessage = {
-  command: MessageCommand
-  data: Record<string, any>
+export enum EditActionRestrictions {
+  None,
+  OverwriteOnly,
 }
+
+export type EditAction = { name: string; value: EditActionRestrictions }

src/ext_types/index.ts

@@ -0,0 +1,2 @@
+export * from './formattypes'
+export * from './messages'

src/ext_types/messages.ts

@@ -0,0 +1,23 @@
+export enum MessageCommand {
+  clearChanges,
+  applyChanges,
+  editorOnChange,
+  fileInfo,
+  heartbeat,
+  profile,
+  redoChange,
+  replaceResults,
+  requestEditedData,
+  save,
+  saveAs,
+  saveSegment,
+  scrollViewport,
+  search,
+  replace,
+  searchResults,
+  setUITheme,
+  showMessage,
+  undoChange,
+  updateLogicalDisplay,
+  viewportRefresh,
+}

src/svelte/src/App.svelte

@@ -44,7 +44,7 @@ limitations under the License.
     UIThemeCSSClass,
     darkUITheme,
   } from './utilities/colorScheme'
-  import { MessageCommand } from './utilities/message'
+  import { MessageCommand } from 'ext_types'
   import { vscode } from './utilities/vscode'
   import Header from './components/Header/Header.svelte'
   import Main from './Main.svelte'

src/svelte/src/stores/configuration.ts

@@ -15,17 +15,16 @@
  * limitations under the License.
  */
 
-export type Radixes = 'Hexadecimal' | 'Decimal' | 'Octal' | 'Binary'
-
-export type RadixValues = 16 | 10 | 8 | 2
-
-export type BytesPerRow = 16 | 8 | 24
-
-export enum EditByteModes {
-  Single = 'single',
-  Multiple = 'multiple',
-}
+import type {
+  Radixes,
+  RadixValues,
+  EditAction,
+  AvailableStrEncodings,
+  BytesPerRow,
+} from 'ext_types'
+import { EditActionRestrictions } from 'ext_types'
 
+export type StrEncodingByteWidths = { [k in AvailableStrEncodings]: number }
 export const RADIX_OPTIONS: Record<Radixes, RadixValues> = {
   Hexadecimal: 16,
   Decimal: 10,
@@ -57,15 +56,6 @@ export const ENCODING_GROUPS = [
   },
 ]
 
-export type AvailableStrEncodings =
-  | 'hex'
-  | 'binary'
-  | 'ascii'
-  | 'latin1'
-  | 'utf-8'
-  | 'utf-16'
-
-export type StrEncodingByteWidths = { [k in AvailableStrEncodings]: number }
 export const StrEncodingByteWidths: StrEncodingByteWidths = {
   hex: 1,
   binary: 1,
@@ -75,12 +65,6 @@ export const StrEncodingByteWidths: StrEncodingByteWidths = {
   'utf-16': 2 | 4,
 }
 
-export enum EditActionRestrictions {
-  None,
-  OverwriteOnly,
-}
-
-export type EditAction = { name: string; value: EditActionRestrictions }
 export const EDIT_ACTIONS: EditAction[] = [
   { name: 'Delete, Insert, and Overwrite', value: EditActionRestrictions.None },
   { name: 'Overwrite Only', value: EditActionRestrictions.OverwriteOnly },

src/svelte/tsconfig.json

@@ -16,7 +16,7 @@
  */
 
 {
-  "extends": "@tsconfig/svelte/tsconfig.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "allowImportingTsExtensions": true,
     "noEmit": true,
@@ -26,19 +26,17 @@
       "utilities": ["utilities"],
       "layout/*": ["components/layouts/*"],
       "HTMLWrappers/*": ["components/html/*"],
-      "editor_components/*": ["components/sections/*"]
+      "editor_components/*": ["components/sections/*"],
+      "ext_types": ["../../ext_types"]
     },
-    // "allowImportingTsExtensions": true,
-    "target": "ES6",
     "useDefineForClassFields": true,
-    "module": "commonjs",
     "resolveJsonModule": true,
     "allowJs": true,
     "checkJs": true,
     "isolatedModules": true,
     "outDir": "tsout",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true
+    // "verbatimModuleSyntax": true
   },
   "include": ["src/**/*.ts", "src/**/*.svelte", "src/tests/**/*.test.ts"],
   "exclude": ["node_modules/*"],

src/svelte/vite-env.d.ts

@@ -17,3 +17,4 @@
 
 /// <reference types="svelte" />
 /// <reference types="vite/client" />
+/// <reference types="../dfdl-types" />

src/svelte/vite.config.mjs

@@ -46,6 +46,7 @@ export default defineConfig(({ mode }) => {
         layout: path.resolve(__dirname, 'src/components/layouts'),
         HTMLWrappers: path.resolve(__dirname, 'src/components/html'),
         editor_components: path.resolve(__dirname, 'src/components/sections'),
+        ext_types: path.resolve('../../ext_types'),
       },
     },
     plugins: [

tsconfig.json

@@ -49,7 +49,8 @@
 			"dataEditor": ["dataEditor"],
 			"language":["language"],
 			"launchWizard": ["launchWizard/launchWizard"],
-			"infoset":["infoset"]
+			"infoset":["infoset"],
+			"ext_types": ["ext_types"]
 		}
 	},
 	"include": ["src/**/*"],