@checkdigit/eslint-plugin 7.15.0-PR.134-deba → 7.15.0-PR.134-3323
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-mjs/index.mjs +4 -2
- package/dist-mjs/is-aws-sdk-v3-used.mjs +16 -0
- package/dist-mjs/require-aws-config.mjs +29 -10
- package/dist-types/index.d.ts +1 -0
- package/dist-types/is-aws-sdk-v3-used.d.ts +1 -0
- package/dist-types/require-aws-config.d.ts +2 -1
- package/package.json +1 -1
- package/src/index.ts +2 -0
- package/src/is-aws-sdk-v3-used.ts +24 -0
- package/src/require-aws-config.ts +67 -44
package/dist-mjs/index.mjs
CHANGED
|
@@ -33,6 +33,7 @@ import requireAssertPredicateRejectsThrows from "./require-assert-predicate-reje
|
|
|
33
33
|
import requireStrictAssert from "./require-strict-assert.mjs";
|
|
34
34
|
import requireAssertMessage from "./require-assert-message.mjs";
|
|
35
35
|
import requireTsExtensionImportsExports from "./require-ts-extension-imports-exports.mjs";
|
|
36
|
+
import { default as default2 } from "./is-aws-sdk-v3-used.mjs";
|
|
36
37
|
var rules = {
|
|
37
38
|
"file-path-comment": filePathComment,
|
|
38
39
|
"no-card-numbers": noCardNumbers,
|
|
@@ -144,6 +145,7 @@ var defaultToExport = {
|
|
|
144
145
|
};
|
|
145
146
|
var index_default = defaultToExport;
|
|
146
147
|
export {
|
|
147
|
-
index_default as default
|
|
148
|
+
index_default as default,
|
|
149
|
+
default2 as isAwsSdkV3Used
|
|
148
150
|
};
|
|
149
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
151
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8seUJBQXlCLFVBQVUsbUNBQW1DO0FBQzdFLE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU8sd0JBQXdCO0FBQy9CLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTyxvQkFBb0IsVUFBVSw4QkFBOEI7QUFDbkUsT0FBTyxxQkFBcUI7QUFDNUIsT0FBTyxtQkFBbUI7QUFDMUIsT0FBTyxZQUFZO0FBQ25CLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sb0JBQW9CO0FBQzNCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFDaEMsT0FBTywwQkFBMEI7QUFDakMsT0FBTyxzQ0FBc0M7QUFFN0MsU0FBb0IsV0FBWEEsZ0JBQWlDO0FBRTFDLElBQU0sUUFBc0Q7QUFBQSxFQUMxRCxxQkFBcUI7QUFBQSxFQUNyQixtQkFBbUI7QUFBQSxFQUNuQixXQUFXO0FBQUEsRUFDWCxxQkFBcUI7QUFBQSxFQUNyQix5QkFBeUI7QUFBQSxFQUN6QixXQUFXO0FBQUEsRUFDWCxXQUFXO0FBQUEsRUFDWCwwQkFBMEI7QUFBQSxFQUMxQix5QkFBeUI7QUFBQSxFQUN6Qix3Q0FBd0M7QUFBQSxFQUN4QyxrQkFBa0I7QUFBQSxFQUNsQixzQkFBc0I7QUFBQSxFQUN0QixtQkFBbUI7QUFBQSxFQUNuQiw4QkFBOEI7QUFBQSxFQUM5QiwyQ0FBMkM7QUFBQSxFQUMzQywyQkFBMkI7QUFBQSxFQUMzQixDQUFDLDBCQUEwQixHQUFHO0FBQUEsRUFDOUIsQ0FBQyw2QkFBNkIsR0FBRztBQUFBLEVBQ2pDLENBQUMsMkJBQTJCLEdBQUc7QUFBQSxFQUMvQixDQUFDLGdDQUFnQyxHQUFHO0FBQUEsRUFDcEMsQ0FBQyx5QkFBeUIsR0FBRztBQUFBLEVBQzdCLENBQUMsb0JBQW9CLEdBQUc7QUFBQSxFQUN4QixDQUFDLDJDQUEyQyxHQUFHO0FBQUEsRUFDL0MsQ0FBQyxzQkFBc0IsR0FBRztBQUFBLEVBQzFCLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHFDQUFxQyxHQUFHO0FBQzNDO0FBRUEsSUFBTSxTQUFxQztBQUFBLEVBQ3pDO0FBQ0Y7QUFFQSxJQUFNLFVBQXdEO0FBQUEsRUFDNUQsS0FBSztBQUFBLElBQ0g7QUFBQSxNQUNFLE9BQU8sQ0FBQyxTQUFTO0FBQUEsTUFDakIsU0FBUztBQUFBLFFBQ1AsZUFBZTtBQUFBLE1BQ2pCO0FBQUEsTUFDQSxPQUFPO0FBQUEsUUFDTCwrQkFBK0I7QUFBQSxRQUMvQix1QkFBdUI7QUFBQSxRQUN2QixpQ0FBaUM7QUFBQSxRQUNqQyxpQ0FBaUM7QUFBQSxRQUNqQyxxQ0FBcUM7QUFBQSxRQUNyQyx1QkFBdUI7QUFBQSxRQUN2Qix1QkFBdUI7QUFBQSxRQUN2QixzQ0FBc0M7QUFBQSxRQUN0QyxxQ0FBcUM7QUFBQSxRQUNyQyxvREFBb0Q7QUFBQSxRQUNwRCxrQ0FBa0M7QUFBQSxRQUNsQywrQkFBK0I7QUFBQSxRQUMvQiwwQ0FBMEM7QUFBQSxRQUMxQyx1REFBdUQ7QUFBQSxRQUN2RCx1Q0FBdUM7QUFBQSxRQUN2Qyw4QkFBOEI7QUFBQSxRQUM5QixDQUFDLGVBQWUsMEJBQTBCLEVBQUUsR0FBRztBQUFBLFFBQy9DLENBQUMsZUFBZSw2QkFBNkIsRUFBRSxHQUFHO0FBQUEsUUFDbEQsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsZ0NBQWdDLEVBQUUsR0FBRztBQUFBLFFBQ3JELENBQUMsZUFBZSx5QkFBeUIsRUFBRSxHQUFHO0FBQUEsUUFDOUMsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUscUNBQXFDLEVBQUUsR0FBRztBQUFBLFFBQzFELENBQUMsZUFBZSxvQkFBb0IsRUFBRSxHQUFHO0FBQUEsUUFDekMsQ0FBQyxlQUFlLDJDQUEyQyxFQUFFLEdBQUc7QUFBQSxRQUNoRSxDQUFDLGVBQWUsc0JBQXNCLEVBQUUsR0FBRztBQUFBLE1BQzdDO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYO0FBQUEsTUFDRSxPQUFPLENBQUMsU0FBUztBQUFBLE1BQ2pCLFNBQVM7QUFBQSxRQUNQLGVBQWU7QUFBQSxNQUNqQjtBQUFBLE1BQ0EsT0FBTztBQUFBLFFBQ0wsK0JBQStCO0FBQUEsUUFDL0IsdUJBQXVCO0FBQUEsUUFDdkIsaUNBQWlDO0FBQUEsUUFDakMsaUNBQWlDO0FBQUEsUUFDakMscUNBQXFDO0FBQUEsUUFDckMsdUJBQXVCO0FBQUEsUUFDdkIsdUJBQXVCO0FBQUEsUUFDdkIsc0NBQXNDO0FBQUEsUUFDdEMscUNBQXFDO0FBQUEsUUFDckMsb0RBQW9EO0FBQUEsUUFDcEQsa0NBQWtDO0FBQUEsUUFDbEMsK0JBQStCO0FBQUEsUUFDL0IsMENBQTBDO0FBQUEsUUFDMUMsdURBQXVEO0FBQUEsUUFDdkQsdUNBQXVDO0FBQUEsUUFDdkMsOEJBQThCO0FBQUEsUUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxRQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLFFBQ2xELENBQUMsZUFBZSwyQkFBMkIsRUFBRSxHQUFHO0FBQUEsUUFDaEQsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLFFBQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsUUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxRQUMxRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLFFBQ3pDLENBQUMsZUFBZSwyQ0FBMkMsRUFBRSxHQUFHO0FBQUEsUUFDaEUsQ0FBQyxlQUFlLHNCQUFzQixFQUFFLEdBQUc7QUFBQSxNQUM3QztBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBQ0Y7QUFFQSxJQUFNLGtCQUVGO0FBQUEsRUFDRixHQUFHO0FBQUEsRUFDSDtBQUNGO0FBQ0EsSUFBTyxnQkFBUTsiLAogICJuYW1lcyI6IFsiZGVmYXVsdCJdCn0K
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// src/is-aws-sdk-v3-used.ts
|
|
2
|
+
import { promises as fs } from "node:fs";
|
|
3
|
+
var cachedIsAwsSdkV3Used;
|
|
4
|
+
async function isAwsSdkV3Used() {
|
|
5
|
+
if (cachedIsAwsSdkV3Used !== void 0) {
|
|
6
|
+
return cachedIsAwsSdkV3Used;
|
|
7
|
+
}
|
|
8
|
+
const packageJson = JSON.parse(await fs.readFile("package.json", "utf8"));
|
|
9
|
+
const dependencies = packageJson.dependencies ?? {};
|
|
10
|
+
cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) => dependency.startsWith("@aws-sdk/"));
|
|
11
|
+
return cachedIsAwsSdkV3Used;
|
|
12
|
+
}
|
|
13
|
+
export {
|
|
14
|
+
isAwsSdkV3Used as default
|
|
15
|
+
};
|
|
16
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2lzLWF3cy1zZGstdjMtdXNlZC50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFFQSxTQUFTLFlBQVksVUFBVTtBQVMvQixJQUFJO0FBRUosZUFBTyxpQkFBMEQ7QUFDL0QsTUFBSSx5QkFBeUIsUUFBVztBQUN0QyxXQUFPO0FBQUEsRUFDVDtBQUVBLFFBQU0sY0FBYyxLQUFLLE1BQU0sTUFBTSxHQUFHLFNBQVMsZ0JBQWdCLE1BQU0sQ0FBQztBQUN4RSxRQUFNLGVBQWUsWUFBWSxnQkFBZ0IsQ0FBQztBQUVsRCx5QkFBdUIsT0FBTyxLQUFLLFlBQVksRUFBRSxLQUFLLENBQUMsZUFBZSxXQUFXLFdBQVcsV0FBVyxDQUFDO0FBQ3hHLFNBQU87QUFDVDsiLAogICJuYW1lcyI6IFtdCn0K
|
|
@@ -3,40 +3,58 @@ import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
|
|
|
3
3
|
import getDocumentationUrl from "./get-documentation-url.mjs";
|
|
4
4
|
var ruleId = "require-aws-config";
|
|
5
5
|
var MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
6
|
+
var MESSAGE_ID_NO_CHECKDIGIT_AWS = "noCheckdigitAws";
|
|
6
7
|
var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
7
8
|
function isAwsSdkClientModule(importDeclaration) {
|
|
8
9
|
return importDeclaration.source.value.startsWith("@aws-sdk/client-");
|
|
9
10
|
}
|
|
10
|
-
function
|
|
11
|
-
return
|
|
11
|
+
function isCheckdigitAwsModule(importDeclaration) {
|
|
12
|
+
return importDeclaration.source.value === "@checkdigit/aws";
|
|
13
|
+
}
|
|
14
|
+
function isAwsClient(awsClientName, importedAwsClients) {
|
|
15
|
+
return awsClientName.endsWith("Client") && (importedAwsClients === void 0 || importedAwsClients.has(awsClientName));
|
|
12
16
|
}
|
|
13
|
-
var importedAwsClients = /* @__PURE__ */ new Set();
|
|
14
17
|
var rule = createRule({
|
|
15
18
|
name: ruleId,
|
|
16
19
|
meta: {
|
|
17
20
|
type: "problem",
|
|
18
21
|
docs: {
|
|
19
|
-
description: "Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly."
|
|
22
|
+
description: "Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module."
|
|
20
23
|
},
|
|
21
24
|
messages: {
|
|
22
|
-
[MESSAGE_ID_REQUIRE_AWS_CONFIG]: "Please apply @checkdigit/aws-config with qualifier/environment instead of creating new instance of {{awsClientName}} directly."
|
|
25
|
+
[MESSAGE_ID_REQUIRE_AWS_CONFIG]: "Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.",
|
|
26
|
+
[MESSAGE_ID_NO_CHECKDIGIT_AWS]: 'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.'
|
|
23
27
|
},
|
|
24
28
|
schema: []
|
|
25
29
|
},
|
|
26
30
|
defaultOptions: [],
|
|
27
31
|
create(context) {
|
|
32
|
+
const { isAwsSdkV3Used } = context.settings;
|
|
33
|
+
const importedAwsClients = /* @__PURE__ */ new Set();
|
|
28
34
|
return {
|
|
29
35
|
ImportDeclaration(node) {
|
|
30
|
-
if (
|
|
36
|
+
if (isAwsSdkV3Used !== true) {
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
if (isCheckdigitAwsModule(node)) {
|
|
40
|
+
context.report({
|
|
41
|
+
node,
|
|
42
|
+
messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS
|
|
43
|
+
});
|
|
31
44
|
return;
|
|
32
45
|
}
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
46
|
+
if (isAwsSdkClientModule(node)) {
|
|
47
|
+
for (const specifier of node.specifiers) {
|
|
48
|
+
if (specifier.type === AST_NODE_TYPES.ImportSpecifier && isAwsClient(specifier.local.name)) {
|
|
49
|
+
importedAwsClients.add(specifier.local.name);
|
|
50
|
+
}
|
|
36
51
|
}
|
|
37
52
|
}
|
|
38
53
|
},
|
|
39
54
|
NewExpression(node) {
|
|
55
|
+
if (isAwsSdkV3Used !== true) {
|
|
56
|
+
return;
|
|
57
|
+
}
|
|
40
58
|
if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
|
|
41
59
|
context.report({
|
|
42
60
|
node,
|
|
@@ -59,8 +77,9 @@ var rule = createRule({
|
|
|
59
77
|
});
|
|
60
78
|
var require_aws_config_default = rule;
|
|
61
79
|
export {
|
|
80
|
+
MESSAGE_ID_NO_CHECKDIGIT_AWS,
|
|
62
81
|
MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
63
82
|
require_aws_config_default as default,
|
|
64
83
|
ruleId
|
|
65
84
|
};
|
|
66
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
85
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL3JlcXVpcmUtYXdzLWNvbmZpZy50cyJdLAogICJtYXBwaW5ncyI6ICI7QUFRQSxTQUFTLGdCQUFnQixtQkFBNkI7QUFDdEQsT0FBTyx5QkFBeUI7QUFFekIsSUFBTSxTQUFTO0FBQ2YsSUFBTSxnQ0FBZ0M7QUFDdEMsSUFBTSwrQkFBK0I7QUFDNUMsSUFBTSxhQUFhLFlBQVksWUFBWSxDQUFDLFNBQVMsb0JBQW9CLElBQUksQ0FBQztBQUU5RSxTQUFTLHFCQUFxQixtQkFBd0Q7QUFDcEYsU0FBTyxrQkFBa0IsT0FBTyxNQUFNLFdBQVcsa0JBQWtCO0FBQ3JFO0FBRUEsU0FBUyxzQkFBc0IsbUJBQXdEO0FBQ3JGLFNBQU8sa0JBQWtCLE9BQU8sVUFBVTtBQUM1QztBQUVBLFNBQVMsWUFBWSxlQUF1QixvQkFBMkM7QUFHckYsU0FDRSxjQUFjLFNBQVMsUUFBUSxNQUFNLHVCQUF1QixVQUFhLG1CQUFtQixJQUFJLGFBQWE7QUFFakg7QUFFQSxJQUFNLE9BQ0osV0FBVztBQUFBLEVBQ1QsTUFBTTtBQUFBLEVBQ04sTUFBTTtBQUFBLElBQ0osTUFBTTtBQUFBLElBQ04sTUFBTTtBQUFBLE1BQ0osYUFDRTtBQUFBLElBQ0o7QUFBQSxJQUNBLFVBQVU7QUFBQSxNQUNSLENBQUMsNkJBQTZCLEdBQzVCO0FBQUEsTUFDRixDQUFDLDRCQUE0QixHQUMzQjtBQUFBLElBQ0o7QUFBQSxJQUNBLFFBQVEsQ0FBQztBQUFBLEVBQ1g7QUFBQSxFQUNBLGdCQUFnQixDQUFDO0FBQUEsRUFDakIsT0FBTyxTQUFTO0FBQ2QsVUFBTSxFQUFFLGVBQWUsSUFBSSxRQUFRO0FBQ25DLFVBQU0scUJBQXFCLG9CQUFJLElBQVk7QUFFM0MsV0FBTztBQUFBLE1BQ0wsa0JBQWtCLE1BQU07QUFDdEIsWUFBSSxtQkFBbUIsTUFBTTtBQUMzQjtBQUFBLFFBQ0Y7QUFFQSxZQUFJLHNCQUFzQixJQUFJLEdBQUc7QUFDL0Isa0JBQVEsT0FBTztBQUFBLFlBQ2I7QUFBQSxZQUNBLFdBQVc7QUFBQSxVQUNiLENBQUM7QUFDRDtBQUFBLFFBQ0Y7QUFFQSxZQUFJLHFCQUFxQixJQUFJLEdBQUc7QUFDOUIscUJBQVcsYUFBYSxLQUFLLFlBQVk7QUFDdkMsZ0JBQUksVUFBVSxTQUFTLGVBQWUsbUJBQW1CLFlBQVksVUFBVSxNQUFNLElBQUksR0FBRztBQUMxRixpQ0FBbUIsSUFBSSxVQUFVLE1BQU0sSUFBSTtBQUFBLFlBQzdDO0FBQUEsVUFDRjtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsTUFFQSxjQUFjLE1BQU07QUFDbEIsWUFBSSxtQkFBbUIsTUFBTTtBQUMzQjtBQUFBLFFBQ0Y7QUFFQSxZQUFJLEtBQUssT0FBTyxTQUFTLGVBQWUsY0FBYyxZQUFZLEtBQUssT0FBTyxNQUFNLGtCQUFrQixHQUFHO0FBQ3ZHLGtCQUFRLE9BQU87QUFBQSxZQUNiO0FBQUEsWUFDQSxXQUFXO0FBQUEsWUFDWCxNQUFNLEVBQUUsZUFBZSxLQUFLLE9BQU8sS0FBSztBQUFBLFVBQzFDLENBQUM7QUFBQSxRQUNILFdBQVcsS0FBSyxPQUFPLFNBQVMsZUFBZSxrQkFBa0I7QUFFL0QsZ0JBQU0sV0FBVyxLQUFLLE9BQU87QUFDN0IsY0FBSSxTQUFTLFNBQVMsZUFBZSxjQUFjLFlBQVksU0FBUyxNQUFNLGtCQUFrQixHQUFHO0FBQ2pHLG9CQUFRLE9BQU87QUFBQSxjQUNiO0FBQUEsY0FDQSxXQUFXO0FBQUEsY0FDWCxNQUFNLEVBQUUsZUFBZSxTQUFTLEtBQUs7QUFBQSxZQUN2QyxDQUFDO0FBQUEsVUFDSDtBQUFBLFFBQ0Y7QUFBQSxNQUNGO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFDRixDQUFDO0FBRUgsSUFBTyw2QkFBUTsiLAogICJuYW1lcyI6IFtdCn0K
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { TSESLint } from '@typescript-eslint/utils';
|
|
2
|
+
export { default as isAwsSdkV3Used } from './is-aws-sdk-v3-used.ts';
|
|
2
3
|
declare const defaultToExport: Exclude<TSESLint.FlatConfig.Plugin, 'config'> & {
|
|
3
4
|
configs: Record<string, TSESLint.FlatConfig.Config[]>;
|
|
4
5
|
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export default function isAwsSdkV3Used(): Promise<boolean>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ESLintUtils } from '@typescript-eslint/utils';
|
|
2
2
|
export declare const ruleId = "require-aws-config";
|
|
3
3
|
export declare const MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
4
|
-
declare const
|
|
4
|
+
export declare const MESSAGE_ID_NO_CHECKDIGIT_AWS = "noCheckdigitAws";
|
|
5
|
+
declare const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS>;
|
|
5
6
|
export default rule;
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/eslint-plugin","version":"7.15.0-PR.134-
|
|
1
|
+
{"name":"@checkdigit/eslint-plugin","version":"7.15.0-PR.134-3323","description":"Check Digit eslint plugins","keywords":["eslint","eslintplugin"],"homepage":"https://github.com/checkdigit/eslint-plugin#readme","bugs":{"url":"https://github.com/checkdigit/eslint-plugin/issues"},"repository":{"type":"git","url":"https://github.com/checkdigit/eslint-plugin"},"license":"MIT","author":"Check Digit, LLC","sideEffects":false,"type":"module","exports":{".":{"types":"./dist-types/index.d.ts","import":"./dist-mjs/index.mjs","default":"./dist-mjs/index.mjs"}},"files":["src","dist-types","dist-mjs","!src/**/test/**","!src/**/*.test.ts","!src/**/*.spec.ts","!dist-types/**/test/**","!dist-types/**/*.test.d.ts","!dist-types/**/*.spec.d.ts","!dist-mjs/**/test/**","!dist-mjs/**/*.test.mjs","!dist-mjs/**/*.spec.mjs","SECURITY.md"],"scripts":{"build:dist-mjs":"rimraf dist-mjs && npx builder --type=module --sourceMap --outDir=dist-mjs && node dist-mjs/index.mjs","build:dist-types":"rimraf dist-types && npx builder --type=types --outDir=dist-types","ci:compile":"tsc --noEmit","ci:coverage":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=true","ci:lint":"npm run lint","ci:style":"npm run prettier","ci:test":"NODE_OPTIONS=\"--disable-warning ExperimentalWarning --experimental-vm-modules\" jest --coverage=false","lint":"eslint --max-warnings 0 .","lint:fix":"eslint --max-warnings 0 --fix .","prepare":"","prepublishOnly":"npm run build:dist-types && npm run build:dist-mjs","prettier":"prettier --ignore-path .gitignore --list-different .","prettier:fix":"prettier --ignore-path .gitignore --write .","test":"npm run ci:compile && npm run ci:test && npm run ci:lint && npm run ci:style"},"prettier":"@checkdigit/prettier-config","jest":{"preset":"@checkdigit/jest-config"},"dependencies":{"@typescript-eslint/type-utils":"^8.45.0","@typescript-eslint/utils":"^8.45.0","http-status-codes":"^2.3.0","ts-api-utils":"^2.1.0"},"devDependencies":{"@checkdigit/jest-config":"^6.0.2","@checkdigit/prettier-config":"^6.1.0","@checkdigit/typescript-config":"^9.3.1","@eslint/js":"^9.36.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.45.0","@typescript-eslint/rule-tester":"^8.45.0","eslint":"^9.36.0","eslint-config-prettier":"^10.1.8","eslint-import-resolver-typescript":"^4.4.4","eslint-plugin-eslint-plugin":"^6.4.0","eslint-plugin-import":"^2.32.0","eslint-plugin-no-only-tests":"^3.3.0","eslint-plugin-no-secrets":"^2.2.1","eslint-plugin-node":"^11.1.0","eslint-plugin-sonarjs":"1.0.4","rimraf":"^6.0.1","typescript-eslint":"^8.45.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=22.15"}}
|
package/src/index.ts
CHANGED
|
@@ -43,6 +43,8 @@ import requireStrictAssert from './require-strict-assert.ts';
|
|
|
43
43
|
import requireAssertMessage from './require-assert-message';
|
|
44
44
|
import requireTsExtensionImportsExports from './require-ts-extension-imports-exports.ts';
|
|
45
45
|
|
|
46
|
+
export { default as isAwsSdkV3Used } from './is-aws-sdk-v3-used.ts';
|
|
47
|
+
|
|
46
48
|
const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
47
49
|
'file-path-comment': filePathComment,
|
|
48
50
|
'no-card-numbers': noCardNumbers,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
// is-aws-sdk-v3-used.ts
|
|
2
|
+
|
|
3
|
+
import { promises as fs } from 'node:fs';
|
|
4
|
+
|
|
5
|
+
interface PackageJson {
|
|
6
|
+
dependencies?: Record<string, string>;
|
|
7
|
+
service?: {
|
|
8
|
+
awsSdkV2?: boolean;
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
let cachedIsAwsSdkV3Used: boolean | undefined;
|
|
13
|
+
|
|
14
|
+
export default async function isAwsSdkV3Used(): Promise<boolean> {
|
|
15
|
+
if (cachedIsAwsSdkV3Used !== undefined) {
|
|
16
|
+
return cachedIsAwsSdkV3Used;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
const packageJson = JSON.parse(await fs.readFile('package.json', 'utf8')) as PackageJson;
|
|
20
|
+
const dependencies = packageJson.dependencies ?? {};
|
|
21
|
+
// eslint-disable-next-line require-atomic-updates
|
|
22
|
+
cachedIsAwsSdkV3Used = Object.keys(dependencies).some((dependency) => dependency.startsWith('@aws-sdk/'));
|
|
23
|
+
return cachedIsAwsSdkV3Used;
|
|
24
|
+
}
|
|
@@ -11,12 +11,17 @@ import getDocumentationUrl from './get-documentation-url.ts';
|
|
|
11
11
|
|
|
12
12
|
export const ruleId = 'require-aws-config';
|
|
13
13
|
export const MESSAGE_ID_REQUIRE_AWS_CONFIG = 'requireAwsConfig';
|
|
14
|
+
export const MESSAGE_ID_NO_CHECKDIGIT_AWS = 'noCheckdigitAws';
|
|
14
15
|
const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
15
16
|
|
|
16
17
|
function isAwsSdkClientModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
17
18
|
return importDeclaration.source.value.startsWith('@aws-sdk/client-');
|
|
18
19
|
}
|
|
19
20
|
|
|
21
|
+
function isCheckdigitAwsModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
22
|
+
return importDeclaration.source.value === '@checkdigit/aws';
|
|
23
|
+
}
|
|
24
|
+
|
|
20
25
|
function isAwsClient(awsClientName: string, importedAwsClients?: Set<string>): boolean {
|
|
21
26
|
// for simplicity, just check if it ends with 'Client'
|
|
22
27
|
// we can consider type checking in the future if needed to verify if it actually extends from AWS SDK's Smithy Client class
|
|
@@ -25,58 +30,76 @@ function isAwsClient(awsClientName: string, importedAwsClients?: Set<string>): b
|
|
|
25
30
|
);
|
|
26
31
|
}
|
|
27
32
|
|
|
28
|
-
const
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
33
|
+
const rule: ESLintUtils.RuleModule<typeof MESSAGE_ID_REQUIRE_AWS_CONFIG | typeof MESSAGE_ID_NO_CHECKDIGIT_AWS> =
|
|
34
|
+
createRule({
|
|
35
|
+
name: ruleId,
|
|
36
|
+
meta: {
|
|
37
|
+
type: 'problem',
|
|
38
|
+
docs: {
|
|
39
|
+
description:
|
|
40
|
+
'Require applying @checkdigit/aws-config with qualifier/environment instead of creating new AWS client instance directly. Also disallow importing from deprecated @checkdigit/aws module.',
|
|
41
|
+
},
|
|
42
|
+
messages: {
|
|
43
|
+
[MESSAGE_ID_REQUIRE_AWS_CONFIG]:
|
|
44
|
+
'Please apply @checkdigit/aws-config with qualifier/environment instead of creating a new instance of {{awsClientName}} directly.',
|
|
45
|
+
[MESSAGE_ID_NO_CHECKDIGIT_AWS]:
|
|
46
|
+
'No longer import from deprecated module "@checkdigit/aws". Please migrate to the official AWS SDK v3 modules.',
|
|
47
|
+
},
|
|
48
|
+
schema: [],
|
|
41
49
|
},
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
return {
|
|
47
|
-
ImportDeclaration(node) {
|
|
48
|
-
if (!isAwsSdkClientModule(node)) {
|
|
49
|
-
return;
|
|
50
|
-
}
|
|
50
|
+
defaultOptions: [],
|
|
51
|
+
create(context) {
|
|
52
|
+
const { isAwsSdkV3Used } = context.settings;
|
|
53
|
+
const importedAwsClients = new Set<string>();
|
|
51
54
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
+
return {
|
|
56
|
+
ImportDeclaration(node) {
|
|
57
|
+
if (isAwsSdkV3Used !== true) {
|
|
58
|
+
return;
|
|
55
59
|
}
|
|
56
|
-
}
|
|
57
|
-
},
|
|
58
60
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
61
|
+
if (isCheckdigitAwsModule(node)) {
|
|
62
|
+
context.report({
|
|
63
|
+
node,
|
|
64
|
+
messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS,
|
|
65
|
+
});
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (isAwsSdkClientModule(node)) {
|
|
70
|
+
for (const specifier of node.specifiers) {
|
|
71
|
+
if (specifier.type === AST_NODE_TYPES.ImportSpecifier && isAwsClient(specifier.local.name)) {
|
|
72
|
+
importedAwsClients.add(specifier.local.name);
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
},
|
|
77
|
+
|
|
78
|
+
NewExpression(node) {
|
|
79
|
+
if (isAwsSdkV3Used !== true) {
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
|
|
70
84
|
context.report({
|
|
71
85
|
node,
|
|
72
86
|
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
73
|
-
data: { awsClientName:
|
|
87
|
+
data: { awsClientName: node.callee.name },
|
|
74
88
|
});
|
|
89
|
+
} else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
|
|
90
|
+
// Handle `new AWS.DynamoDBClient()` style (MemberExpression)
|
|
91
|
+
const property = node.callee.property;
|
|
92
|
+
if (property.type === AST_NODE_TYPES.Identifier && isAwsClient(property.name, importedAwsClients)) {
|
|
93
|
+
context.report({
|
|
94
|
+
node,
|
|
95
|
+
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
96
|
+
data: { awsClientName: property.name },
|
|
97
|
+
});
|
|
98
|
+
}
|
|
75
99
|
}
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
});
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
},
|
|
103
|
+
});
|
|
81
104
|
|
|
82
105
|
export default rule;
|