typescript hygiene

Author: ole1986

src/adapter/avatar/github.ts

@@ -85,19 +85,20 @@ export class GithubAvatarProvider extends BaseAvatarProvider implements IAvatarP
     }
     protected async getAvatarsImplementation(repository: IGitService): Promise<Avatar[]> {
         const remoteUrl = await repository.getOriginUrl();
-        const remoteRepoPath = remoteUrl.replace(/.*?github.com\//,'');
+        const remoteRepoPath = remoteUrl.replace(/.*?github.com\//, '');
         const remoteRepoWithNoGitSuffix = remoteRepoPath.replace(/\.git\/?$/, '');
         const contributors = await this.getContributors(remoteRepoWithNoGitSuffix);
 
         const githubUsers = await Promise.all(contributors.map(async user => {
-            const u = await this.getUserByLogin(user.login);
-            return u;
+            return await this.getUserByLogin(user.login);
         }));
 
         let avatars : Avatar[] = [];
 
         githubUsers.forEach(user => {
-            if(!user) return;
+            if (!user) {
+                return;
+            }
             avatars.push({
                 login: user.login,
                 name: user.name,
@@ -111,15 +112,15 @@ export class GithubAvatarProvider extends BaseAvatarProvider implements IAvatarP
     }
     /**
      * Fetch the user details through Github API
-     * @param loginName
+     * @param loginName the user login name from github
      */
     private async getUserByLogin(loginName: string) {
         const key = `GitHub:User:${loginName}`;
 
         const cachedUser = await this.stateStore.get<GithubUserResponse>(key);
         let headers = {};
 
-        if(cachedUser) {
+        if (cachedUser) {
             // Use GitHub API with conditional check on last modified
             // to avoid API request rate limitation
             headers = {'If-Modified-Since': cachedUser.last_modified};
@@ -138,8 +139,8 @@ export class GithubAvatarProvider extends BaseAvatarProvider implements IAvatarP
                 // can either be '302 Not Modified' or any other error
                 // in case of '302 Not Modified' this API request is not counted and returns nothing
             });
-        
-        if(info) {
+
+        if (info) {
             await this.stateStore.set(key, info);
             return info;
         } else {
@@ -153,10 +154,9 @@ export class GithubAvatarProvider extends BaseAvatarProvider implements IAvatarP
      */
     private async getContributors(repoPath: string) {
         const proxy = this.proxy;
-        const info = await axios.get(`https://api.github.com/repos/${repoPath}/contributors`, { proxy })
+        return axios.get(`https://api.github.com/repos/${repoPath}/contributors`, { proxy })
             .then((result: { data: GithubUserSearchResponseItem[] }) => {
                 return result.data;
             });
-        return info;
     }
 }

src/adapter/avatar/gravatar.ts

@@ -21,7 +21,7 @@ export class GravatarAvatarProvider extends BaseAvatarProvider implements IAvata
                 avatarUrl: gravatar.url(user.email),
                 name: user.name,
                 email: user.email
-            }
+            };
         });
     }
 }

src/adapter/exec/gitCommandExec.ts

@@ -3,19 +3,18 @@ import * as iconv from 'iconv-lite';
 import { injectable, multiInject } from 'inversify';
 import { Writable } from 'stream';
 import { Disposable, extensions } from 'vscode';
+import { IGitCommandExecutor } from './types';
 import { GitExtension } from '../repository/git.d';
 import { StopWatch } from '../../common/stopWatch';
 import { ILogService } from '../../common/types';
-import { IGitCommandExecutor } from './types';
-
 
 const DEFAULT_ENCODING = 'utf8';
 const isWindows = /^win/.test(process.platform);
 
 @injectable()
 export class GitCommandExecutor implements IGitCommandExecutor {
-    public gitExtension : GitExtension;
-    private gitExecutablePath : string;
+    public gitExtension: GitExtension;
+    private gitExecutablePath: string;
 
     constructor(@multiInject(ILogService) private loggers: ILogService[]) {
         this.gitExtension = extensions.getExtension<GitExtension>('vscode.git')!.exports;
@@ -36,7 +35,7 @@ export class GitCommandExecutor implements IGitCommandExecutor {
             childProcOptions.encoding = DEFAULT_ENCODING;
         }
         const binaryOuput = childProcOptions.encoding === 'binary';
-        const destination: Writable = binaryOuput ? args.shift()! : undefined;
+        const destination: Writable = binaryOuput ? args.shift() : undefined;
         const gitPathCommand = childProcOptions.shell && gitPath.indexOf(' ') > 0 ? `"${gitPath}"` : gitPath;
         const stopWatch = new StopWatch();
         const gitShow = spawn(gitPathCommand, args, childProcOptions);

src/adapter/parsers/fileStat/parser.ts

@@ -10,7 +10,7 @@ export class FileStatParser implements IFileStatParser {
     constructor( @inject(IServiceContainer) private serviceContainer: IServiceContainer) {
     }
 
-    private static parseFileMovement(fileInfo: string): { original: string, current: string } | undefined {
+    private static parseFileMovement(fileInfo: string): { original: string; current: string } | undefined {
         // src/client/{common/comms => }/Socket Stream.ts
         // src/client/common/{space in folder => comms}/id Dispenser.ts
         // src/client/common/space in folder/{idDispenser.ts => id Dispenser.ts}
@@ -67,13 +67,11 @@ export class FileStatParser implements IFileStatParser {
 
     /**
      * Parses a line containing file information returned by `git log --name-stat` and returns just the file names
-     * @private
-     * @static
      * @param {string} line
      * @returns {({ original?: string, current: string } | undefined)}
      * @memberof FileStatParser
      */
-    private static getNewAndOldFileNameFromNumStatLine(line: string, status: Status): { original?: string, current: string } | undefined {
+    private static getNewAndOldFileNameFromNumStatLine(line: string, status: Status): { original?: string; current: string } | undefined {
         const statusParts = line.split('\t');
         const fileName = statusParts[1].trim();
         if (status === Status.Renamed || status === Status.Copied) {
@@ -84,8 +82,6 @@ export class FileStatParser implements IFileStatParser {
 
     /**
      * Parses a line containing file information returned by `git log --numstat`
-     * @private
-     * @static
      * @param {string} line
      * @returns {({ additions?: number, deletions?: number } | undefined)}
      * @memberof FileStatParser
@@ -108,8 +104,7 @@ export class FileStatParser implements IFileStatParser {
      * Parsers the file status
      * @param {string[]} filesWithNumStat Files returned using `git log --numstat`
      * @param {string[]} filesWithNameStat Files returned using `git log --name-status`
-     * @returns {CommittedFile[]}
-     * @memberof FileStatParser
+     * @returns {CommittedFile[]} An array of committed files
      */
     public parse(gitRootPath: string, filesWithNumStat: string[], filesWithNameStat: string[]): CommittedFile[] {
         return filesWithNameStat.map((line, index) => {
@@ -142,7 +137,6 @@ export class FileStatParser implements IFileStatParser {
                 uri: Uri.file(path.join(gitRootPath, relativePath)),
                 oldUri
             };
-           
             // uri.fsPath getter sporadically becomes a slash as prefix (E.g  "/z:/folder/subfolder").
             // By fetching fsPath through the getter, the internal method _makeFsPath(this) immediate get called here
             // and the fsPath is set correctly.

src/adapter/parsers/refs/parser.ts

@@ -18,9 +18,8 @@ export class RefsParser implements IRefsParser {
      * git branch --all (only considers)
      * git show-refs
      * git log --format=%D
-     * @param {string} refContent
-     * @returns {Ref[]}
-     * @memberof RefParser
+     * @param {string} refContent the ref content as string to be parsed
+     * @returns {Ref[]} A reference which can either be a branch, tag or origin
      */
     public parse(refContent: string): Ref[] {
         return (refContent || '').split(',')

src/adapter/repository/git.d.ts

@@ -240,4 +240,4 @@ export const enum GitErrorCodes {
     PatchDoesNotApply = 'PatchDoesNotApply',
     NoPathFound = 'NoPathFound',
     UnknownPath = 'UnknownPath',
-}
+}

src/adapter/repository/git.ts

@@ -172,7 +172,7 @@ export class Git implements IGitService {
         } else if (url.indexOf('visualstudio') > 0) {
             return GitOriginType.vsts;
         }
-        
+
         return undefined;
     }
     @cache('IGitService')
@@ -397,8 +397,8 @@ export class Git implements IGitService {
         const hashes = output.split(/\r?\n/g).filter(item => item.length > 0)[0].split('-');
 
         return {
-            short: hashes[1]!,
-            full: hashes[0]!
+            short: hashes[1],
+            full: hashes[0]
         };
     }
 

src/adapter/repository/types.ts

@@ -33,5 +33,5 @@ export enum GitOriginType {
     github = 2,
     bitbucket = 3,
     tfs = 4,
-    vsts = 5,
+    vsts = 5
 }

src/application/stateStore.ts

@@ -3,6 +3,19 @@ import { Memento } from 'vscode';
 import { IServiceContainer } from '../ioc/types';
 import { IStateStore, IStateStoreFactory } from './types/stateStore';
 
+export class WorkspaceMementoStore implements IStateStore {
+    constructor(private store: Memento) { }
+    public has(key: string): boolean {
+        return this.store.get(key) !== undefined;
+    }
+    public async set<T>(key: string, data: T): Promise<void> {
+        await this.store.update(key, data);
+    }
+    public async get<T>(key: string): Promise<T | undefined> {
+        return this.store.get(key);
+    }
+}
+
 @injectable()
 export class WorkspaceStateStoreFactory implements IStateStoreFactory {
     constructor( @inject(IServiceContainer) private serviceContainer: IServiceContainer) { }
@@ -20,16 +33,3 @@ export class GlobalStateStoreFactory implements IStateStoreFactory {
         return new WorkspaceMementoStore(this.serviceContainer.get<Memento>('globalMementoStore'));
     }
 }
-
-export class WorkspaceMementoStore implements IStateStore {
-    constructor(private store: Memento) { }
-    public has(key: string): boolean {
-        return this.store.get(key) !== undefined;
-    }
-    public async set<T>(key: string, data: T): Promise<void> {
-        await this.store.update(key, data);
-    }
-    public async get<T>(key: string): Promise<T | undefined> {
-        return this.store.get(key);
-    }
-}

src/commandHandlers/commit/compare.ts

@@ -37,7 +37,7 @@ export class GitCompareCommitCommandHandler implements IGitCompareCommandHandler
         // display explorer view when running compare
         await this.commandManager.executeCommand('workbench.view.explorer');
         const gitService = await this.serviceContainer.get<IGitServiceFactory>(IGitServiceFactory).createGitService(commit.workspaceFolder, commit.logEntry.gitRoot);
-        const fileDiffs = await gitService.getDifferences(this.selectedCommit!.logEntry.hash.full, commit.logEntry.hash.full);
+        const fileDiffs = await gitService.getDifferences(this.selectedCommit.logEntry.hash.full, commit.logEntry.hash.full);
         const compareCommit = new CompareCommitDetails(this.selectedCommit, commit, fileDiffs);
         this.commitViewerFactory.getCompareCommitViewer().showCommitTree(compareCommit);
     }