Moving to TS

.gitignore

@@ -3,6 +3,7 @@
 HOWTO-publish.md
 .vscode/tasks.json
 node_modules/
+dist/
 .vsixmanifest
 vsc-todo-highlight.code-workspace
 todo-highlight.code-workspace

.vscode/launch.json

@@ -0,0 +1,22 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"runtimeExecutable": "${execPath}",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+			],
+			"outFiles": [
+				"${workspaceFolder}/dist/**/*.js"
+			],
+			"preLaunchTask": "npm: webpack"
+		}
+	]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    "npm.packageManager": "npm",
+}

package.json

@@ -42,8 +42,7 @@
 	"scripts": {
 		"vscode:prepublish": "webpack --mode production",
 		"webpack": "webpack --mode development",
-		"webpack-dev": "webpack --mode development --watch",
-		"postinstall": "node ./node_modules/vscode/bin/install"
+		"webpack-dev": "webpack --mode development --watch"
 	},
 	"badges": [
 		{
@@ -272,9 +271,10 @@
 	"devDependencies": {
 		"@types/mocha": "^2.2.32",
 		"@types/node": "^6.0.40",
-		"@types/vscode": "^1.0.0",
+		"@types/vscode": "^1.63.1",
 		"eslint": "^7.18.0",
 		"mocha": "^8.2.0",
+		"ts-loader": "^9.2.6",
 		"typescript": "^4.1.2",
 		"webpack-cli": "^4.x.x"
 	},

src/config-utils.ts

@@ -0,0 +1,151 @@
+import { ConfigurationScope, ConfigurationTarget, workspace } from 'vscode';
+
+type InspectReturnValue<C extends { [key: string]: any }, K extends keyof C> = {
+  key: string;
+  defaultValue?: C[K];
+  globalValue?: C[K];
+  workspaceValue?: C[K];
+  workspaceFolderValue?: C[K];
+  defaultLanguageValue?: C[K];
+  globalLanguageValue?: C[K];
+  workspaceLanguageValue?: C[K];
+  workspaceFolderLanguageValue?: C[K];
+  languageIds?: string[];
+};
+
+export function ConfigurationGetter<C extends { [key: string]: any }>(
+  section: string
+) {
+  return <K extends keyof C>(
+    subsection: K,
+    scope?: ConfigurationScope | null,
+    defaultValue?: C[K]
+  ) => {
+    const config = workspace.getConfiguration(section, scope);
+    // @ts-expect-error subsection is always of type string, though the compiler doesn't see it
+    return config.get<C[K] | undefined>(subsection, defaultValue);
+  };
+}
+
+export function ConfigurationInspector<C extends { [key: string]: any }>(
+  section: string
+) {
+  return <K extends keyof C>(
+    subsection: K,
+    scope?: ConfigurationScope | null
+  ): InspectReturnValue<C, K> => {
+    const config = workspace.getConfiguration(section, scope);
+    // @ts-expect-error subsection is always of type string, though the compiler doesn't see it
+    return config.inspect(subsection);
+  };
+}
+
+export function ConfigurationSetter<C extends { [key: string]: any }>(
+  section: string
+) {
+  return <K extends keyof C>(
+    subsection: K,
+    value: C[K],
+    scope?: ConfigurationScope | null,
+    configurationTarget?: boolean | ConfigurationTarget | null,
+    overrideInLanguage?: boolean
+  ) => {
+    const config = workspace.getConfiguration(section, scope);
+    return config.update(
+      // @ts-expect-error subsection is always of type string, though the compiler doesn't see it
+      subsection,
+      value,
+      configurationTarget,
+      overrideInLanguage
+    );
+  };
+}
+
+interface IGet<C extends { [key: string]: any }> {
+  get<K extends keyof C>(
+    subsection: K,
+    scope?: ConfigurationScope | null
+  ): C[K] | undefined;
+  get<K extends keyof C>(
+    subsection: K,
+    scope: ConfigurationScope | null | undefined,
+    defaultValue: C[K]
+  ): C[K];
+}
+
+interface IInspect<C extends { [key: string]: any }> {
+  inspect<K extends keyof C>(
+    subsection: K
+  ): InspectReturnValue<C, K> | undefined;
+}
+
+interface IUpdate<C extends { [key: string]: any }> {
+  update<K extends keyof C>(
+    subsection: K,
+    value: C[K],
+    scope?: ConfigurationScope,
+    configurationTarget?: boolean | ConfigurationTarget,
+    overrideInLanguage?: boolean
+  ): Thenable<void>;
+}
+
+export class VSCodeConfigurations<C extends { [key: string]: any }>
+  implements IGet<C>, IUpdate<C>, IInspect<C>
+{
+  private _get: <K extends keyof C>(
+    subsection: K,
+    scope?: ConfigurationScope | null,
+    defaultValue?: C[K]
+  ) => C[K] | undefined;
+  private _inspect: <K extends keyof C>(
+    subsection: K
+  ) => InspectReturnValue<C, K>;
+  private _update: <K extends keyof C>(
+    subsection: K,
+    value: C[K],
+    scope?: ConfigurationScope | null,
+    configurationTarget?: boolean | ConfigurationTarget | null,
+    overrideInLanguage?: boolean
+  ) => Thenable<void>;
+
+  constructor(readonly section: string) {
+    this._get = ConfigurationGetter<C>(section);
+    this._update = ConfigurationSetter<C>(section);
+    this._inspect = ConfigurationInspector<C>(section);
+  }
+
+  update<K extends keyof C>(
+    subsection: K,
+    value: C[K],
+    scope?: ConfigurationScope,
+    configurationTarget?: boolean | ConfigurationTarget,
+    overrideInLanguage?: boolean
+  ): Thenable<void> {
+    return this._update(
+      subsection,
+      value,
+      scope,
+      configurationTarget,
+      overrideInLanguage
+    );
+  }
+
+  inspect<K extends keyof C>(
+    subsection: K
+  ): InspectReturnValue<C, K> | undefined {
+    return this._inspect(subsection);
+  }
+
+  get<K extends keyof C>(
+    subsection: K,
+    scope?: ConfigurationScope | null
+  ): C[K] | undefined;
+  get<K extends keyof C>(
+    subsection: K,
+    scope: ConfigurationScope | null | undefined,
+    defaultValue: C[K]
+  ): C[K];
+  get(subsection: any, scope?: any, defaultValue?: any) {
+    return this._get(subsection, scope, defaultValue);
+  }
+}

src/config.ts

@@ -0,0 +1,93 @@
+import { ConfigurationScope, ConfigurationTarget, workspace } from 'vscode';
+import { VSCodeConfigurations } from './config-utils';
+
+export interface Style {
+    /**
+     * The background color for the highlight.
+     */
+    backgroundColor?: string;
+    /**
+     * The border style for the highlight, as a CSS string.
+     */
+    border?: string;
+    /**
+     * The text color.
+     */
+    color?: string;
+    /**
+     * The style for the cursor shown over the highlight, as a CSS property.
+     */
+    cursor?: string;
+    /**
+     * If true, then the whole line is highlighted, not just the matching text.
+     */
+    isWholeLine?: boolean;
+    /**
+     * The color of the ruler mark on the scroll bar.
+     */
+    overviewRulerColor?: string;
+}
+
+export interface TextKeyword extends Style {
+    /**
+     * Custom text to be highlighted.
+     */
+    text: string;
+}
+export interface RegExpKeyword extends Style {
+    /**
+     * name of the regexp keyword.
+     */
+    text: string;
+    regex: {
+        /**
+         * The RegEx pattern to use for matching instead of the text value. REMEMBER to escape any backslashes in your regexp (using \\ instead of single backslash).
+         */
+        pattern: string;
+    };
+}
+
+export type Keyword = TextKeyword | RegExpKeyword;
+
+export interface TODOHighlightConfig {
+    /**
+     * Enable or disable the highlighting
+     */
+    isEnable: boolean;
+    /**
+     * Specify whether the keywords are case sensitive or not
+     */
+    isCaseSensitive: boolean;
+    /**
+     * If the file path within the output channel is not clickable, set this to true to toggle the path patten between `<path>#<line>` and `<path>:<line>:<column>`
+     */
+    toggleURI: boolean;
+    /*
+     * An array of keywords, and their CSS to customise how they look. See all available properties in the [VSCode doc on DecorationRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationRenderOptions) section.
+    */
+    keywords: (string | Keyword)[];
+    /**
+     * Specify keywords via RegExp instead of `todohighlight.keywords` one by one. NOTE that if this present, `todohighlight.keywords` will be ignored. REMEMBER to escapse any backslashes in your regexp (using \\ instead of single backslash).
+     */
+    keywordsPattern: string;
+    /**
+     * Default style for all customized keywords. See all available properties in the [VSCode doc on DecorationRenderOptions](https://code.visualstudio.com/api/references/vscode-api#DecorationRenderOptions) section.
+     */
+    defaultStyle: Style;
+    /**
+     * Glob patterns that defines the files to search for. Only include files you need, DO NOT USE `{** /*.*}` for both performance and to avoid binary files.
+     */
+    include: string[];
+    /**
+     * Glob pattern that defines files and folders to exclude while listing annotations.
+     */
+    exclude: string[];
+    /**
+     * Max files for searching
+     */
+    maxFilesForSearch: number;
+}
+
+
+const EXTENSION = 'todohighlight';
+export const configurations = new VSCodeConfigurations<TODOHighlightConfig>(EXTENSION);