feat: add code linting and prettify (#1350)

Co-authored-by: Trivikram Kamat <16024985+trivikr@users.noreply.github.com>

.eslintrc.js

@@ -0,0 +1,30 @@
+module.exports = {
+  parser: "@typescript-eslint/parser", // Specifies the ESLint parser
+  parserOptions: {
+    ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
+    sourceType: "module" // Allows for the use of imports
+  },
+  extends: [
+    // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    "plugin:@typescript-eslint/recommended"
+  ],
+  plugins: ["@typescript-eslint", "simple-import-sort"],
+  rules: {
+    /** Turn off strict enforcement */
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "prefer-rest-params": "off",
+    "@typescript-eslint/no-non-null-assertion": "off",
+
+    /** Warnings */
+    "@typescript-eslint/no-namespace": "warn",
+
+    /** Errors */
+    "simple-import-sort/sort": "error"
+  }
+};

package.json

@@ -20,8 +20,9 @@
     "test:integration-legacy": "cucumber-js --fail-fast",
     "test:integration": "jest --config jest.config.integ.js --passWithNoTests",
     "test:protocols": "yarn build:protocols && lerna run test --scope '@aws-sdk/aws-*'",
+    "local-publish": "node ./scripts/verdaccio-publish/index.js",
     "test:e2e": "node ./tests/e2e/index.js",
-    "local-publish": "node ./scripts/verdaccio-publish/index.js"
+    "lint": "eslint 'packages/**/src/*.ts' --fix"
   },
   "repository": {
     "type": "git",
@@ -43,10 +44,16 @@
     "@types/chai-as-promised": "^7.1.2",
     "@types/fs-extra": "^8.0.1",
     "@types/jest": "^26.0.4",
+    "@typescript-eslint/eslint-plugin": "3.6.0",
+    "@typescript-eslint/parser": "3.6.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "codecov": "^3.4.0",
     "cucumber": "^6.0.5",
+    "eslint": "7.4.0",
+    "eslint-config-prettier": "6.11.0",
+    "eslint-plugin-prettier": "3.1.4",
+    "eslint-plugin-simple-import-sort": "5.0.3",
     "fs-extra": "^9.0.0",
     "generate-changelog": "^1.7.1",
     "husky": "^4.2.3",

packages/abort-controller/src/AbortController.ts

@@ -1,4 +1,5 @@
 import { AbortController as IAbortController } from "@aws-sdk/types";
+
 import { AbortSignal } from "./AbortSignal";
 
 export class AbortController implements IAbortController {

packages/abort-controller/src/AbortSignal.spec.ts

@@ -1,5 +1,4 @@
 import { AbortController } from "./AbortController";
-import { AbortSignal } from "./AbortSignal";
 
 describe("AbortSignal", () => {
   it("should report aborted to be false until the signal is aborted", () => {

packages/abort-controller/src/AbortSignal.ts

@@ -1,4 +1,4 @@
-import { AbortSignal as IAbortSignal, AbortHandler } from "@aws-sdk/types";
+import { AbortHandler, AbortSignal as IAbortSignal } from "@aws-sdk/types";
 
 export class AbortSignal implements IAbortSignal {
   public onabort?: AbortHandler;

packages/body-checksum-browser/src/index.spec.ts

@@ -1,9 +1,10 @@
-import { bodyChecksumGenerator } from ".";
+import { Sha256 } from "@aws-crypto/sha256-js";
 import { HttpRequest } from "@aws-sdk/protocol-http";
 import { fromUtf8 } from "@aws-sdk/util-utf8-browser";
-import { Sha256 } from "@aws-crypto/sha256-js";
 import { Readable } from "stream";
 
+import { bodyChecksumGenerator } from ".";
+
 describe("bodyChecksumGenerator for browser", () => {
   const sharedRequest = {
     method: "POST",

packages/body-checksum-browser/src/index.ts

@@ -1,7 +1,7 @@
+import { blobReader } from "@aws-sdk/chunked-blob-reader";
 import { TreeHash } from "@aws-sdk/sha256-tree-hash";
-import { Decoder, HttpRequest, HashConstructor } from "@aws-sdk/types";
+import { Decoder, HashConstructor, HttpRequest } from "@aws-sdk/types";
 import { toHex } from "@aws-sdk/util-hex-encoding";
-import { blobReader } from "@aws-sdk/chunked-blob-reader";
 
 const MiB = 1024 * 1024;
 

packages/body-checksum-node/src/index.spec.ts

@@ -1,12 +1,13 @@
-import { bodyChecksumGenerator } from ".";
+import { Sha256 } from "@aws-crypto/sha256-js";
 import { HttpRequest } from "@aws-sdk/protocol-http";
 import { fromUtf8 } from "@aws-sdk/util-utf8-node";
-import { Sha256 } from "@aws-crypto/sha256-js";
-import { join } from "path";
-import { tmpdir } from "os";
 import { createReadStream, mkdtempSync, writeFileSync } from "fs";
+import { tmpdir } from "os";
+import { join } from "path";
 import { Readable } from "stream";
 
+import { bodyChecksumGenerator } from ".";
+
 function createTemporaryFile(contents: string | Buffer): string {
   const folder = mkdtempSync(join(tmpdir(), "add-glacier-checksum-headers-node-"));
   const fileLoc = join(folder, "test.txt");

packages/body-checksum-node/src/index.ts

@@ -1,9 +1,9 @@
-import { createReadStream } from "fs";
-import { TreeHash } from "@aws-sdk/sha256-tree-hash";
-import { Decoder, HttpRequest, HashConstructor } from "@aws-sdk/types";
+import { streamReader } from "@aws-sdk/chunked-stream-reader-node";
 import { isArrayBuffer } from "@aws-sdk/is-array-buffer";
+import { TreeHash } from "@aws-sdk/sha256-tree-hash";
+import { Decoder, HashConstructor, HttpRequest } from "@aws-sdk/types";
 import { toHex } from "@aws-sdk/util-hex-encoding";
-import { streamReader } from "@aws-sdk/chunked-stream-reader-node";
+import { createReadStream } from "fs";
 
 export async function bodyChecksumGenerator(
   request: HttpRequest,

packages/chunked-stream-reader-node/src/index.spec.ts

@@ -1,4 +1,5 @@
 import { PassThrough } from "stream";
+
 import { streamReader } from "./index";
 import { ReadFromBuffers } from "./readable.fixture";
 

packages/chunked-stream-reader-node/src/index.ts

@@ -2,7 +2,7 @@ import { Readable } from "stream";
 export function streamReader(
   stream: Readable,
   onChunk: (chunk: Uint8Array) => void,
-  chunkSize: number = 1048576 // 1 MiB
+  chunkSize = 1048576 // 1 MiB
 ): Promise<void> {
   return new Promise((resolve, reject) => {
     let temporaryBuffer: Uint8Array | undefined;

packages/chunked-stream-reader-node/src/readable.fixture.ts

@@ -7,7 +7,7 @@ export interface ReadFromBuffersOptions extends ReadableOptions {
 
 export class ReadFromBuffers extends Readable {
   private buffersToRead: Buffer[];
-  private numBuffersRead: number = 0;
+  private numBuffersRead = 0;
 
   private errorAfter: number;
   constructor(options: ReadFromBuffersOptions) {
@@ -16,7 +16,7 @@ export class ReadFromBuffers extends Readable {
     this.errorAfter = typeof options.errorAfter === "number" ? options.errorAfter : -1;
   }
 
-  _read(size: number) {
+  _read() {
     if (this.errorAfter !== -1 && this.errorAfter === this.numBuffersRead) {
       this.emit("error", new Error("Mock Error"));
       return;

packages/client-documentation-generator/src/index.ts

@@ -1,8 +1,8 @@
-import { ConverterComponent } from "typedoc/dist/lib/converter/components";
 import { PluginHost } from "typedoc/dist/lib/utils";
-import { SdkClientTocPlugin } from "./sdk-client-toc-plugin";
-import { SdkClientSourceUpdatePlugin } from "./sdk-client-source-update";
+
 import { SdkClientRenameGlobalPlugin } from "./sdk-client-rename-global";
+import { SdkClientSourceUpdatePlugin } from "./sdk-client-source-update";
+import { SdkClientTocPlugin } from "./sdk-client-toc-plugin";
 
 /**
  *

packages/client-documentation-generator/src/sdk-client-rename-global.ts

@@ -1,4 +1,3 @@
-import * as ts from "typescript";
 import { Component, RendererComponent } from "typedoc/dist/lib/output/components";
 import { RendererEvent } from "typedoc/dist/lib/output/events";
 import { NavigationPlugin } from "typedoc/dist/lib/output/plugins";
@@ -13,7 +12,7 @@ export class SdkClientRenameGlobalPlugin extends RendererComponent {
     });
   }
 
-  onRenderedBegin(event: RendererEvent) {
+  onRenderedBegin() {
     const navigationItem = this.navigationPlugin.navigation;
     if (!navigationItem) {
       return;

packages/client-documentation-generator/src/sdk-client-source-update.ts

@@ -1,9 +1,9 @@
 import { sep } from "path";
-import * as ts from "typescript";
-import { ConverterComponent, Component } from "typedoc/dist/lib/converter/components";
 import { Converter } from "typedoc/dist/lib/converter";
+import { Component, ConverterComponent } from "typedoc/dist/lib/converter/components";
 import { Context } from "typedoc/dist/lib/converter/context";
 import { SourceFile } from "typedoc/dist/lib/models";
+import * as ts from "typescript";
 
 const basePathsToIgnore = ["model"];
 

packages/client-documentation-generator/src/sdk-client-toc-plugin.ts

@@ -1,14 +1,8 @@
-import * as ts from "typescript";
+import { ReferenceType } from "typedoc/dist/lib/models";
+import { DeclarationReflection, Reflection, ReflectionKind } from "typedoc/dist/lib/models/reflections";
 import { Component, RendererComponent } from "typedoc/dist/lib/output/components";
-import {
-  Reflection,
-  ProjectReflection,
-  ReflectionKind,
-  DeclarationReflection,
-} from "typedoc/dist/lib/models/reflections";
-import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem";
 import { PageEvent } from "typedoc/dist/lib/output/events";
-import { ReferenceType } from "typedoc/dist/lib/models";
+import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem";
 
 @Component({ name: "SdkClientTocPlugin" })
 export class SdkClientTocPlugin extends RendererComponent {
@@ -124,7 +118,7 @@ export class SdkClientTocPlugin extends RendererComponent {
             this.commandToNavigationItems.set(commandName, item);
           }
         } else if (this.isException(child)) {
-          const item = NavigationItem.create(child, this.exceptionsNavigationItem, true);
+          NavigationItem.create(child, this.exceptionsNavigationItem, true);
         } else if (
           this.isUnion(child) &&
           (child as any).type.types.every((type: ReferenceType) => {
@@ -133,11 +127,11 @@ export class SdkClientTocPlugin extends RendererComponent {
         ) {
           // get command from name
           const commandName = child.name.replace("ExceptionsUnion", "").toLowerCase() + "command";
-          const item = NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
+          NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
         } else if (this.isInputOrOutput(child)) {
           // get command from name
           const commandName = child.name.replace(/Input|Output/, "").toLowerCase() + "command";
-          const item = NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
+          NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
         } else if (child.name.startsWith("_")) {
           return;
         } else {

packages/config-resolver/src/EndpointsConfig.ts

@@ -1,4 +1,4 @@
-import { Provider, UrlParser, Endpoint, RegionInfoProvider, RegionInfo } from "@aws-sdk/types";
+import { Endpoint, Provider, RegionInfo,RegionInfoProvider, UrlParser } from "@aws-sdk/types";
 
 export function normalizeEndpoint(
   endpoint?: string | Endpoint | Provider<Endpoint>,

packages/config-resolver/src/RegionConfig.ts

@@ -13,7 +13,7 @@ export interface RegionResolvedConfig {
   region: Provider<string>;
 }
 export function resolveRegionConfig<T>(input: T & RegionInputConfig & PreviouslyResolved): T & RegionResolvedConfig {
-  let region = input.region || input.regionDefaultProvider(input as any);
+  const region = input.region || input.regionDefaultProvider(input as any);
   return {
     ...input,
     region: normalizeRegion(region),

packages/credential-provider-cognito-identity/src/CognitoProviderParameters.ts

@@ -1,6 +1,7 @@
-import { Logins } from "./Logins";
 import { CognitoIdentityClient } from "@aws-sdk/client-cognito-identity";
 
+import { Logins } from "./Logins";
+
 export interface CognitoProviderParameters {
   /**
    * The SDK client with which the credential provider will contact the Amazon

packages/credential-provider-cognito-identity/src/IndexedDbStorage.ts

@@ -56,7 +56,7 @@ export class IndexedDbStorage implements Storage {
         reject(new Error("Unable to access DB"));
       };
 
-      openDbRequest.onupgradeneeded = (event) => {
+      openDbRequest.onupgradeneeded = () => {
         const db = openDbRequest.result;
         db.onerror = () => {
           reject(new Error("Failed to create object store"));

packages/credential-provider-cognito-identity/src/fromCognitoIdentity.spec.ts

@@ -1,6 +1,7 @@
-import { fromCognitoIdentity } from "./fromCognitoIdentity";
-import { ProviderError } from "@aws-sdk/property-provider";
 import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
+import { ProviderError } from "@aws-sdk/property-provider";
+
+import { fromCognitoIdentity } from "./fromCognitoIdentity";
 
 describe("fromCognitoIdentity", () => {
   const identityId = "id";

packages/credential-provider-cognito-identity/src/fromCognitoIdentity.ts

@@ -1,8 +1,9 @@
+import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
+import { ProviderError } from "@aws-sdk/property-provider";
+import { CredentialProvider, Credentials } from "@aws-sdk/types";
+
 import { CognitoProviderParameters } from "./CognitoProviderParameters";
 import { resolveLogins } from "./resolveLogins";
-import { ProviderError } from "@aws-sdk/property-provider";
-import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
-import { Credentials, CredentialProvider } from "@aws-sdk/types";
 
 /**
  * Retrieves temporary AWS credentials using Amazon Cognito's

packages/credential-provider-cognito-identity/src/fromCognitoIdentityPool.spec.ts

@@ -1,6 +1,7 @@
-import { fromCognitoIdentityPool } from "./fromCognitoIdentityPool";
-import { ProviderError } from "@aws-sdk/property-provider";
 import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
+import { ProviderError } from "@aws-sdk/property-provider";
+
+import { fromCognitoIdentityPool } from "./fromCognitoIdentityPool";
 
 jest.mock("./fromCognitoIdentity", () => {
   const promiseFunc = jest.fn().mockResolvedValue({
@@ -23,8 +24,8 @@ jest.mock("./localStorage", () => {
     },
   };
 });
-import { localStorage } from "./localStorage";
 import { InMemoryStorage } from "./InMemoryStorage";
+import { localStorage } from "./localStorage";
 
 describe("fromCognitoIdentityPool", () => {
   const identityPoolId = "poolId";

packages/credential-provider-cognito-identity/src/fromCognitoIdentityPool.ts

@@ -1,11 +1,12 @@
+import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
+import { ProviderError } from "@aws-sdk/property-provider";
+import { CredentialProvider } from "@aws-sdk/types";
+
 import { CognitoProviderParameters } from "./CognitoProviderParameters";
 import { fromCognitoIdentity } from "./fromCognitoIdentity";
 import { localStorage } from "./localStorage";
 import { resolveLogins } from "./resolveLogins";
 import { Storage } from "./Storage";
-import { ProviderError } from "@aws-sdk/property-provider";
-import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
-import { CredentialProvider } from "@aws-sdk/types";
 
 /**
  * Retrieves or generates a unique identifier using Amazon Cognito's `GetId`

packages/credential-provider-cognito-identity/src/localStorage-inmemoryStorage.spec.ts

@@ -1,5 +1,5 @@
-import { localStorage as storage } from "./localStorage";
 import { InMemoryStorage } from "./InMemoryStorage";
+import { localStorage as storage } from "./localStorage";
 
 describe("localStorage", () => {
   // set store and restore indexedDB and localStorage before and after the test

packages/credential-provider-cognito-identity/src/localStorage.spec.ts

@@ -1,5 +1,5 @@
-import { localStorage } from "./localStorage";
 import { IndexedDbStorage } from "./IndexedDbStorage";
+import { localStorage } from "./localStorage";
 
 describe("localStorage", () => {
   const storageAtInit: Storage | undefined = window?.localStorage;

packages/credential-provider-env/src/index.spec.ts

@@ -1,5 +1,6 @@
 import { ProviderError } from "@aws-sdk/property-provider";
-import { ENV_KEY, ENV_SECRET, ENV_SESSION, ENV_EXPIRATION, fromEnv } from "./";
+
+import { ENV_EXPIRATION, ENV_KEY, ENV_SECRET, ENV_SESSION, fromEnv } from "./";
 
 const akid = process.env[ENV_KEY];
 const secret = process.env[ENV_SECRET];

packages/credential-provider-env/src/index.ts

@@ -1,5 +1,5 @@
-import { CredentialProvider } from "@aws-sdk/types";
 import { ProviderError } from "@aws-sdk/property-provider";
+import { CredentialProvider } from "@aws-sdk/types";
 
 export const ENV_KEY = "AWS_ACCESS_KEY_ID";
 export const ENV_SECRET = "AWS_SECRET_ACCESS_KEY";

packages/credential-provider-imds/src/fromContainerMetadata.spec.ts

@@ -84,7 +84,7 @@ describe("fromContainerMetadata", () => {
     });
 
     it("should retry responses that receive invalid response values", async () => {
-      for (let key of Object.keys(creds)) {
+      for (const key of Object.keys(creds)) {
         const invalidCreds: any = { ...creds };
         delete invalidCreds[key];
         mockHttpRequest.mockReturnValueOnce(Promise.resolve(JSON.stringify(invalidCreds)));

packages/credential-provider-imds/src/fromContainerMetadata.ts

@@ -1,11 +1,12 @@
+import { ProviderError } from "@aws-sdk/property-provider";
 import { CredentialProvider } from "@aws-sdk/types";
-import { RemoteProviderInit, providerConfigFromInit } from "./remoteProvider/RemoteProviderInit";
+import { RequestOptions } from "http";
+import { parse } from "url";
+
 import { httpRequest } from "./remoteProvider/httpRequest";
 import { fromImdsCredentials, isImdsCredentials } from "./remoteProvider/ImdsCredentials";
+import { providerConfigFromInit, RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
 import { retry } from "./remoteProvider/retry";
-import { ProviderError } from "@aws-sdk/property-provider";
-import { parse } from "url";
-import { RequestOptions } from "http";
 
 export const ENV_CMDS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI";
 export const ENV_CMDS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI";