PR feedback to clarify code

pgonzal · pgonzal · commit a092989578e1 · 2018-06-21T18:58:15.000-07:00
diff --git a/libraries/rushell/src/Tokenizer.ts b/libraries/rushell/src/Tokenizer.ts
@@ -199,7 +199,7 @@ export class Tokenizer {
 
     // Is it the "&&" token?
     if (firstChar === '&') {
-      if (this._peek2() === '&') {
+      if (this._peekTwice() === '&') {
         this._get();
         this._get();
         return new Token(TokenKind.AndIf, input.getNewRange(startIndex, this._currentIndex));
@@ -221,21 +221,33 @@ export class Tokenizer {
     return tokens;
   }
 
+  /**
+   * Retrieve the next character in the input stream.
+   * @returns a string of length 1, or undefined if the end of input is reached
+   */
   private _get(): string | undefined {
     if (this._currentIndex >= this.input.end) {
       return undefined;
     }
     return this.input.buffer[this._currentIndex++];
   }
 
+  /**
+   * Return the next character in the input stream, but don't advance the stream pointer.
+   * @returns a string of length 1, or undefined if the end of input is reached
+   */
   private _peek(): string | undefined {
     if (this._currentIndex >= this.input.end) {
       return undefined;
     }
     return this.input.buffer[this._currentIndex];
   }
 
-  private _peek2(): string | undefined {
+  /**
+   * Return the character after the next character in the input stream, but don't advance the stream pointer.
+   * @returns a string of length 1, or undefined if the end of input is reached
+   */
+  private _peekTwice(): string | undefined {
     if (this._currentIndex + 1 >= this.input.end) {
       return undefined;
     }
diff --git a/libraries/rushell/src/test/Tokenizer.test.ts b/libraries/rushell/src/test/Tokenizer.test.ts
@@ -18,12 +18,12 @@ function tokenize(input: string): Token[] {
 function matchSnapshot(input: string): void {
   const tokenizer: Tokenizer = new Tokenizer(input);
 
-  const reportedTokens = tokenizer.getTokens().map(
+  const reportedTokens: { kind: string, value: string }[] = tokenizer.getTokens().map(
     token => {
       return {
         kind: TokenKind[token.kind],
         value: escape(token.toString())
-      }
+      };
     }
   );
 
