initial commit 🎉

Author: Joe

.github/workflows/ci.yml

@@ -0,0 +1,15 @@
+name: main
+on: [push]
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    name: Build
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16.4"
+
+      - run: yarn
+      - run: yarn build

.gitignore

@@ -0,0 +1,3 @@
+/node_modules
+package-lock.json
+/dist

.npmignore

@@ -0,0 +1,4 @@
+index.ts
+/node_modules
+.tern-*
+tsconfig.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2018-2021 by Joe Previte <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,26 @@
+# Vim keybindings for CM6
+
+## Installation
+
+`npm i @replit/codemirror-vim`
+
+## Usage
+
+```js
+import { basicSetup, EditorState } from '@codemirror/basic-setup';
+import { EditorView } from '@codemirror/view';
+import { vim } from "@replit/codemirror-vim"
+
+new EditorView({
+    state: EditorState.create({
+      doc: "",
+      extensions: [
+        // make sure vim is included before other keymaps
+        vim(), 
+        // include the default keymap and all other keymaps you want to use in insert mode
+        basicSetup, 
+      ]
+    }),
+    parent: document.querySelector('#editor'),
+})
+```

index.ts

@@ -0,0 +1,42 @@
+import { Extension } from "@codemirror/state";
+import { EditorView, ViewUpdate } from "@codemirror/view";
+import { Compartment, EditorState } from "@codemirror/state";
+import { lineNumbers } from "@codemirror/gutter";
+
+let gutter = new Compartment();
+
+function relativeLineNumbers(lineNo: number, state: EditorState) {
+  if (lineNo > state.doc.lines) {
+    return "0";
+  }
+  const cursorLine = state.doc.lineAt(
+    state.selection.asSingle().ranges[0].to
+  ).number;
+  if (lineNo === cursorLine) {
+    return "0";
+  } else {
+    return Math.abs(cursorLine - lineNo).toString();
+  }
+}
+// This shows the numbers in the gutter
+const showLineNumbers = gutter.of(
+  lineNumbers({ formatNumber: relativeLineNumbers })
+);
+
+// This ensures the numbers update
+// when selection (cursorActivity) happens
+const lineNumbersUpdateListener = EditorView.updateListener.of(
+  (viewUpdate: ViewUpdate) => {
+    if (viewUpdate.selectionSet) {
+      viewUpdate.view.dispatch({
+        effects: gutter.reconfigure(
+          lineNumbers({ formatNumber: relativeLineNumbers })
+        ),
+      });
+    }
+  }
+);
+
+export function lineNumbersRelative(): Extension {
+  return [showLineNumbers, lineNumbersUpdateListener];
+}

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "codemirror-line-numbers-relative",
+  "version": "0.19.0-beta.1",
+  "description": "Relative line numbers for CodeMirror 6",
+  "scripts": {
+    "build": "cm-buildhelper index.ts"
+  },
+  "keywords": [
+    "editor",
+    "code",
+    "relative line numbers"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "sideEffects": false,
+  "license": "MIT",
+  "peerDependencies": {
+    "@codemirror/state": "^0.19.3",
+    "@codemirror/view": "^0.19.3",
+    "@codemirror/gutter": "^0.19.3"
+  },
+  "devDependencies": {
+    "@codemirror/buildhelper": "^0.1.11",
+    "@codemirror/lang-javascript": "^0.19.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/replit/codemirror-vim.git"
+  }
+}

tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "allowJs": false,
+        "checkJs": false, 
+        "lib": ["es6", "dom", "scripthost"],
+        "stripInternal": true,
+        "typeRoots": ["./node_modules/@types"],
+        "noUnusedLocals": true,
+        "strict": true,
+        "target": "es6",
+        "module": "es2020",
+        "newLine": "lf",
+        "moduleResolution": "node",
+    },
+    "include": [
+        "index.ts"
+    ]
+}