Merge pull request #1421 from Tyriar/more_naming_conventions

Add remaining naming conventions into tslint

src/AccessibilityManager.ts

@@ -179,7 +179,7 @@ export class AccessibilityManager implements IDisposable {
     this._refreshRowsDimensions();
   }
 
-  public _createAccessibilityTreeNode(): HTMLElement {
+  private _createAccessibilityTreeNode(): HTMLElement {
     const element = document.createElement('div');
     element.setAttribute('role', 'listitem');
     element.tabIndex = -1;

src/Buffer.ts

@@ -338,9 +338,9 @@ export class Buffer implements IBuffer {
 }
 
 export class Marker extends EventEmitter implements IMarker {
-  private static NEXT_ID = 1;
+  private static _nextId = 1;
 
-  private _id: number = Marker.NEXT_ID++;
+  private _id: number = Marker._nextId++;
   public isDisposed: boolean = false;
   public disposables: IDisposable[] = [];
 

src/CharWidth.ts

@@ -121,7 +121,7 @@ export const wcwidth = (function(opts: {nul: number, control: number}): (ucs: nu
     }
     const control = opts.control | 0;
     let table: number[] | Uint32Array = null;
-    function init_table(): number[] | Uint32Array {
+    function initTable(): number[] | Uint32Array {
       // lookup table for BMP
       const CODEPOINTS = 65536;  // BMP holds 65536 codepoints
       const BITWIDTH = 2;        // a codepoint can have a width of 0, 1 or 2
@@ -161,7 +161,7 @@ export const wcwidth = (function(opts: {nul: number, control: number}): (ucs: nu
       if (num < 127) {
         return 1;
       }
-      const t = table || init_table();
+      const t = table || initTable();
       if (num < 65536) {
         return t[num >> 4] >> ((num & 15) << 1) & 3;
       }

src/EscapeSequenceParser.test.ts

@@ -169,12 +169,12 @@ describe('EscapeSequenceParser', function (): void {
       });
       it('constructor', function (): void {
         let p: EscapeSequenceParser = new EscapeSequenceParser();
-        chai.expect(p.transitions).equal(VT500_TRANSITION_TABLE);
+        chai.expect(p.TRANSITIONS).equal(VT500_TRANSITION_TABLE);
         p = new EscapeSequenceParser(VT500_TRANSITION_TABLE);
-        chai.expect(p.transitions).equal(VT500_TRANSITION_TABLE);
+        chai.expect(p.TRANSITIONS).equal(VT500_TRANSITION_TABLE);
         const tansitions: TransitionTable = new TransitionTable(10);
         p = new EscapeSequenceParser(tansitions);
-        chai.expect(p.transitions).equal(tansitions);
+        chai.expect(p.TRANSITIONS).equal(tansitions);
       });
       it('inital states', function (): void {
         chai.expect(parser.initialState).equal(ParserState.GROUND);

src/EscapeSequenceParser.ts

@@ -235,7 +235,7 @@ export class EscapeSequenceParser implements IEscapeSequenceParser {
   protected _dcsHandlerFb: IDcsHandler;
   protected _errorHandlerFb: (state: IParsingState) => IParsingState;
 
-  constructor(readonly transitions: TransitionTable = VT500_TRANSITION_TABLE) {
+  constructor(readonly TRANSITIONS: TransitionTable = VT500_TRANSITION_TABLE) {
     this.initialState = ParserState.GROUND;
     this.currentState = this.initialState;
     this._osc = '';
@@ -342,7 +342,7 @@ export class EscapeSequenceParser implements IEscapeSequenceParser {
     let osc = this._osc;
     let collect = this._collect;
     let params = this._params;
-    const table: Uint8Array | number[] = this.transitions.table;
+    const table: Uint8Array | number[] = this.TRANSITIONS.table;
     let dcsHandler: IDcsHandler | null = this._activeDcsHandler;
     let callback: Function | null = null;
 

src/InputHandler.ts

@@ -163,12 +163,12 @@ export class InputHandler implements IInputHandler {
     this._parser.setCsiHandler('X', (params, collect) => this.eraseChars(params));
     this._parser.setCsiHandler('Z', (params, collect) => this.cursorBackwardTab(params));
     this._parser.setCsiHandler('`', (params, collect) => this.charPosAbsolute(params));
-    this._parser.setCsiHandler('a', (params, collect) => this.HPositionRelative(params));
+    this._parser.setCsiHandler('a', (params, collect) => this.hPositionRelative(params));
     this._parser.setCsiHandler('b', (params, collect) => this.repeatPrecedingCharacter(params));
     this._parser.setCsiHandler('c', (params, collect) => this.sendDeviceAttributes(params, collect));
     this._parser.setCsiHandler('d', (params, collect) => this.linePosAbsolute(params));
-    this._parser.setCsiHandler('e', (params, collect) => this.VPositionRelative(params));
-    this._parser.setCsiHandler('f', (params, collect) => this.HVPosition(params));
+    this._parser.setCsiHandler('e', (params, collect) => this.vPositionRelative(params));
+    this._parser.setCsiHandler('f', (params, collect) => this.hVPosition(params));
     this._parser.setCsiHandler('g', (params, collect) => this.tabClear(params));
     this._parser.setCsiHandler('h', (params, collect) => this.setMode(params, collect));
     this._parser.setCsiHandler('l', (params, collect) => this.resetMode(params, collect));
@@ -949,7 +949,7 @@ export class InputHandler implements IInputHandler {
    *   [columns] (default = [row,col+1]) (HPR)
    * reuse CSI Ps C ?
    */
-  public HPositionRelative(params: number[]): void {
+  public hPositionRelative(params: number[]): void {
     let param = params[0];
     if (param < 1) {
       param = 1;
@@ -1063,7 +1063,7 @@ export class InputHandler implements IInputHandler {
    *   [rows] (default = [row+1,column])
    * reuse CSI Ps B ?
    */
-  public VPositionRelative(params: number[]): void {
+  public vPositionRelative(params: number[]): void {
     let param = params[0];
     if (param < 1) {
       param = 1;
@@ -1083,7 +1083,7 @@ export class InputHandler implements IInputHandler {
    *   Horizontal and Vertical Position [row;column] (default =
    *   [1,1]) (HVP).
    */
-  public HVPosition(params: number[]): void {
+  public hVPosition(params: number[]): void {
     if (params[0] < 1) params[0] = 1;
     if (params[1] < 1) params[1] = 1;
 

src/Linkifier.test.ts

@@ -11,9 +11,9 @@ import { MockBuffer, MockTerminal } from './utils/TestUtils.test';
 import { CircularList } from './utils/CircularList';
 
 class TestLinkifier extends Linkifier {
-  constructor(_terminal: ITerminal) {
-    super(_terminal);
-    Linkifier.TIME_BEFORE_LINKIFY = 0;
+  constructor(terminal: ITerminal) {
+    super(terminal);
+    (<any>Linkifier).TIME_BEFORE_LINKIFY = 0;
   }
 
   public get linkMatchers(): ILinkMatcher[] { return this._linkMatchers; }

src/Linkifier.ts

@@ -17,7 +17,7 @@ export class Linkifier extends EventEmitter implements ILinkifier {
    * the costly operation of searching every row multiple times, potentially a
    * huge amount of times.
    */
-  protected static TIME_BEFORE_LINKIFY = 200;
+  protected static readonly TIME_BEFORE_LINKIFY = 200;
 
   protected _linkMatchers: ILinkMatcher[] = [];
 

src/Parser.ts

@@ -124,12 +124,12 @@ csiStateHandler['T'] = (handler, params, prefix) => {
 csiStateHandler['X'] = (handler, params, prefix) => handler.eraseChars(params);
 csiStateHandler['Z'] = (handler, params, prefix) => handler.cursorBackwardTab(params);
 csiStateHandler['`'] = (handler, params, prefix) => handler.charPosAbsolute(params);
-csiStateHandler['a'] = (handler, params, prefix) => handler.HPositionRelative(params);
+csiStateHandler['a'] = (handler, params, prefix) => handler.hPositionRelative(params);
 csiStateHandler['b'] = (handler, params, prefix) => handler.repeatPrecedingCharacter(params);
 csiStateHandler['c'] = (handler, params, prefix) => handler.sendDeviceAttributes(params);
 csiStateHandler['d'] = (handler, params, prefix) => handler.linePosAbsolute(params);
-csiStateHandler['e'] = (handler, params, prefix) => handler.VPositionRelative(params);
-csiStateHandler['f'] = (handler, params, prefix) => handler.HVPosition(params);
+csiStateHandler['e'] = (handler, params, prefix) => handler.vPositionRelative(params);
+csiStateHandler['f'] = (handler, params, prefix) => handler.hVPosition(params);
 csiStateHandler['g'] = (handler, params, prefix) => handler.tabClear(params);
 csiStateHandler['h'] = (handler, params, prefix) => handler.setMode(params);
 csiStateHandler['l'] = (handler, params, prefix) => handler.resetMode(params);

src/Terminal.integration.ts

@@ -79,23 +79,23 @@ function terminalToString(term: Terminal): string {
 
 // Skip tests on Windows since pty.open isn't supported
 if (os.platform() !== 'win32') {
-  const CONSOLE_LOG = console.log;
+  const consoleLog = console.log;
 
   // expect files need terminal at 80x25!
-  const COLS = 80;
-  const ROWS = 25;
+  const cols = 80;
+  const rows = 25;
 
   /** some helpers for pty interaction */
   // we need a pty in between to get the termios decorations
   // for the basic test cases a raw pty device is enough
-  primitivePty = pty.native.open(COLS, ROWS);
+  primitivePty = pty.native.open(cols, rows);
 
   /** tests */
   describe('xterm output comparison', () => {
     let xterm: TestTerminal;
 
     beforeEach(() => {
-      xterm = new TestTerminal({ cols: COLS, rows: ROWS });
+      xterm = new TestTerminal({ cols: cols, rows: rows });
       xterm.refresh = () => {};
       xterm.viewport = <IViewport>{
         syncScrollArea: () => {}
@@ -133,8 +133,9 @@ if (os.platform() !== 'win32') {
               xterm.innerWrite();
 
               const fromEmulator = terminalToString(xterm);
-              console.log = CONSOLE_LOG;
+              console.log = consoleLog;
               const expected = fs.readFileSync(filename.split('.')[0] + '.text', 'utf8');
+
               // Some of the tests have whitespace on the right of lines, we trim all the linex
               // from xterm.js so ignore this for now at least.
               const expectedRightTrimmed = expected.split('\n').map(l => l.replace(/\s+$/, '')).join('\n');

src/Terminal.ts

@@ -2204,7 +2204,42 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
 
   // TODO: Remove when true color is implemented
   public matchColor(r1: number, g1: number, b1: number): number {
-    return matchColor_(r1, g1, b1);
+    const hash = (r1 << 16) | (g1 << 8) | b1;
+
+    if (matchColorCache[hash] != null) {
+      return matchColorCache[hash];
+    }
+
+    let ldiff = Infinity;
+    let li = -1;
+    let i = 0;
+    let c: number;
+    let r2: number;
+    let g2: number;
+    let b2: number;
+    let diff: number;
+
+    for (; i < DEFAULT_ANSI_COLORS.length; i++) {
+      c = DEFAULT_ANSI_COLORS[i].rgba;
+      r2 = c >>> 24;
+      g2 = c >>> 16 & 0xFF;
+      b2 = c >>> 8 & 0xFF;
+      // assume that alpha is 0xFF
+
+      diff = matchColorDistance(r1, g1, b1, r2, g2, b2);
+
+      if (diff === 0) {
+        li = i;
+        break;
+      }
+
+      if (diff < ldiff) {
+        ldiff = diff;
+        li = i;
+      }
+    }
+
+    return matchColorCache[hash] = li;
   }
 
   private _visualBell(): boolean {
@@ -2260,43 +2295,3 @@ function matchColorDistance(r1: number, g1: number, b1: number, r2: number, g2:
     + Math.pow(59 * (g1 - g2), 2)
     + Math.pow(11 * (b1 - b2), 2);
 }
-
-
-function matchColor_(r1: number, g1: number, b1: number): number {
-  const hash = (r1 << 16) | (g1 << 8) | b1;
-
-  if (matchColorCache[hash] != null) {
-    return matchColorCache[hash];
-  }
-
-  let ldiff = Infinity;
-  let li = -1;
-  let i = 0;
-  let c: number;
-  let r2: number;
-  let g2: number;
-  let b2: number;
-  let diff: number;
-
-  for (; i < DEFAULT_ANSI_COLORS.length; i++) {
-    c = DEFAULT_ANSI_COLORS[i].rgba;
-    r2 = c >>> 24;
-    g2 = c >>> 16 & 0xFF;
-    b2 = c >>> 8 & 0xFF;
-    // assume that alpha is 0xFF
-
-    diff = matchColorDistance(r1, g1, b1, r2, g2, b2);
-
-    if (diff === 0) {
-      li = i;
-      break;
-    }
-
-    if (diff < ldiff) {
-      ldiff = diff;
-      li = i;
-    }
-  }
-
-  return matchColorCache[hash] = li;
-}

src/Types.ts

@@ -138,12 +138,12 @@ export interface IInputHandler {
   /** CSI X */ eraseChars(params?: number[]): void;
   /** CSI Z */ cursorBackwardTab(params?: number[]): void;
   /** CSI ` */ charPosAbsolute(params?: number[]): void;
-  /** CSI a */ HPositionRelative(params?: number[]): void;
+  /** CSI a */ hPositionRelative(params?: number[]): void;
   /** CSI b */ repeatPrecedingCharacter(params?: number[]): void;
   /** CSI c */ sendDeviceAttributes(params?: number[], collect?: string): void;
   /** CSI d */ linePosAbsolute(params?: number[]): void;
-  /** CSI e */ VPositionRelative(params?: number[]): void;
-  /** CSI f */ HVPosition(params?: number[]): void;
+  /** CSI e */ vPositionRelative(params?: number[]): void;
+  /** CSI f */ hVPosition(params?: number[]): void;
   /** CSI g */ tabClear(params?: number[]): void;
   /** CSI h */ setMode(params?: number[], collect?: string): void;
   /** CSI l */ resetMode(params?: number[], collect?: string): void;

src/addons/zmodem/zmodem.ts

@@ -46,13 +46,13 @@ function zmodemAttach(ws: WebSocket, opts: IZmodemOptions = {}): void {
 
   let zsentry;
 
-  function _shouldWrite(): boolean {
+  function shouldWrite(): boolean {
     return !!zsentry.get_confirmed_session() || !opts.noTerminalWriteOutsideSession;
   }
 
   zsentry = new zmodem.Sentry({
     to_terminal: (octets: ArrayLike<number>) => {
-      if (_shouldWrite()) {
+      if (shouldWrite()) {
         term.write(
           String.fromCharCode.apply(String, octets)
         );
@@ -70,7 +70,7 @@ function zmodemAttach(ws: WebSocket, opts: IZmodemOptions = {}): void {
     // may be specific to xterm.js’s demo, ultimately we
     // should reject anything that isn’t binary.
     if (typeof evt.data === 'string') {
-      if (_shouldWrite()) {
+      if (shouldWrite()) {
         term.write(evt.data);
       }
     }

src/renderer/atlas/StaticCharAtlas.ts

@@ -26,7 +26,7 @@ export default class StaticCharAtlas extends BaseCharAtlas {
     return canvas;
   }
 
-  public _doWarmUp(): void {
+  protected _doWarmUp(): void {
     const result = generateStaticCharAtlasTexture(window, this._canvasFactory, this._config);
     if (result instanceof HTMLCanvasElement) {
       this._texture = result;

tslint.json

@@ -94,7 +94,16 @@
 
     "naming-convention": [
       true,
-      {"type": "property", "modifiers": ["public", "static", "const"], "format": "UPPER_CASE"}
+      {"type": "default", "format": "camelCase", "leadingUnderscore": "forbid"},
+      {"type": "type", "format": "PascalCase"},
+      {"type": "class", "format": "PascalCase"},
+      {"type": "property", "modifiers": ["const"], "format": "UPPER_CASE"},
+      {"type": "member", "modifiers": ["protected"], "format": "camelCase", "leadingUnderscore": "allow"},
+      // TODO: Change allow to require when there aren't many PRs out
+      // {"type": "member", "modifiers": ["protected"], "format": "camelCase", "leadingUnderscore": "require"},
+      {"type": "member", "modifiers": ["private"], "format": "camelCase", "leadingUnderscore": "require"},
+      {"type": "variable", "modifiers": ["const"], "format": ["camelCase", "UPPER_CASE"]},
+      {"type": "interface", "prefix": "I"}
     ],
     "no-else-after-return": {
       "options": "allow-else-if"