Refactor configuration imports to use the new directory structure and add a readme for configuration clarification

Signed-off-by: worksofliam <[email protected]>

Author: worksofliam

src/Instance.ts

@@ -1,13 +1,14 @@
 import * as vscode from "vscode";
 import { ConnectionData, IBMiEvent } from "./typings";
 import IBMi, { ConnectionResult } from "./api/IBMi";
-import { CodeForIStorage, ConnectionStorage } from "./api/configuration/Storage";
+import { CodeForIStorage } from "./api/configuration/storage/CodeForIStorage";
 import { withContext } from "./ui/tools";
 import { handleConnectionResults, messageCallback } from "./ui/connection";
 import { VsStorage } from "./config/Storage";
 import { VsCodeConfig } from "./config/Configuration";
-import { ConnectionConfig } from "./api/configuration/ConnectionManager";
+import { ConnectionConfig } from "./api/configuration/config/ConnectionManager";
 import { EventEmitter } from "stream";
+import { ConnectionStorage } from "./api/configuration/storage/ConnectionStorage";
 
 type IBMiEventSubscription = {
   func: Function,
@@ -35,7 +36,6 @@ export default class Instance {
   constructor(context: vscode.ExtensionContext) {
     const vscodeStorage = new VsStorage(context);
     this.storage = new ConnectionStorage(vscodeStorage);
-    
     IBMi.GlobalStorage = new CodeForIStorage(vscodeStorage);
     IBMi.connectionManager.configMethod = new VsCodeConfig();
 

src/api/IBMi.ts

@@ -9,11 +9,11 @@ import { CustomQSh } from './components/cqsh';
 import { ComponentManager } from "./components/manager";
 import { CompileTools } from "./CompileTools";
 import IBMiContent from "./IBMiContent";
-import { CachedServerSettings, CodeForIStorage } from './configuration/Storage';
+import { CachedServerSettings, CodeForIStorage } from './configuration/storage/CodeForIStorage';
 import { Tools } from './Tools';
 import * as configVars from './configVars';
 import { DebugConfiguration } from "./configuration/DebugConfiguration";
-import { ConnectionManager, ConnectionConfig } from './configuration/ConnectionManager';
+import { ConnectionManager, ConnectionConfig } from './configuration/config/ConnectionManager';
 import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, WrapResult } from './types';
 import { EventEmitter } from 'stream';
 

src/api/configuration/Storage.ts

@@ -1,8 +1,8 @@
 
 import os from "os";
-import { FilterType } from "../Filter";
-import { Config, VirtualConfig } from "./Config";
-import { DeploymentMethod, ConnectionData } from "../types";
+import { FilterType } from "../../Filter";
+import { Config, VirtualConfig } from "./VirtualConfig";
+import { DeploymentMethod, ConnectionData } from "../../types";
 
 export type SourceDateMode = "edit" | "diff";
 export type DefaultOpenMode = "browse" | "edit";

src/api/configuration/ConnectionManager.ts renamed to src/api/configuration/config/ConnectionManager.ts

@@ -0,0 +1,5 @@
+
+#### What's the difference between `config` and `storage`?
+
+* **config** is the idea of user configurable configuration files. This is things like connection settings, actions, and the likes.
+* **storage** if for storing data that is not editable by the user. Details like history, authorisation lists, etc.

src/api/configuration/Config.ts renamed to src/api/configuration/config/VirtualConfig.ts

@@ -0,0 +1,31 @@
+export abstract class BaseStorage {
+  protected readonly globalState: any;
+
+  constructor() {
+    this.globalState = new Map<string, any>();
+  }
+
+  keys(): readonly string[] {
+    return Array.from(this.globalState.keys());
+  }
+
+  get<T>(key: string): T | undefined {
+    return this.globalState.get(this.getStorageKey(key)) as T | undefined;
+  }
+
+  async set(key: string, value: any) {
+    await this.globalState.set(this.getStorageKey(key), value);
+  }
+
+  getStorageKey(key: string): string {
+    return key;
+  }
+}
+
+export class VirtualStorage extends BaseStorage {
+  protected readonly globalState: Map<string, any> = new Map<string, any>();
+
+  constructor() {
+    super();
+  }
+}