Fix types (#205)

* fix types

* fix search register

* resolve more cases of any type

* remove explicit uses of any

Author: nightwing

dev/index.ts

@@ -3,7 +3,7 @@ import { highlightActiveLine, keymap, Decoration, DecorationSet,
    ViewPlugin, ViewUpdate, WidgetType, drawSelection } from '@codemirror/view';
 import { javascript } from '@codemirror/lang-javascript';
 import { xml } from '@codemirror/lang-xml';
-import { Vim, vim } from "../src/index"
+import { Vim, vim } from "../src/index" // "@replit/codemirror-vim" 
 
 import * as commands from "@codemirror/commands";
 import { Annotation, Compartment, EditorState, Extension, Transaction, Range } from '@codemirror/state';
@@ -25,7 +25,8 @@ new EditorView({
 
 `;
 
-function addOption(name, description?, onclick?) {
+function addOption(name: "wrap"|"html"|"status"|"jj"|"split"|"readOnly",
+   description?: string, onclick?: (value: boolean) => void) {
   let checkbox = document.createElement("input");
   checkbox.type = "checkbox";
   checkbox.id = name;
@@ -49,16 +50,16 @@ class TestWidget extends WidgetType {
     constructor(private side: number) {
         super(); 
     }
-    eq(other) {
-        return (true);
+    override eq(other: TestWidget) {
+        return other == this;
     }
     toDOM() {
         const wrapper = document.createElement('span');
         wrapper.textContent =  " widget" + this.side + " "
         wrapper.style.opacity = '0.4';
         return wrapper;
     }
-    ignoreEvent() {
+    override ignoreEvent() {
         return false;
     }
 }
@@ -73,7 +74,7 @@ function widgets(view: EditorView) {
     })
     widgets.push(deco.range(200 + 10 * i))
   }
-  console.log(widgets)
+  console.log(widgets, view)
   return Decoration.set(widgets)
 }
 
@@ -93,6 +94,7 @@ const testWidgetPlugin = ViewPlugin.fromClass(class {
 
   eventHandlers: {
     mousedown: (e, view) => {
+      console.log("mousedown", e, view)
     }
   }
 })
@@ -117,10 +119,12 @@ var options = {
 
 
 Vim.defineOption('wrap', false, 'boolean', null, function(val, cm) {
+  if (!cm) console.log("should set global option");
   if (val == undefined) return options.wrap;
-  var checkbox = document.getElementById("wrap");
+  var checkbox = document.getElementById("wrap") as HTMLInputElement;
   if (checkbox) {
     checkbox.checked = val;
+    //@ts-ignore
     checkbox.onclick();
   }
 });
@@ -166,21 +170,22 @@ var defaultExtensions = [
   ]),
 ]
 
-function saveTab(name) {
+function saveTab(name: string) {
   return EditorView.updateListener.of((v) => {
     tabs[name] = v.state;
   })
 }
 
-var tabs = {
+
+var tabs: Record<string, EditorState> = {
   js: EditorState.create({
     doc: doc,
     extensions: [...defaultExtensions, javascript(), saveTab("js")]
   }),
   html: EditorState.create({
     doc: document.documentElement.outerHTML,
     extensions: [...defaultExtensions, testWidgetPlugin, xml(), saveTab("html")]
-  })
+  }),
 }
 
 function updateView() {
@@ -204,17 +209,25 @@ function updateView() {
   })
 }
 
+declare global {
+  interface Window {
+    blinkRate?: number;
+  }
+}
+
 function selectTab(tab: string) {
-  if (view) view.setState(tabs[tab])
-  if (view2) view2.setState(tabs[tab])
+  let state = tabs[tab];
+  if (!state) return;
+  if (view) view.setState(state)
+  if (view2) view2.setState(state)
   addLogListeners();
 }
 
 Vim.defineEx("tabnext", "tabn", () => {
-  tabs["scratch"] = EditorState.create({
+  tabs.scratch = EditorState.create({
     doc: "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",
     extensions: [defaultExtensions, saveTab("scratch")],
-  })
+  });
   selectTab("scratch")
 });
 
@@ -304,7 +317,7 @@ updateView()
 // save and  restor search history
 
 
-function saveHistory(name) {
+function saveHistory(name: "exCommandHistoryController"|"searchHistoryController") {
   var controller = Vim.getVimGlobalState_()[name];
   var json = JSON.stringify(controller);
   if (json.length > 10000) {
@@ -315,11 +328,11 @@ function saveHistory(name) {
   }
   localStorage[name] = json;
 }
-function restoreHistory(name) {
+function restoreHistory(name: "exCommandHistoryController"|"searchHistoryController") {
   try {
     var json = JSON.parse(localStorage[name]);
     var controller = Vim.getVimGlobalState_()[name];
-    controller.historyBuffer = json.historyBuffer.filter(x => typeof x == "string" && x)
+    controller.historyBuffer = json.historyBuffer.filter((x: unknown) => typeof x == "string" && x)
     controller.iterator = Math.min(parseInt(json.iterator) || Infinity, controller.historyBuffer.length)
   } catch(e) {
 
@@ -333,3 +346,7 @@ window.onunload = function() {
   saveHistory('exCommandHistoryController');
   saveHistory('searchHistoryController');
 }
+
+Vim.defineEx("write", "w", (cm) => {
+  console.log("called", cm);
+})

package.json

@@ -9,10 +9,11 @@
   "scripts": {
     "dev": "vite ./dev",
     "test": "cm-runtests",
-    "static": "tsc --noEmit",
-    "testAll": "yarn run static && yarn run test && cd dev/cm5 && yarn run buildAndTest",
-    "build": "cm-buildhelper src/index.ts && node scripts/addVersion.cjs",
+    "build-types": "rm -rf out && tsc && dts-bundle-generator out/index.ts -o dist/index.d.ts && cp dist/index.d.ts dist/index.d.cts",
+    "testAll": "yarn run build-test-package && yarn run test && cd dev/cm5 && yarn run buildAndTest",
+    "build": "cm-buildhelper src/index.ts && node scripts/addVersion.cjs && npm run build-types",
     "publish": "yarn run build && npm publish",
+    "build-test-package": "bash ./scripts/build-test-package.sh",
     "prepare": "yarn run build"
   },
   "keywords": [
@@ -42,9 +43,14 @@
     "@codemirror/lang-xml": "^6.0.0",
     "@codemirror/language": "^6.1.0",
     "codemirror": "6.0.1",
-    "typescript": "^5.0.2",
-    "vite": "^2.9.6"
+    "dts-bundle-generator": "^9.5.1",
+    "typescript": "^5.7.3",
+    "vite": "^6.1.0"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/replit/codemirror-vim.git"

scripts/build-test-package.sh

@@ -0,0 +1,77 @@
+#!/bin/bash
+set -euxo pipefail
+
+# Navigate to the repository root
+cd "$(dirname "$0")/.."
+ROOT="$(pwd)"
+
+# npm pack the repository
+rm -f replit-codemirror-vim-*.tgz
+npm pack
+
+# Get the name of the packed file
+PACKAGE_FILE=$(ls replit-codemirror-vim-*.tgz | sort -V | tail -n 1)
+
+mv "$PACKAGE_FILE" replit-codemirror-vim-latest.tgz
+
+rm -rf ../.test_package
+mkdir -p ../.test_package
+cd ../.test_package
+
+cp "$ROOT"/dev/index.ts index.ts
+node -e "
+const fs = require('fs');
+const filePath = 'index.ts';
+let data = fs.readFileSync(filePath, 'utf8');
+data = data.replace(/\"..\/src\/index\" \/\//g, '');
+fs.writeFileSync(filePath, data, 'utf8');
+"
+
+echo '{
+    "name": "test_package",
+    "scripts": {
+        "build": "tsc",
+        "test": "echo \"No tests yet\""
+    }
+}' > package.json
+
+echo '{
+  "compilerOptions": {
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": false,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "target": "es2020",
+    "moduleResolution": "node"
+  },
+  "include": ["*.ts"],
+  "exclude": ["node_modules"]
+}
+' > tsconfig.json
+
+# Install the ace package from the npm pack result
+npm i "$ROOT"/replit-codemirror-vim-latest.tgz 
+npm i codemirror @codemirror/lang-javascript @codemirror/lang-xml
+
+# Install TypeScript
+npm i typescript@latest
+rm -f index.js 
+npm run build
+
+# Install old version of TypeScript
+npm i typescript@4
+rm -f index.js 
+npm run build

src/cm_adapter.ts

@@ -152,8 +152,8 @@ export class CodeMirror {
     return wordChar.test(ch);
   };
   static keys: any = keys;
-  static addClass = function (el, str) { };
-  static rmClass = function (el, str) { };
+  static addClass = function (el: any, str: string) { };
+  static rmClass = function (el: any, str: string) { };
   static e_preventDefault = function (e: Event) {
     e.preventDefault()
   };
@@ -164,6 +164,7 @@ export class CodeMirror {
 
   static lookupKey = function lookupKey(key: string, map: string, handle: Function) {
     var result = CodeMirror.keys[key];
+    if (!result && /^Arrow/.test(key)) result = CodeMirror.keys[key.slice(5)];
     if (result) handle(result);
   };
 
@@ -172,7 +173,7 @@ export class CodeMirror {
   static signal = signal;
 
   // --------------------------
-  openDialog(template: Element, callback: Function, options: any) {
+  openDialog(template: Element, callback: Function|undefined, options: any) {
     return openDialog(this, template, callback, options);
   };
   openNotification(template: Node, options: NotificationOptions) {
@@ -674,7 +675,7 @@ export class CodeMirror {
       curOp.cursorActivityHandlers = this._handlers["cursorActivity"] && this._handlers["cursorActivity"].slice();
     this.curOp.cursorActivity = true;
   };
-  operation(fn: Function, force?: boolean) {
+  operation<T>(fn: ()=>T, force?: boolean) {
     if (!this.curOp)
       this.curOp = { $d: 0 };
     this.curOp.$d++;
@@ -727,7 +728,7 @@ export class CodeMirror {
 
     }
   };
-  getOption(name:"firstLineNumber"|"tabSize"): number;
+  getOption(name:"firstLineNumber"|"tabSize"|"textwidth"): number;
   getOption(name:string): number|boolean|string|undefined;
   getOption(name: string) {
     switch (name) {
@@ -794,7 +795,7 @@ export class CodeMirror {
     this.virtualSelection = null;
   }
 
-  hardWrap(options) {
+  hardWrap(options: hardWrapOptions) {
     return hardWrap(this, options);
   }
 
@@ -875,7 +876,7 @@ function hideDialog(cm: CodeMirror, dialog: Element) {
   }
 }
 
-function openDialog(me: CodeMirror, template: Element, callback: Function, options: any) {
+function openDialog(me: CodeMirror, template: Element, callback: Function|undefined, options: any) {
   if (!options) options = {};
 
   closeNotification(me, undefined);
@@ -913,7 +914,7 @@ function openDialog(me: CodeMirror, template: Element, callback: Function, optio
 
     CodeMirror.on(inp, "keydown", function (e: KeyboardEvent) {
       if (options && options.onKeyDown && options.onKeyDown(e, inp.value, close)) { return; }
-      if (e.keyCode == 13) callback(inp.value);
+      if (e.keyCode == 13) callback && callback(inp.value);
       if (e.keyCode == 27 || (options.closeOnEnter !== false && e.keyCode == 13)) {
         inp.blur();
         CodeMirror.e_stop(e);
@@ -968,7 +969,8 @@ function scanForBracket(cm: CodeMirror, where: Pos, dir: -1 | 1, style: any, con
   return lineNo - dir == (dir > 0 ? cm.lastLine() : cm.firstLine()) ? false : null;
 }
 
-function findMatchingTag(cm: CodeMirror, pos: Pos): undefined {
+function findMatchingTag(cm: CodeMirror, pos: Pos) {
+  return null;
 }
 
 function findEnclosingTag(cm: CodeMirror, pos: Pos) {
@@ -1028,8 +1030,8 @@ class Marker {
 }
 
 
-
-function hardWrap(cm, options) {
+type hardWrapOptions = {from: number, to: number, column?: number, allowMerge?: boolean};
+function hardWrap(cm: CodeMirror, options: hardWrapOptions) {
   var max = options.column || cm.getOption('textwidth') || 80;
   var allowMerge = options.allowMerge != false;
 
@@ -1066,7 +1068,7 @@ function hardWrap(cm, options) {
   }
   return row;
 
-  function findSpace(line, max, min) {
+  function findSpace(line: string, max: number, min: number) {
     if (line.length < max)
       return;
     var before = line.slice(0, max);