Skip to content

Commit 47770fa

Browse files
alexforsythtrivikr
alexforsyth
and
trivikr
authored
feat: add code linting and prettify (#1350)
Co-authored-by: Trivikram Kamat <[email protected]>
1 parent c2b7b7d commit 47770fa

File tree

236 files changed

+1643
-545
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

236 files changed

+1643
-545
lines changed

‎.eslintrc.js

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
module.exports = {
2+
parser: "@typescript-eslint/parser", // Specifies the ESLint parser
3+
parserOptions: {
4+
ecmaVersion: 2020, // Allows for the parsing of modern ECMAScript features
5+
sourceType: "module" // Allows for the use of imports
6+
},
7+
extends: [
8+
// Uses the recommended rules from the @typescript-eslint/eslint-plugin
9+
"plugin:@typescript-eslint/recommended"
10+
],
11+
plugins: ["@typescript-eslint", "simple-import-sort"],
12+
rules: {
13+
/** Turn off strict enforcement */
14+
"@typescript-eslint/ban-types": "off",
15+
"@typescript-eslint/ban-ts-comment": "off",
16+
"@typescript-eslint/no-var-requires": "off",
17+
"@typescript-eslint/no-empty-function": "off",
18+
"@typescript-eslint/no-empty-interface": "off",
19+
"@typescript-eslint/no-explicit-any": "off",
20+
"@typescript-eslint/explicit-module-boundary-types": "off",
21+
"prefer-rest-params": "off",
22+
"@typescript-eslint/no-non-null-assertion": "off",
23+
24+
/** Warnings */
25+
"@typescript-eslint/no-namespace": "warn",
26+
27+
/** Errors */
28+
"simple-import-sort/sort": "error"
29+
}
30+
};

‎package.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
"test:integration-legacy": "cucumber-js --fail-fast",
2121
"test:integration": "jest --config jest.config.integ.js --passWithNoTests",
2222
"test:protocols": "yarn build:protocols && lerna run test --scope '@aws-sdk/aws-*'",
23+
"local-publish": "node ./scripts/verdaccio-publish/index.js",
2324
"test:e2e": "node ./tests/e2e/index.js",
24-
"local-publish": "node ./scripts/verdaccio-publish/index.js"
25+
"lint": "eslint 'packages/**/src/*.ts' --fix"
2526
},
2627
"repository": {
2728
"type": "git",
@@ -43,10 +44,16 @@
4344
"@types/chai-as-promised": "^7.1.2",
4445
"@types/fs-extra": "^8.0.1",
4546
"@types/jest": "^26.0.4",
47+
"@typescript-eslint/eslint-plugin": "3.6.0",
48+
"@typescript-eslint/parser": "3.6.0",
4649
"chai": "^4.2.0",
4750
"chai-as-promised": "^7.1.1",
4851
"codecov": "^3.4.0",
4952
"cucumber": "^6.0.5",
53+
"eslint": "7.4.0",
54+
"eslint-config-prettier": "6.11.0",
55+
"eslint-plugin-prettier": "3.1.4",
56+
"eslint-plugin-simple-import-sort": "5.0.3",
5057
"fs-extra": "^9.0.0",
5158
"generate-changelog": "^1.7.1",
5259
"husky": "^4.2.3",

‎packages/abort-controller/src/AbortController.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { AbortController as IAbortController } from "@aws-sdk/types";
2+
23
import { AbortSignal } from "./AbortSignal";
34

45
export class AbortController implements IAbortController {

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

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import { AbortController } from "./AbortController";
2-
import { AbortSignal } from "./AbortSignal";
32

43
describe("AbortSignal", () => {
54
it("should report aborted to be false until the signal is aborted", () => {

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { AbortSignal as IAbortSignal, AbortHandler } from "@aws-sdk/types";
1+
import { AbortHandler, AbortSignal as IAbortSignal } from "@aws-sdk/types";
22

33
export class AbortSignal implements IAbortSignal {
44
public onabort?: AbortHandler;

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
import { bodyChecksumGenerator } from ".";
1+
import { Sha256 } from "@aws-crypto/sha256-js";
22
import { HttpRequest } from "@aws-sdk/protocol-http";
33
import { fromUtf8 } from "@aws-sdk/util-utf8-browser";
4-
import { Sha256 } from "@aws-crypto/sha256-js";
54
import { Readable } from "stream";
65

6+
import { bodyChecksumGenerator } from ".";
7+
78
describe("bodyChecksumGenerator for browser", () => {
89
const sharedRequest = {
910
method: "POST",

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1+
import { blobReader } from "@aws-sdk/chunked-blob-reader";
12
import { TreeHash } from "@aws-sdk/sha256-tree-hash";
2-
import { Decoder, HttpRequest, HashConstructor } from "@aws-sdk/types";
3+
import { Decoder, HashConstructor, HttpRequest } from "@aws-sdk/types";
34
import { toHex } from "@aws-sdk/util-hex-encoding";
4-
import { blobReader } from "@aws-sdk/chunked-blob-reader";
55

66
const MiB = 1024 * 1024;
77

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
import { bodyChecksumGenerator } from ".";
1+
import { Sha256 } from "@aws-crypto/sha256-js";
22
import { HttpRequest } from "@aws-sdk/protocol-http";
33
import { fromUtf8 } from "@aws-sdk/util-utf8-node";
4-
import { Sha256 } from "@aws-crypto/sha256-js";
5-
import { join } from "path";
6-
import { tmpdir } from "os";
74
import { createReadStream, mkdtempSync, writeFileSync } from "fs";
5+
import { tmpdir } from "os";
6+
import { join } from "path";
87
import { Readable } from "stream";
98

9+
import { bodyChecksumGenerator } from ".";
10+
1011
function createTemporaryFile(contents: string | Buffer): string {
1112
const folder = mkdtempSync(join(tmpdir(), "add-glacier-checksum-headers-node-"));
1213
const fileLoc = join(folder, "test.txt");

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import { createReadStream } from "fs";
2-
import { TreeHash } from "@aws-sdk/sha256-tree-hash";
3-
import { Decoder, HttpRequest, HashConstructor } from "@aws-sdk/types";
1+
import { streamReader } from "@aws-sdk/chunked-stream-reader-node";
42
import { isArrayBuffer } from "@aws-sdk/is-array-buffer";
3+
import { TreeHash } from "@aws-sdk/sha256-tree-hash";
4+
import { Decoder, HashConstructor, HttpRequest } from "@aws-sdk/types";
55
import { toHex } from "@aws-sdk/util-hex-encoding";
6-
import { streamReader } from "@aws-sdk/chunked-stream-reader-node";
6+
import { createReadStream } from "fs";
77

88
export async function bodyChecksumGenerator(
99
request: HttpRequest,

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

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { PassThrough } from "stream";
2+
23
import { streamReader } from "./index";
34
import { ReadFromBuffers } from "./readable.fixture";
45

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Readable } from "stream";
22
export function streamReader(
33
stream: Readable,
44
onChunk: (chunk: Uint8Array) => void,
5-
chunkSize: number = 1048576 // 1 MiB
5+
chunkSize = 1048576 // 1 MiB
66
): Promise<void> {
77
return new Promise((resolve, reject) => {
88
let temporaryBuffer: Uint8Array | undefined;

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export interface ReadFromBuffersOptions extends ReadableOptions {
77

88
export class ReadFromBuffers extends Readable {
99
private buffersToRead: Buffer[];
10-
private numBuffersRead: number = 0;
10+
private numBuffersRead = 0;
1111

1212
private errorAfter: number;
1313
constructor(options: ReadFromBuffersOptions) {
@@ -16,7 +16,7 @@ export class ReadFromBuffers extends Readable {
1616
this.errorAfter = typeof options.errorAfter === "number" ? options.errorAfter : -1;
1717
}
1818

19-
_read(size: number) {
19+
_read() {
2020
if (this.errorAfter !== -1 && this.errorAfter === this.numBuffersRead) {
2121
this.emit("error", new Error("Mock Error"));
2222
return;

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { ConverterComponent } from "typedoc/dist/lib/converter/components";
21
import { PluginHost } from "typedoc/dist/lib/utils";
3-
import { SdkClientTocPlugin } from "./sdk-client-toc-plugin";
4-
import { SdkClientSourceUpdatePlugin } from "./sdk-client-source-update";
2+
53
import { SdkClientRenameGlobalPlugin } from "./sdk-client-rename-global";
4+
import { SdkClientSourceUpdatePlugin } from "./sdk-client-source-update";
5+
import { SdkClientTocPlugin } from "./sdk-client-toc-plugin";
66

77
/**
88
*

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

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import * as ts from "typescript";
21
import { Component, RendererComponent } from "typedoc/dist/lib/output/components";
32
import { RendererEvent } from "typedoc/dist/lib/output/events";
43
import { NavigationPlugin } from "typedoc/dist/lib/output/plugins";
@@ -13,7 +12,7 @@ export class SdkClientRenameGlobalPlugin extends RendererComponent {
1312
});
1413
}
1514

16-
onRenderedBegin(event: RendererEvent) {
15+
onRenderedBegin() {
1716
const navigationItem = this.navigationPlugin.navigation;
1817
if (!navigationItem) {
1918
return;

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import { sep } from "path";
2-
import * as ts from "typescript";
3-
import { ConverterComponent, Component } from "typedoc/dist/lib/converter/components";
42
import { Converter } from "typedoc/dist/lib/converter";
3+
import { Component, ConverterComponent } from "typedoc/dist/lib/converter/components";
54
import { Context } from "typedoc/dist/lib/converter/context";
65
import { SourceFile } from "typedoc/dist/lib/models";
6+
import * as ts from "typescript";
77

88
const basePathsToIgnore = ["model"];
99

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

+6-12
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
1-
import * as ts from "typescript";
1+
import { ReferenceType } from "typedoc/dist/lib/models";
2+
import { DeclarationReflection, Reflection, ReflectionKind } from "typedoc/dist/lib/models/reflections";
23
import { Component, RendererComponent } from "typedoc/dist/lib/output/components";
3-
import {
4-
Reflection,
5-
ProjectReflection,
6-
ReflectionKind,
7-
DeclarationReflection,
8-
} from "typedoc/dist/lib/models/reflections";
9-
import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem";
104
import { PageEvent } from "typedoc/dist/lib/output/events";
11-
import { ReferenceType } from "typedoc/dist/lib/models";
5+
import { NavigationItem } from "typedoc/dist/lib/output/models/NavigationItem";
126

137
@Component({ name: "SdkClientTocPlugin" })
148
export class SdkClientTocPlugin extends RendererComponent {
@@ -124,7 +118,7 @@ export class SdkClientTocPlugin extends RendererComponent {
124118
this.commandToNavigationItems.set(commandName, item);
125119
}
126120
} else if (this.isException(child)) {
127-
const item = NavigationItem.create(child, this.exceptionsNavigationItem, true);
121+
NavigationItem.create(child, this.exceptionsNavigationItem, true);
128122
} else if (
129123
this.isUnion(child) &&
130124
(child as any).type.types.every((type: ReferenceType) => {
@@ -133,11 +127,11 @@ export class SdkClientTocPlugin extends RendererComponent {
133127
) {
134128
// get command from name
135129
const commandName = child.name.replace("ExceptionsUnion", "").toLowerCase() + "command";
136-
const item = NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
130+
NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
137131
} else if (this.isInputOrOutput(child)) {
138132
// get command from name
139133
const commandName = child.name.replace(/Input|Output/, "").toLowerCase() + "command";
140-
const item = NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
134+
NavigationItem.create(child, this.commandToNavigationItems.get(commandName), true);
141135
} else if (child.name.startsWith("_")) {
142136
return;
143137
} else {

‎packages/config-resolver/src/EndpointsConfig.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Provider, UrlParser, Endpoint, RegionInfoProvider, RegionInfo } from "@aws-sdk/types";
1+
import { Endpoint, Provider, RegionInfo,RegionInfoProvider, UrlParser } from "@aws-sdk/types";
22

33
export function normalizeEndpoint(
44
endpoint?: string | Endpoint | Provider<Endpoint>,

‎packages/config-resolver/src/RegionConfig.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export interface RegionResolvedConfig {
1313
region: Provider<string>;
1414
}
1515
export function resolveRegionConfig<T>(input: T & RegionInputConfig & PreviouslyResolved): T & RegionResolvedConfig {
16-
let region = input.region || input.regionDefaultProvider(input as any);
16+
const region = input.region || input.regionDefaultProvider(input as any);
1717
return {
1818
...input,
1919
region: normalizeRegion(region),

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import { Logins } from "./Logins";
21
import { CognitoIdentityClient } from "@aws-sdk/client-cognito-identity";
32

3+
import { Logins } from "./Logins";
4+
45
export interface CognitoProviderParameters {
56
/**
67
* The SDK client with which the credential provider will contact the Amazon

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export class IndexedDbStorage implements Storage {
5656
reject(new Error("Unable to access DB"));
5757
};
5858

59-
openDbRequest.onupgradeneeded = (event) => {
59+
openDbRequest.onupgradeneeded = () => {
6060
const db = openDbRequest.result;
6161
db.onerror = () => {
6262
reject(new Error("Failed to create object store"));

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import { fromCognitoIdentity } from "./fromCognitoIdentity";
2-
import { ProviderError } from "@aws-sdk/property-provider";
31
import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
2+
import { ProviderError } from "@aws-sdk/property-provider";
3+
4+
import { fromCognitoIdentity } from "./fromCognitoIdentity";
45

56
describe("fromCognitoIdentity", () => {
67
const identityId = "id";

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
2+
import { ProviderError } from "@aws-sdk/property-provider";
3+
import { CredentialProvider, Credentials } from "@aws-sdk/types";
4+
15
import { CognitoProviderParameters } from "./CognitoProviderParameters";
26
import { resolveLogins } from "./resolveLogins";
3-
import { ProviderError } from "@aws-sdk/property-provider";
4-
import { GetCredentialsForIdentityCommand } from "@aws-sdk/client-cognito-identity";
5-
import { Credentials, CredentialProvider } from "@aws-sdk/types";
67

78
/**
89
* Retrieves temporary AWS credentials using Amazon Cognito's

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
import { fromCognitoIdentityPool } from "./fromCognitoIdentityPool";
2-
import { ProviderError } from "@aws-sdk/property-provider";
31
import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
2+
import { ProviderError } from "@aws-sdk/property-provider";
3+
4+
import { fromCognitoIdentityPool } from "./fromCognitoIdentityPool";
45

56
jest.mock("./fromCognitoIdentity", () => {
67
const promiseFunc = jest.fn().mockResolvedValue({
@@ -23,8 +24,8 @@ jest.mock("./localStorage", () => {
2324
},
2425
};
2526
});
26-
import { localStorage } from "./localStorage";
2727
import { InMemoryStorage } from "./InMemoryStorage";
28+
import { localStorage } from "./localStorage";
2829

2930
describe("fromCognitoIdentityPool", () => {
3031
const identityPoolId = "poolId";

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

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
2+
import { ProviderError } from "@aws-sdk/property-provider";
3+
import { CredentialProvider } from "@aws-sdk/types";
4+
15
import { CognitoProviderParameters } from "./CognitoProviderParameters";
26
import { fromCognitoIdentity } from "./fromCognitoIdentity";
37
import { localStorage } from "./localStorage";
48
import { resolveLogins } from "./resolveLogins";
59
import { Storage } from "./Storage";
6-
import { ProviderError } from "@aws-sdk/property-provider";
7-
import { GetIdCommand } from "@aws-sdk/client-cognito-identity";
8-
import { CredentialProvider } from "@aws-sdk/types";
910

1011
/**
1112
* Retrieves or generates a unique identifier using Amazon Cognito's `GetId`

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { localStorage as storage } from "./localStorage";
21
import { InMemoryStorage } from "./InMemoryStorage";
2+
import { localStorage as storage } from "./localStorage";
33

44
describe("localStorage", () => {
55
// set store and restore indexedDB and localStorage before and after the test

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { localStorage } from "./localStorage";
21
import { IndexedDbStorage } from "./IndexedDbStorage";
2+
import { localStorage } from "./localStorage";
33

44
describe("localStorage", () => {
55
const storageAtInit: Storage | undefined = window?.localStorage;

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { ProviderError } from "@aws-sdk/property-provider";
2-
import { ENV_KEY, ENV_SECRET, ENV_SESSION, ENV_EXPIRATION, fromEnv } from "./";
2+
3+
import { ENV_EXPIRATION, ENV_KEY, ENV_SECRET, ENV_SESSION, fromEnv } from "./";
34

45
const akid = process.env[ENV_KEY];
56
const secret = process.env[ENV_SECRET];

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { CredentialProvider } from "@aws-sdk/types";
21
import { ProviderError } from "@aws-sdk/property-provider";
2+
import { CredentialProvider } from "@aws-sdk/types";
33

44
export const ENV_KEY = "AWS_ACCESS_KEY_ID";
55
export const ENV_SECRET = "AWS_SECRET_ACCESS_KEY";

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ describe("fromContainerMetadata", () => {
8484
});
8585

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

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

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
import { ProviderError } from "@aws-sdk/property-provider";
12
import { CredentialProvider } from "@aws-sdk/types";
2-
import { RemoteProviderInit, providerConfigFromInit } from "./remoteProvider/RemoteProviderInit";
3+
import { RequestOptions } from "http";
4+
import { parse } from "url";
5+
36
import { httpRequest } from "./remoteProvider/httpRequest";
47
import { fromImdsCredentials, isImdsCredentials } from "./remoteProvider/ImdsCredentials";
8+
import { providerConfigFromInit, RemoteProviderInit } from "./remoteProvider/RemoteProviderInit";
59
import { retry } from "./remoteProvider/retry";
6-
import { ProviderError } from "@aws-sdk/property-provider";
7-
import { parse } from "url";
8-
import { RequestOptions } from "http";
910

1011
export const ENV_CMDS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI";
1112
export const ENV_CMDS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI";

0 commit comments

Comments
 (0)