Merge pull request microsoft#37120 from DdWr/feature/line_number_inte…

…rval_setting Add line number interval setting
haj · Nov 14, 2017 · 0e0e347 · 0e0e347
2 parents af52203 + 110bfd6
commit 0e0e347
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 9 deletions.
diff --git a/src/vs/editor/browser/viewParts/lineNumbers/lineNumbers.ts b/src/vs/editor/browser/viewParts/lineNumbers/lineNumbers.ts
@@ -27,7 +27,6 @@ export class LineNumbersOverlay extends DynamicViewOverlay {
 	private _renderCustomLineNumbers: (lineNumber: number) => string;
 	private _lineNumbersLeft: number;
 	private _lineNumbersWidth: number;
-
 	private _lastCursorModelPosition: Position;
 	private _renderResult: string[];
 
@@ -68,7 +67,7 @@ export class LineNumbersOverlay extends DynamicViewOverlay {
 		const primaryViewPosition = e.selections[0].getPosition();
 		this._lastCursorModelPosition = this._context.model.coordinatesConverter.convertViewPositionToModelPosition(primaryViewPosition);
 
-		if (this._renderLineNumbers === RenderLineNumbersType.Relative) {
+		if (this._renderLineNumbers === RenderLineNumbersType.Relative || this._renderLineNumbers === RenderLineNumbersType.Interval) {
 			return true;
 		}
 		return false;
@@ -113,6 +112,16 @@ export class LineNumbersOverlay extends DynamicViewOverlay {
 			return String(diff);
 		}
 
+		if (this._renderLineNumbers === RenderLineNumbersType.Interval) {
+			if (this._lastCursorModelPosition.lineNumber === modelLineNumber) {
+				return String(modelLineNumber);
+			}
+			if (modelLineNumber % 10 === 0) {
+				return String(modelLineNumber);
+			}
+			return '';
+		}
+
 		return String(modelLineNumber);
 	}
 
@@ -132,6 +141,7 @@ export class LineNumbersOverlay extends DynamicViewOverlay {
 			let lineIndex = lineNumber - visibleStartLineNumber;
 
 			let renderLineNumber = this._getLineRenderLineNumber(lineNumber);
+
 			if (renderLineNumber) {
 				output[lineIndex] = (
 					common

diff --git a/src/vs/editor/common/config/commonEditorConfig.ts b/src/vs/editor/common/config/commonEditorConfig.ts
@@ -203,11 +203,12 @@ const editorConfiguration: IConfigurationNode = {
 		},
 		'editor.lineNumbers': {
 			'type': 'string',
-			'enum': ['off', 'on', 'relative'],
+			'enum': ['off', 'on', 'relative', 'interval'],
 			'enumDescriptions': [
 				nls.localize('lineNumbers.off', "Line numbers are not rendered."),
 				nls.localize('lineNumbers.on', "Line numbers are rendered as absolute number."),
-				nls.localize('lineNumbers.relative', "Line numbers are rendered as distance in lines to cursor position.")
+				nls.localize('lineNumbers.relative', "Line numbers are rendered as distance in lines to cursor position."),
+				nls.localize('lineNumbers.interval', "Line numbers are rendered every 10 lines.")
 			],
 			'default': 'on',
 			'description': nls.localize('lineNumbers', "Controls the display of line numbers. Possible values are 'on', 'off', and 'relative'.")

diff --git a/src/vs/editor/common/config/editorOptions.ts b/src/vs/editor/common/config/editorOptions.ts
@@ -160,7 +160,7 @@ export interface IEditorOptions {
 	 * Otherwise, line numbers will not be rendered.
 	 * Defaults to true.
 	 */
-	lineNumbers?: 'on' | 'off' | 'relative' | ((lineNumber: number) => string);
+	lineNumbers?: 'on' | 'off' | 'relative' | 'interval' | ((lineNumber: number) => string);
 	/**
 	 * Should the corresponding line be selected when clicking on the line number?
 	 * Defaults to true.
@@ -757,7 +757,8 @@ export const enum RenderLineNumbersType {
 	Off = 0,
 	On = 1,
 	Relative = 2,
-	Custom = 3
+	Interval = 3,
+	Custom = 4
 }
 
 export interface InternalEditorViewOptions {
@@ -1579,6 +1580,8 @@ export class EditorOptionsValidator {
 			if (typeof lineNumbers === 'function') {
 				renderLineNumbers = RenderLineNumbersType.Custom;
 				renderCustomLineNumbers = lineNumbers;
+			} else if (lineNumbers === 'interval') {
+				renderLineNumbers = RenderLineNumbersType.Interval;
 			} else if (lineNumbers === 'relative') {
 				renderLineNumbers = RenderLineNumbersType.Relative;
 			} else if (lineNumbers === 'on') {

diff --git a/src/vs/editor/standalone/browser/standaloneEditor.ts b/src/vs/editor/standalone/browser/standaloneEditor.ts
@@ -349,7 +349,8 @@ enum RenderLineNumbersType {
 	Off = 0,
 	On = 1,
 	Relative = 2,
-	Custom = 3
+	Interval = 3,
+	Custom = 4
 }
 
 /**

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -2498,7 +2498,7 @@ declare module monaco.editor {
 		 * Otherwise, line numbers will not be rendered.
 		 * Defaults to true.
 		 */
-		lineNumbers?: 'on' | 'off' | 'relative' | ((lineNumber: number) => string);
+		lineNumbers?: 'on' | 'off' | 'relative' | 'interval' | ((lineNumber: number) => string);
 		/**
 		 * Should the corresponding line be selected when clicking on the line number?
 		 * Defaults to true.
@@ -3028,7 +3028,8 @@ declare module monaco.editor {
 		Off = 0,
 		On = 1,
 		Relative = 2,
-		Custom = 3,
+		Interval = 3,
+		Custom = 4,
 	}
 
 	export interface InternalEditorViewOptions {