src: splits the mapping type used for both the file (raw) and runtime (compiled RegEx) representations of the config file contents into two files. which also fixes the unnecessary use of any.

Author: ufukty

src/config.ts

@@ -0,0 +1,19 @@
+export enum Opacity {
+  Max = "max",
+  Mid = "mid",
+  Min = "min",
+}
+
+export interface Rule {
+  flags: string | undefined;
+  opacity: string | undefined;
+  pattern: string;
+}
+
+export interface File {
+  rules: Rule[];
+  valueForMaxTier: number;
+  valueForMidTier: number;
+  valueForMinTier: number;
+  updatePeriod: number;
+}

src/configmanager.ts

@@ -1,8 +1,9 @@
 import * as vscode from "vscode";
-import { Config, Opacity, Rule } from "./models";
+import * as config from "./config";
+import * as models from "./models";
 
 export class ConfigManager {
-  _configCache: Map<vscode.ConfigurationScope, Config>;
+  _configCache: Map<vscode.ConfigurationScope, models.Config>;
 
   constructor() {
     this._configCache = new Map();
@@ -12,20 +13,20 @@ export class ConfigManager {
     this._configCache.clear();
   }
 
-  _marshallRules(jsonRules: any[], defaultOpacity: Opacity, defaultFlags: string): Rule[] {
+  _marshallRules(jsonRules: config.Rule[], defaultOpacity: config.Opacity, defaultFlags: string): models.Rule[] {
     return jsonRules
       .filter((rule) => {
         return "pattern" in rule;
       })
       .map((rule) => {
-        return {
+        return <models.Rule>{
           regex: new RegExp(rule["pattern"], rule["flags"] ?? defaultFlags),
           opacity: rule["opacity"] ?? defaultOpacity,
         };
       });
   }
 
-  _getWorkspaceRulesInJSON(workspaceConfig: vscode.WorkspaceConfiguration): any[] {
+  _getWorkspaceRulesInJSON(workspaceConfig: vscode.WorkspaceConfiguration): config.Rule[] {
     const jsonRules = workspaceConfig.get("rules") ?? [];
     if (!Array.isArray(jsonRules)) return [];
     return jsonRules;
@@ -35,7 +36,7 @@ export class ConfigManager {
     return "[" + editor.document.uri.path.split(".").pop() + "]";
   }
 
-  _getLanguageSpecificRulesInJSON(editor: vscode.TextEditor): Rule[] {
+  _getLanguageSpecificRulesInJSON(editor: vscode.TextEditor): config.Rule[] {
     const activeLangSlug = this._getActiveDocumentLanguageSlug(editor);
 
     const workspaceConfig = vscode.workspace.getConfiguration();
@@ -55,22 +56,22 @@ export class ConfigManager {
     return rules;
   }
 
-  _readRules(editor: vscode.TextEditor, workspaceConfig: vscode.WorkspaceConfiguration): Rule[] {
-    const defaultOpacity = (workspaceConfig.get("defaultOpacityTier") as Opacity) ?? Opacity.Mid;
+  _readRules(editor: vscode.TextEditor, workspaceConfig: vscode.WorkspaceConfiguration): models.Rule[] {
+    const defaultOpacity = (workspaceConfig.get("defaultOpacityTier") as config.Opacity) ?? config.Opacity.Mid;
     const defaultFlags = (workspaceConfig.get("defaultFlags") as string) ?? "gs";
     const workspaceRules = this._getWorkspaceRulesInJSON(workspaceConfig);
     const languageSpecificRules = this._getLanguageSpecificRulesInJSON(editor);
     const rules = this._marshallRules([...workspaceRules, ...languageSpecificRules], defaultOpacity, defaultFlags);
     return rules;
   }
 
-  readConfig(editor: vscode.TextEditor): Config {
+  readConfig(editor: vscode.TextEditor): models.Config {
     const cached = this._configCache.get(editor.document.uri);
     if (cached) {
       return cached;
     }
     const workspaceConfig = vscode.workspace.getConfiguration("dim", editor.document.uri);
-    const config: Config = {
+    const config: models.Config = {
       rules: this._readRules(editor, workspaceConfig),
       valueForMinTier: workspaceConfig.get("valueForMinTier") ?? 0.25,
       valueForMidTier: workspaceConfig.get("valueForMidTier") ?? 0.5,

src/editorDecorator.ts

@@ -1,12 +1,12 @@
 import * as vscode from "vscode";
-import * as models from "./models";
 import * as utils from "./utilities";
-import { ConfigManager } from "./configmanager";
+import * as cm from "./configManager";
+import * as models from "./models";
 
 export class EditorDecorator {
   private editor: vscode.TextEditor;
   private config: models.Config;
-  private configManager: ConfigManager;
+  private configManager: cm.ConfigManager;
   private filename: string;
   private logger: vscode.OutputChannel;
   private matches: Map<models.Rule, vscode.Range[]> | undefined;
@@ -17,9 +17,9 @@ export class EditorDecorator {
   private lastUpdateTimestamp: number;
   private timeoutForScheduler: NodeJS.Timeout | undefined;
 
-  constructor(editor: vscode.TextEditor, configManager: ConfigManager, enabled: boolean, logger: vscode.OutputChannel) {
+  constructor(editor: vscode.TextEditor, cm: cm.ConfigManager, enabled: boolean, logger: vscode.OutputChannel) {
     this.editor = editor;
-    this.configManager = configManager;
+    this.configManager = cm;
     this.logger = logger;
     this.enabled = enabled;
     this.inFocus = true;

src/extension.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 import { EditorDecorator } from "./editorDecorator";
-import { ConfigManager } from "./configmanager";
+import { ConfigManager } from "./configManager";
 
 class ExtensionLifecycleController {
   decorators: Map<vscode.TextEditor, EditorDecorator>;
@@ -54,7 +54,7 @@ class ExtensionLifecycleController {
     }
   }
 
-  onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined): any {
+  onDidChangeActiveTextEditor(editor: vscode.TextEditor | undefined): unknown {
     if (this.activeEditor) {
       const d = this.decorators.get(this.activeEditor);
       if (d) {
@@ -91,7 +91,7 @@ class ExtensionLifecycleController {
     }
   }
 
-  onDidChangeTextDocument(event: vscode.TextDocumentChangeEvent): any {
+  onDidChangeTextDocument(event: vscode.TextDocumentChangeEvent): unknown {
     if (!this.activeEditor) return;
     if (event.document.uri.path !== this.activeEditor.document.uri.path || event.document.uri.scheme !== "file") return;
     this.logger.appendLine("onDidChangeTextDocument");

src/models.ts

@@ -1,14 +1,22 @@
 import * as vscode from "vscode";
+import * as config from "./config";
 
-export enum Opacity {
-  Max = "max",
-  Mid = "mid",
-  Min = "min",
+export interface PerDecorationQueue {
+  "max": vscode.Range[];
+  "mid": vscode.Range[];
+  "min": vscode.Range[];
 }
 
+export interface DecorationTypes {
+  "max": vscode.TextEditorDecorationType;
+  "mid": vscode.TextEditorDecorationType;
+  "min": vscode.TextEditorDecorationType;
+}
+
+/* Compiled version of {@link config.Rule}. */
 export interface Rule {
   regex: RegExp;
-  opacity: Opacity;
+  opacity: config.Opacity;
 }
 
 export interface Config {
@@ -18,15 +26,3 @@ export interface Config {
   valueForMinTier: number;
   updatePeriod: number;
 }
-
-export interface PerDecorationQueue {
-  "max": vscode.Range[];
-  "mid": vscode.Range[];
-  "min": vscode.Range[];
-}
-
-export interface DecorationTypes {
-  "max": vscode.TextEditorDecorationType;
-  "mid": vscode.TextEditorDecorationType;
-  "min": vscode.TextEditorDecorationType;
-}