Migrate from TSLint to ESlint

- Removed TSLint and tslint.json configuration file
- Added ESLint with `recommended` TypeScript configurations.
- Removed all `I` prefix from type declarations (per ESLint recommendation)
- Have added return types to all function declarations (per ESLint
  recommendation)
- To have minimal conflict with integration, many of the recommended ESLint
  rules have been disabled on a per-page/line basis.
  - We should attempt to remove these `/* eslint-disable ...` lines as we
    refactor code and conform completely to the recommended linting rules.

Author: evanlouie

Diff for: .eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ]
+};

Diff for: package.json

@@ -8,9 +8,9 @@
   "scripts": {
     "build": "shx rm -rf dist && webpack && pkg -t node12-linux-x64,node12-macos-x64,node12-win-x64 dist/spk.js && shx mv spk-{linux,macos,win.exe} dist",
     "build-cmd-docs": "ts-node tools/generateDoc.ts",
-    "lint": "tslint 'src/**/*.ts{,x}'",
+    "lint": "eslint 'src/**/*.ts{,x}'",
     "lint-fix": "tslint --fix 'src/**/*.ts{,x}'",
-    "test": "jest --reporters=jest-junit --reporters=default --coverage --coverageReporters=cobertura --coverageReporters=html",
+    "test": "jest --rootDir src --reporters=jest-junit --reporters=default --coverage --coverageReporters=cobertura --coverageReporters=html",
     "test-watch": "jest --watchAll",
     "postinstall": "cd node_modules/azure-devops-node-api && git apply ../../patches/001-azure-devops-node.patch || true",
     "test-coverage-html": "jest --coverage --coverageReporters=html"
@@ -29,6 +29,9 @@
     "@types/node-emoji": "^1.8.1",
     "@types/shelljs": "^0.8.5",
     "@types/uuid": "^3.4.5",
+    "@typescript-eslint/eslint-plugin": "^2.23.0",
+    "@typescript-eslint/parser": "^2.23.0",
+    "eslint": "^6.8.0",
     "husky": ">=1",
     "jest": "^24.9.0",
     "jest-junit": "^9.0.0",
@@ -42,7 +45,6 @@
     "ts-jest": "^24.2.0",
     "ts-loader": "^6.2.1",
     "ts-node": "^8.5.4",
-    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.7.4",
     "url-loader": "^3.0.0",

Diff for: src/commands/command.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-use-before-define */
 import commander from "commander";
 import { enableVerboseLogging, logger } from "../logger";
 
@@ -9,11 +10,11 @@ import { enableVerboseLogging, logger } from "../logger";
  * Warning: Avoid implementing this interface directly; use Command() function
  * to generate concrete implementations.
  */
-interface ICommand {
+interface Command {
   name: string;
   description: string;
   command: commander.Command;
-  subCommands: ICommand[];
+  subCommands: Command[];
 }
 
 /**
@@ -39,8 +40,8 @@ export const Command = (
   name: string,
   description: string,
   decorators: Array<(c: commander.Command) => void> = [],
-  subCommands: ICommand[] = []
-): ICommand => {
+  subCommands: Command[] = []
+): Command => {
   // Initialize default command
   const cmd = new commander.Command();
   cmd
@@ -95,7 +96,7 @@ const decrementArgv = (argv: string[]): string[] => {
  * @param cmd ICommand object to execute against
  * @param argv Array of arguments, flags *must* come at the end (limitation of using git-style sub-commands)
  */
-export const executeCommand = (cmd: ICommand, argv: string[]): void => {
+export const executeCommand = (cmd: Command, argv: string[]): void => {
   const targetCommandName = argv.slice(2, 3)[0];
   const targetCommand = cmd.subCommands.find(
     sc => sc.name === targetCommandName
@@ -129,7 +130,7 @@ export const executeCommand = (cmd: ICommand, argv: string[]): void => {
  *
  * @param c ICommand object to prepare
  */
-const linkSubCommands = (c: ICommand): ICommand => {
+const linkSubCommands = (c: Command): Command => {
   const { command, subCommands } = c;
   // Add all sub-commands
   for (const subCommand of subCommands) {

Diff for: src/commands/deployment/create.test.ts

@@ -2,7 +2,7 @@ import uuid = require("uuid");
 import * as azure from "../../lib/azure/deploymenttable";
 import { deepClone } from "../../lib/util";
 import { disableVerboseLogging, enableVerboseLogging } from "../../logger";
-import { execute, ICommandOptions } from "./create";
+import { execute, CommandOptions } from "./create";
 
 beforeAll(() => {
   enableVerboseLogging();
@@ -12,7 +12,7 @@ afterAll(() => {
   disableVerboseLogging();
 });
 
-const MOCKED_VALS: ICommandOptions = {
+const MOCKED_VALS: CommandOptions = {
   accessKey: undefined,
   commitId: undefined,
   env: undefined,
@@ -30,7 +30,7 @@ const MOCKED_VALS: ICommandOptions = {
   tableName: undefined
 };
 
-const getMockedValues = (withKeyValue = false): ICommandOptions => {
+const getMockedValues = (withKeyValue = false): CommandOptions => {
   const vals = deepClone(MOCKED_VALS);
 
   if (withKeyValue) {

Diff for: src/commands/deployment/create.ts

@@ -1,7 +1,8 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 import commander from "commander";
 import {
   addSrcToACRPipeline,
-  IDeploymentTable,
+  DeploymentTable,
   updateACRToHLDPipeline,
   updateHLDToManifestPipeline,
   updateManifestCommitId
@@ -14,7 +15,7 @@ import decorator from "./create.decorator.json";
 /**
  * Command Line values from the commander
  */
-export interface ICommandOptions {
+export interface CommandOptions {
   accessKey: string | undefined;
   commitId: string | undefined;
   env: string | undefined;
@@ -37,7 +38,7 @@ export interface ICommandOptions {
  *
  * @param opts values from commander
  */
-export const validateValues = (opts: ICommandOptions) => {
+export const validateValues = (opts: CommandOptions): void => {
   if (
     !hasValue(opts.accessKey) ||
     !hasValue(opts.name) ||
@@ -51,9 +52,9 @@ export const validateValues = (opts: ICommandOptions) => {
 };
 
 export const handlePipeline1 = async (
-  tableInfo: IDeploymentTable,
-  opts: ICommandOptions
-) => {
+  tableInfo: DeploymentTable,
+  opts: CommandOptions
+): Promise<void> => {
   if (
     !hasValue(opts.imageTag) ||
     !hasValue(opts.commitId) ||
@@ -74,9 +75,9 @@ export const handlePipeline1 = async (
 };
 
 export const handlePipeline2 = async (
-  tableInfo: IDeploymentTable,
-  opts: ICommandOptions
-) => {
+  tableInfo: DeploymentTable,
+  opts: CommandOptions
+): Promise<void> => {
   if (
     !hasValue(opts.hldCommitId) ||
     !hasValue(opts.env) ||
@@ -105,13 +106,13 @@ export const handlePipeline2 = async (
  * @param exitFn exit function
  */
 export const execute = async (
-  opts: ICommandOptions,
+  opts: CommandOptions,
   exitFn: (status: number) => Promise<void>
-) => {
+): Promise<void> => {
   try {
     validateValues(opts);
 
-    const tableInfo: IDeploymentTable = {
+    const tableInfo: DeploymentTable = {
       accountKey: opts.accessKey!,
       accountName: opts.name!,
       partitionKey: opts.partitionKey!,
@@ -153,7 +154,7 @@ export const execute = async (
  * @param command
  */
 export const commandDecorator = (command: commander.Command): void => {
-  buildCmd(command, decorator).action(async (opts: ICommandOptions) => {
+  buildCmd(command, decorator).action(async (opts: CommandOptions) => {
     await execute(opts, async (status: number) => {
       await exitCmd(logger, process.exit, status);
     });

Diff for: src/commands/deployment/dashboard.test.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable @typescript-eslint/camelcase */
 jest.mock("open");
 import open from "open";
 jest.mock("../../config");
@@ -28,7 +30,7 @@ afterAll(() => {
   disableVerboseLogging();
 });
 
-const mockConfig = () => {
+const mockConfig = (): void => {
   (Config as jest.Mock).mockReturnValueOnce({
     azure_devops: {
       access_token: uuid(),

Diff for: src/commands/deployment/dashboard.ts

@@ -1,3 +1,6 @@
+/* eslint-disable @typescript-eslint/camelcase */
+/* eslint-disable @typescript-eslint/no-use-before-define */
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
 import commander from "commander";
 import GitUrlParse from "git-url-parse";
 import open = require("open");
@@ -7,18 +10,18 @@ import { getRepositoryName } from "../../lib/gitutils";
 import { exec } from "../../lib/shell";
 import { isPortNumberString, validatePrereqs } from "../../lib/validator";
 import { logger } from "../../logger";
-import { IConfigYaml } from "../../types";
+import { ConfigYaml } from "../../types";
 import decorator from "./dashboard.decorator.json";
 
-export interface IIntrospectionManifest {
+export interface IntrospectionManifest {
   githubUsername?: string;
   manifestRepoName: string;
 }
 
 /**
  * Command line option values from commander
  */
-export interface ICommandOptions {
+export interface CommandOptions {
   port: string;
   removeAll: boolean;
 }
@@ -29,7 +32,10 @@ export interface ICommandOptions {
  * @param config SPK Configuration
  * @param opts Command Line option values
  */
-export const validateValues = (config: IConfigYaml, opts: ICommandOptions) => {
+export const validateValues = (
+  config: ConfigYaml,
+  opts: CommandOptions
+): void => {
   if (opts.port) {
     if (!isPortNumberString(opts.port)) {
       throw new Error("value for port option has to be a valid port number");
@@ -61,9 +67,9 @@ export const validateValues = (config: IConfigYaml, opts: ICommandOptions) => {
  * @param exitFn exit function
  */
 export const execute = async (
-  opts: ICommandOptions,
+  opts: CommandOptions,
   exitFn: (status: number) => Promise<void>
-) => {
+): Promise<void> => {
   try {
     const config = Config();
     validateValues(config, opts);
@@ -84,7 +90,7 @@ export const execute = async (
  * @param command Commander command object to decorate
  */
 export const commandDecorator = (command: commander.Command): void => {
-  buildCmd(command, decorator).action(async (opts: ICommandOptions) => {
+  buildCmd(command, decorator).action(async (opts: CommandOptions) => {
     await execute(opts, async (status: number) => {
       await exitCmd(logger, process.exit, status);
     });
@@ -94,7 +100,9 @@ export const commandDecorator = (command: commander.Command): void => {
 /**
  * Cleans previously launched spk dashboard docker containers
  */
-export const cleanDashboarContainers = async (config: IConfigYaml) => {
+export const cleanDashboardContainers = async (
+  config: ConfigYaml
+): Promise<void> => {
   let dockerOutput = await exec("docker", [
     "ps",
     "-a",
@@ -120,7 +128,7 @@ export const cleanDashboarContainers = async (config: IConfigYaml) => {
  * @param removeAll true to remove all previously launched instances of the dashboard
  */
 export const launchDashboard = async (
-  config: IConfigYaml,
+  config: ConfigYaml,
   port: number,
   removeAll: boolean
 ): Promise<string> => {
@@ -130,7 +138,7 @@ export const launchDashboard = async (
     }
 
     if (removeAll) {
-      await cleanDashboarContainers(config);
+      await cleanDashboardContainers(config);
     }
 
     const dockerRepository = config.introspection!.dashboard!.image!;
@@ -157,7 +165,7 @@ export const launchDashboard = async (
  * Creates and returns an array of env vars that need to be passed into the
  * docker run command
  */
-export const getEnvVars = async (config: IConfigYaml): Promise<string[]> => {
+export const getEnvVars = async (config: ConfigYaml): Promise<string[]> => {
   const key = await config.introspection!.azure!.key;
   const envVars = [];
   envVars.push("-e");
@@ -236,8 +244,8 @@ export const getEnvVars = async (config: IConfigYaml): Promise<string[]> => {
  * information on dashboard
  */
 export const extractManifestRepositoryInformation = (
-  config: IConfigYaml
-): IIntrospectionManifest | undefined => {
+  config: ConfigYaml
+): IntrospectionManifest | undefined => {
   const { azure_devops } = config;
   if (azure_devops!.manifest_repository) {
     const manifestRepoName = getRepositoryName(

Diff for: src/commands/deployment/get.test.ts

@@ -1,9 +1,9 @@
+/* eslint-disable @typescript-eslint/no-non-null-assertion */
+/* eslint-disable @typescript-eslint/camelcase */
 import path from "path";
 import { duration, IDeployment, status } from "spektate/lib/IDeployment";
 import * as Deployment from "spektate/lib/IDeployment";
-import { IAzureDevOpsRepo } from "spektate/lib/repository/IAzureDevOpsRepo";
 import * as AzureDevOpsRepo from "spektate/lib/repository/IAzureDevOpsRepo";
-import { IGitHub } from "spektate/lib/repository/IGitHub";
 import * as GitHub from "spektate/lib/repository/IGitHub";
 import { ITag } from "spektate/lib/repository/Tag";
 import { loadConfiguration } from "../../config";
@@ -18,10 +18,10 @@ import {
   getClusterSyncStatuses,
   getDeployments,
   getStatus,
-  ICommandOptions,
-  IInitObject,
+  CommandOptions,
+  InitObject,
   initialize,
-  IValidatedOptions,
+  ValidatedOptions,
   OUTPUT_FORMAT,
   printDeployments,
   processOutputFormat,
@@ -30,7 +30,7 @@ import {
 } from "./get";
 import * as get from "./get";
 
-const MOCKED_INPUT_VALUES: ICommandOptions = {
+const MOCKED_INPUT_VALUES: CommandOptions = {
   buildId: "",
   commitId: "",
   deploymentId: "",
@@ -42,7 +42,7 @@ const MOCKED_INPUT_VALUES: ICommandOptions = {
   watch: false
 };
 
-const MOCKED_VALUES: IValidatedOptions = {
+const MOCKED_VALUES: ValidatedOptions = {
   buildId: "",
   commitId: "",
   deploymentId: "",
@@ -56,18 +56,18 @@ const MOCKED_VALUES: IValidatedOptions = {
   watch: false
 };
 
-const getMockedInputValues = (): ICommandOptions => {
+const getMockedInputValues = (): CommandOptions => {
   return deepClone(MOCKED_INPUT_VALUES);
 };
 
-const getMockedValues = (): IValidatedOptions => {
+const getMockedValues = (): ValidatedOptions => {
   return deepClone(MOCKED_VALUES);
 };
 
-// tslint:disable-next-line: no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const data = require("./mocks/data.json");
 const fakeDeployments = data;
-// tslint:disable-next-line: no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const fakeClusterSyncs = require("./mocks/cluster-sync.json");
 const mockedDeps: IDeployment[] = fakeDeployments.data.map(
   (dep: IDeployment) => {
@@ -97,7 +97,7 @@ jest
   .spyOn(AzureDevOpsRepo, "getManifestSyncState")
   .mockReturnValue(Promise.resolve(mockedClusterSyncs));
 
-let initObject: IInitObject;
+let initObject: InitObject;
 
 beforeAll(async () => {
   enableVerboseLogging();