Merge pull request #1407 from Tyriar/enum_names

Enforce upper case for public const/enum members and const

src/AccessibilityManager.ts

@@ -12,9 +12,9 @@ import { IDisposable } from 'xterm';
 
 const MAX_ROWS_TO_READ = 20;
 
-enum BoundaryPosition {
-  Top,
-  Bottom
+const enum BoundaryPosition {
+  TOP,
+  BOTTOM
 }
 
 export class AccessibilityManager implements IDisposable {
@@ -54,8 +54,8 @@ export class AccessibilityManager implements IDisposable {
       this._rowContainer.appendChild(this._rowElements[i]);
     }
 
-    this._topBoundaryFocusListener = e => this._onBoundaryFocus(e, BoundaryPosition.Top);
-    this._bottomBoundaryFocusListener = e => this._onBoundaryFocus(e, BoundaryPosition.Bottom);
+    this._topBoundaryFocusListener = e => this._onBoundaryFocus(e, BoundaryPosition.TOP);
+    this._bottomBoundaryFocusListener = e => this._onBoundaryFocus(e, BoundaryPosition.BOTTOM);
     this._rowElements[0].addEventListener('focus', this._topBoundaryFocusListener);
     this._rowElements[this._rowElements.length - 1].addEventListener('focus', this._bottomBoundaryFocusListener);
 
@@ -101,11 +101,11 @@ export class AccessibilityManager implements IDisposable {
 
   private _onBoundaryFocus(e: FocusEvent, position: BoundaryPosition): void {
     const boundaryElement = <HTMLElement>e.target;
-    const beforeBoundaryElement = this._rowElements[position === BoundaryPosition.Top ? 1 : this._rowElements.length - 2];
+    const beforeBoundaryElement = this._rowElements[position === BoundaryPosition.TOP ? 1 : this._rowElements.length - 2];
 
     // Don't scroll if the buffer top has reached the end in that direction
     const posInSet = boundaryElement.getAttribute('aria-posinset');
-    const lastRowPos = position === BoundaryPosition.Top ? '1' : `${this._terminal.buffer.lines.length}`;
+    const lastRowPos = position === BoundaryPosition.TOP ? '1' : `${this._terminal.buffer.lines.length}`;
     if (posInSet === lastRowPos) {
       return;
     }
@@ -119,7 +119,7 @@ export class AccessibilityManager implements IDisposable {
     // Remove old boundary element from array
     let topBoundaryElement: HTMLElement;
     let bottomBoundaryElement: HTMLElement;
-    if (position === BoundaryPosition.Top) {
+    if (position === BoundaryPosition.TOP) {
       topBoundaryElement = boundaryElement;
       bottomBoundaryElement = this._rowElements.pop()!;
       this._rowContainer.removeChild(bottomBoundaryElement);
@@ -134,7 +134,7 @@ export class AccessibilityManager implements IDisposable {
     bottomBoundaryElement.removeEventListener('focus', this._bottomBoundaryFocusListener);
 
     // Add new element to array/DOM
-    if (position === BoundaryPosition.Top) {
+    if (position === BoundaryPosition.TOP) {
       const newElement = this._createAccessibilityTreeNode();
       this._rowElements.unshift(newElement);
       this._rowContainer.insertAdjacentElement('afterbegin', newElement);
@@ -149,10 +149,10 @@ export class AccessibilityManager implements IDisposable {
     this._rowElements[this._rowElements.length - 1].addEventListener('focus', this._bottomBoundaryFocusListener);
 
     // Scroll up
-    this._terminal.scrollLines(position === BoundaryPosition.Top ? -1 : 1);
+    this._terminal.scrollLines(position === BoundaryPosition.TOP ? -1 : 1);
 
     // Focus new boundary before element
-    this._rowElements[position === BoundaryPosition.Top ? 1 : this._rowElements.length - 2].focus();
+    this._rowElements[position === BoundaryPosition.TOP ? 1 : this._rowElements.length - 2].focus();
 
     // Prevent the standard behavior
     e.preventDefault();

src/Parser.ts

@@ -150,7 +150,7 @@ csiStateHandler['s'] = (handler, params) => handler.saveCursor(params);
 csiStateHandler['u'] = (handler, params) => handler.restoreCursor(params);
 csiStateHandler[C0.CAN] = (handler, params, prefix, postfix, parser) => parser.setState(ParserState.NORMAL);
 
-export enum ParserState {
+export const enum ParserState {
   NORMAL = 0,
   ESCAPED = 1,
   CSI_PARAM = 2,

src/SelectionManager.ts

@@ -54,7 +54,7 @@ interface IWordPosition {
 /**
  * A selection mode, this drives how the selection behaves on mouse move.
  */
-enum SelectionMode {
+const enum SelectionMode {
   NORMAL,
   WORD,
   LINE

src/Types.ts

@@ -17,7 +17,7 @@ export type LineData = CharData[];
 export type LinkMatcherHandler = (event: MouseEvent, uri: string) => void;
 export type LinkMatcherValidationCallback = (uri: string, callback: (isValid: boolean) => void) => void;
 
-export enum LinkHoverEventTypes {
+export const enum LinkHoverEventTypes {
   HOVER = 'linkhover',
   TOOLTIP = 'linktooltip',
   LEAVE = 'linkleave'

src/handlers/AltClickHandler.ts

@@ -6,11 +6,11 @@
 import { ITerminal, ICircularList, LineData } from '../Types';
 import { C0 } from '../EscapeSequences';
 
-enum Direction {
-  Up = 'A',
-  Down = 'B',
-  Right = 'C',
-  Left = 'D'
+const enum Direction {
+  UP = 'A',
+  DOWN = 'B',
+  RIGHT = 'C',
+  LEFT = 'D'
 }
 
 export class AltClickHandler {
@@ -77,7 +77,7 @@ export class AltClickHandler {
     return repeat(this._bufferLine(
       this._startCol, this._startRow, this._startCol,
       this._startRow - this._wrappedRowsForRow(this._startRow), false
-    ).length, this._sequence(Direction.Left));
+    ).length, this._sequence(Direction.LEFT));
   }
 
   /**
@@ -109,7 +109,7 @@ export class AltClickHandler {
 
     return repeat(this._bufferLine(
       this._startCol, startRow, this._endCol, endRow,
-      direction === Direction.Right
+      direction === Direction.RIGHT
     ).length, this._sequence(direction));
   }
 
@@ -132,7 +132,7 @@ export class AltClickHandler {
     let endRow = this._endRow - this._wrappedRowsForRow(this._endRow);
 
     for (let i = 0; i < Math.abs(startRow - endRow); i++) {
-      let direction = this._verticalDirection() === Direction.Up ? -1 : 1;
+      let direction = this._verticalDirection() === Direction.UP ? -1 : 1;
 
       if ((<any>this._lines.get(startRow + (direction * i))).isWrapped) {
         wrappedRows++;
@@ -178,9 +178,9 @@ export class AltClickHandler {
       startRow <= this._endRow) || // down/right or same y/right
       (this._startCol >= this._endCol &&
       startRow < this._endRow)) {  // down/left or same y/left
-      return Direction.Right;
+      return Direction.RIGHT;
     }
-    return Direction.Left;
+    return Direction.LEFT;
   }
 
   /**
@@ -188,9 +188,9 @@ export class AltClickHandler {
    */
   private _verticalDirection(): Direction {
     if (this._startRow > this._endRow) {
-      return Direction.Up;
+      return Direction.UP;
     }
-    return Direction.Down;
+    return Direction.DOWN;
   }
 
   /**

src/renderer/Types.ts

@@ -10,7 +10,7 @@ import { IColorSet } from '../shared/Types';
 /**
  * Flags used to render terminal text properly.
  */
-export enum FLAGS {
+export const enum FLAGS {
   BOLD = 1,
   UNDERLINE = 2,
   BLINK = 4,

tslint.json

@@ -91,8 +91,15 @@
       "check-preblock"
     ],
 
+    "naming-convention": [
+      true,
+      {"type": "property", "modifiers": ["public", "static", "const"], "format": "UPPER_CASE"}
+    ],
     "no-else-after-return": {
       "options": "allow-else-if"
-    }
+    },
+    "prefer-const-enum": [
+      true
+    ]
   }
 }