Merge pull request #201 from aioutecism/feature/smart-relative-line-n…

…umbers

Adding `smartRelativeLineNumbers` config

README.md

@@ -42,6 +42,12 @@ Set to `false` to disable `Ctrl+<key>` keybindings.
 
 Set to `true` to start in Insert mode when opening files.
 
+#### `amVim.smartRelativeLineNumbers`
+
+`Boolean`, Default: `false`
+
+Set to `true` to will make line numbers relative when not in Insert mode.
+
 #### `amVim.vimStyleNavigationInListView`
 
 `Boolean`, Default: `true`

package.json

@@ -50,6 +50,11 @@
                     "default": false,
                     "description": "Set to `true` to start in Insert mode when opening files."
                 },
+                "amVim.smartRelativeLineNumbers": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Set to `true` to will make line numbers relative when not in Insert mode."
+                },
                 "amVim.vimStyleNavigationInListView": {
                     "type": "boolean",
                     "default": true,

src/Actions/RelativeLineNumbers.ts

@@ -0,0 +1,37 @@
+import { TextEditorLineNumbersStyle, window } from 'vscode';
+
+export class ActionRelativeLineNumbers {
+
+    static on(): Thenable<boolean> {
+        return new Promise((resolve) => {
+            setTimeout(() => {
+                const activeTextEditor = window.activeTextEditor;
+
+                if (! activeTextEditor) {
+                    return Promise.resolve(false);
+                }
+
+                activeTextEditor.options.lineNumbers = TextEditorLineNumbersStyle.Relative;
+
+                resolve(true);
+            }, 0);
+        });
+    }
+
+    static off(): Thenable<boolean> {
+        return new Promise((resolve) => {
+            setTimeout(() => {
+                const activeTextEditor = window.activeTextEditor;
+
+                if (! activeTextEditor) {
+                    return Promise.resolve(false);
+                }
+
+                activeTextEditor.options.lineNumbers = TextEditorLineNumbersStyle.On;
+
+                resolve(true);
+            }, 0);
+        });
+    }
+
+}

src/Configuration.ts

@@ -12,6 +12,9 @@ export class Configuration {
     private static _defaultModeID: ModeID;
     static get defaultModeID(): ModeID { return this._defaultModeID; }
 
+    private static _smartRelativeLineNumbers: boolean;
+    static get smartRelativeLineNumbers(): boolean { return this._smartRelativeLineNumbers; }
+
     static init(): void {
         if (this.isReady) {
             return;
@@ -29,7 +32,10 @@ export class Configuration {
     private static onDidChangeConfiguration(): void {
         this.updateCache();
         this.updateKeybindingContexts();
+
         this._defaultModeID = this.getExtensionSetting<boolean>('startInInsertMode', false) ? ModeID.INSERT : ModeID.NORMAL;
+        this._smartRelativeLineNumbers = this.getExtensionSetting<boolean>('smartRelativeLineNumbers', false);
+
         UtilWord.updateCharacterKindCache(this.getEditorSetting<string>('wordSeparators', '`~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?'));
     }
 

src/Modes/Insert.ts

@@ -1,7 +1,9 @@
 import {window, TextEditor, Position} from 'vscode';
 import {Mode, ModeID} from './Mode';
+import {Configuration} from '../Configuration';
 import {MatchResultKind} from '../Mappers/Generic';
 import {CommandMap} from '../Mappers/Command';
+import {ActionRelativeLineNumbers} from '../Actions/RelativeLineNumbers';
 import {ActionInsert} from '../Actions/Insert';
 import {ActionDelete} from '../Actions/Delete';
 import {ActionSelection} from '../Actions/Selection';
@@ -54,6 +56,10 @@ export class ModeInsert extends Mode {
         this.textEditor = window.activeTextEditor;
 
         this.startRecord();
+
+        if (Configuration.smartRelativeLineNumbers) {
+            ActionRelativeLineNumbers.off();
+        }
     }
 
     exit(): void {

src/Modes/Normal.ts

@@ -2,8 +2,10 @@ import {TextEditorRevealType} from 'vscode';
 import {StaticReflect} from '../LanguageExtensions/StaticReflect';
 import {SymbolMetadata} from '../Symbols/Metadata';
 import {Mode, ModeID} from './Mode';
+import {Configuration} from '../Configuration';
 import {CommandMap} from '../Mappers/Command';
 import {ActionBlockCursor} from '../Actions/BlockCursor';
+import {ActionRelativeLineNumbers} from '../Actions/RelativeLineNumbers';
 import {ActionMoveCursor} from '../Actions/MoveCursor';
 import {ActionPage} from '../Actions/Page';
 import {ActionInsert} from '../Actions/Insert';
@@ -246,6 +248,10 @@ export class ModeNormal extends Mode {
         super.enter();
 
         ActionBlockCursor.on();
+
+        if (Configuration.smartRelativeLineNumbers) {
+            ActionRelativeLineNumbers.on();
+        }
     }
 
     exit(): void {

src/Modes/Visual.ts

@@ -3,7 +3,9 @@ import {StaticReflect} from '../LanguageExtensions/StaticReflect';
 import {SymbolMetadata} from '../Symbols/Metadata';
 import {RangeOffset} from '../Types/RangeOffset';
 import {Mode, ModeID} from './Mode';
+import {Configuration} from '../Configuration';
 import {CommandMap} from '../Mappers/Command';
+import {ActionRelativeLineNumbers} from '../Actions/RelativeLineNumbers';
 import {ActionMoveCursor} from '../Actions/MoveCursor';
 import {ActionPage, PageMoveType} from '../Actions/Page';
 import {ActionSelection} from '../Actions/Selection';
@@ -143,6 +145,10 @@ export class ModeVisual extends Mode {
         super.enter();
 
         ActionSelection.expandToOne();
+
+        if (Configuration.smartRelativeLineNumbers) {
+            ActionRelativeLineNumbers.on();
+        }
     }
 
     private _recordedCommandMaps: CommandMap[];

src/Modes/VisualLine.ts

@@ -3,7 +3,9 @@ import {StaticReflect} from '../LanguageExtensions/StaticReflect';
 import {SymbolMetadata} from '../Symbols/Metadata';
 import {RangeOffset} from '../Types/RangeOffset';
 import {Mode, ModeID} from './Mode';
+import {Configuration} from '../Configuration';
 import {CommandMap} from '../Mappers/Command';
+import {ActionRelativeLineNumbers} from '../Actions/RelativeLineNumbers';
 import {ActionMoveCursor} from '../Actions/MoveCursor';
 import {ActionPage, PageMoveType} from '../Actions/Page';
 import {ActionSelection} from '../Actions/Selection';
@@ -148,6 +150,10 @@ export class ModeVisualLine extends Mode {
         super.enter();
 
         ActionSelection.expandToLine();
+
+        if (Configuration.smartRelativeLineNumbers) {
+            ActionRelativeLineNumbers.on();
+        }
     }
 
     private _recordedCommandMaps: CommandMap[];