feat: add code linting and prettify

.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"
+  }
+};

features/extra/hooks.js

@@ -7,14 +7,7 @@ const isType = (obj, type) => {
   return Object.prototype.toString.call(obj) === "[object " + type + "]";
 };
 
-const {
-  Before,
-  Given,
-  Then,
-  When,
-  setDefaultTimeout,
-  setWorldConstructor
-} = require("cucumber");
+const { Before, Given, Then, When, setDefaultTimeout, setWorldConstructor } = require("cucumber");
 
 setDefaultTimeout(300 * 1000);
 setWorldConstructor(require("./world.js").World);
@@ -28,12 +21,8 @@ Before(function (scenario, callback) {
 Given("I create a shared bucket", function (callback) {
   if (this.sharedBucket) return callback();
 
-  const bucket = (this.sharedBucket = this.uniqueName(
-    "aws-sdk-js-shared-integration"
-  ));
-  this.request("s3", "createBucket", { Bucket: this.sharedBucket }, function (
-    err
-  ) {
+  const bucket = (this.sharedBucket = this.uniqueName("aws-sdk-js-shared-integration"));
+  this.request("s3", "createBucket", { Bucket: this.sharedBucket }, function (err) {
     this.cacheBucketName(this.sharedBucket);
     if (err) {
       callback(err);
@@ -48,10 +37,7 @@ Given("I create a shared bucket", function (callback) {
 
 Given("I create a bucket", function (callback) {
   const bucket = (this.bucket = this.uniqueName("aws-sdk-js-integration"));
-  this.request("s3", "createBucket", { Bucket: this.bucket }, function (
-    err,
-    data
-  ) {
+  this.request("s3", "createBucket", { Bucket: this.bucket }, function (err, data) {
     if (err) {
       return callback(err);
     }
@@ -77,11 +63,7 @@ Given("I run the {string} operation", function (operation, callback) {
   this.request(null, operation, {}, callback, false);
 });
 
-Given("I run the {string} operation with params:", function (
-  operation,
-  params,
-  callback
-) {
+Given("I run the {string} operation with params:", function (operation, params, callback) {
   this.request(null, operation, JSON.parse(params), callback, false);
 });
 
@@ -92,28 +74,19 @@ Then("the request should be successful", function (callback) {
 
 Then("the value at {string} should be a list", function (path, callback) {
   const value = jmespath.search(this.data, path);
-  this.assert.ok(
-    Array.isArray(value),
-    "expected " + util.inspect(value) + " to be a list"
-  );
+  this.assert.ok(Array.isArray(value), "expected " + util.inspect(value) + " to be a list");
   callback();
 });
 
 Then("the value at {string} should be a number", function (path, callback) {
   const value = jmespath.search(this.data, path);
-  this.assert.ok(
-    typeof value === "number",
-    "expected " + util.inspect(value) + " to be a number"
-  );
+  this.assert.ok(typeof value === "number", "expected " + util.inspect(value) + " to be a number");
   callback();
 });
 
 Then("the value at {string} should be a string", function (path, callback) {
   const value = jmespath.search(this.data, path);
-  this.assert.ok(
-    typeof value === "string",
-    "expected " + util.inspect(value) + " to be a string"
-  );
+  this.assert.ok(typeof value === "string", "expected " + util.inspect(value) + " to be a string");
   callback();
 });
 
@@ -148,46 +121,44 @@ Then("I should get the error:", function (table, callback) {
   callback();
 });
 
-Given("I have a {string} service in the {string} region", function (
-  svc,
-  region,
-  callback
-) {
+Given("I have a {string} service in the {string} region", function (svc, region, callback) {
   this.service = new this.service.constructor({ region: region });
   callback();
 });
 
-Given(
-  /^I paginate the "([^"]*)" operation(?: with limit (\d+))?(?: and max pages (\d+))?$/,
-  function (operation, limit, maxPages, callback) {
-    limit = parseInt(limit);
-    if (maxPages) maxPages = parseInt(maxPages);
+Given(/^I paginate the "([^"]*)" operation(?: with limit (\d+))?(?: and max pages (\d+))?$/, function (
+  operation,
+  limit,
+  maxPages,
+  callback
+) {
+  limit = parseInt(limit);
+  if (maxPages) maxPages = parseInt(maxPages);
 
-    const world = this;
-    this.numPages = 0;
-    this.numMarkers = 0;
-    this.operation = operation;
-    this.paginationConfig = this.service.paginationConfig(operation);
-    this.params = this.params || {};
+  const world = this;
+  this.numPages = 0;
+  this.numMarkers = 0;
+  this.operation = operation;
+  this.paginationConfig = this.service.paginationConfig(operation);
+  this.params = this.params || {};
 
-    const marker = this.paginationConfig.outputToken;
-    if (this.paginationConfig.limitKey) {
-      this.params[this.paginationConfig.limitKey] = limit;
-    }
-    this.service[operation](this.params).eachPage(function (err, data) {
-      if (err) callback(err);
-      else if (data === null) callback();
-      else if (maxPages && world.numPages === maxPages) {
-        callback();
-        return false;
-      } else {
-        if (data[marker]) world.numMarkers++;
-        world.numPages++;
-        world.data = data;
-      }
-    });
+  const marker = this.paginationConfig.outputToken;
+  if (this.paginationConfig.limitKey) {
+    this.params[this.paginationConfig.limitKey] = limit;
   }
-);
+  this.service[operation](this.params).eachPage(function (err, data) {
+    if (err) callback(err);
+    else if (data === null) callback();
+    else if (maxPages && world.numPages === maxPages) {
+      callback();
+      return false;
+    } else {
+      if (data[marker]) world.numMarkers++;
+      world.numPages++;
+      world.data = data;
+    }
+  });
+});
 
 Then("I should get more than one page", function (callback) {
   this.assert.compare(this.numPages, ">", 1);
@@ -215,23 +186,21 @@ Then("the last page should not contain a marker", function (callback) {
   callback();
 });
 
-Then(
-  "the result at {word} should contain a property {word} with a(n) {word}",
-  function (wrapper, property, type, callback) {
-    if (type === "Array" || type === "Date") {
-      this.assert.equal(isType(this.data[wrapper][property], type), true);
-    } else {
-      this.assert.equal(typeof this.data[wrapper][property], type);
-    }
-    callback();
-  }
-);
-
-Then("the result should contain a property {word} with a(n) {word}", function (
+Then("the result at {word} should contain a property {word} with a(n) {word}", function (
+  wrapper,
   property,
   type,
   callback
 ) {
+  if (type === "Array" || type === "Date") {
+    this.assert.equal(isType(this.data[wrapper][property], type), true);
+  } else {
+    this.assert.equal(typeof this.data[wrapper][property], type);
+  }
+  callback();
+});
+
+Then("the result should contain a property {word} with a(n) {word}", function (property, type, callback) {
   if (type === "Array" || type === "Date") {
     this.assert.equal(isType(this.data[property], type), true);
   } else {

package.json

@@ -20,7 +20,8 @@
     "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"
+    "local-publish": "node ./scripts/verdaccio-publish/index.js",
+    "lint": "eslint 'packages/**/src/*.ts' --fix"
   },
   "repository": {
     "type": "git",
@@ -42,10 +43,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",
@@ -66,7 +73,7 @@
     "lerna": "3.22.1",
     "lint-staged": "^10.0.1",
     "mocha": "^8.0.1",
-    "prettier": "2.0.5",
+    "prettier": "^2.0.5",
     "puppeteer": "^4.0.0",
     "ts-loader": "^7.0.5",
     "typescript": "~3.9.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;