@checkdigit/eslint-plugin 7.15.0-PR.136-c0a3 → 7.16.0-PR.136-c0c4
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/aws/is-aws-sdk-v3-used.mjs +16 -0
- package/dist-mjs/aws/require-aws-config.mjs +85 -0
- package/dist-mjs/index.mjs +10 -4
- package/dist-types/aws/is-aws-sdk-v3-used.d.ts +1 -0
- package/dist-types/aws/require-aws-config.d.ts +6 -0
- package/dist-types/index.d.ts +1 -0
- package/package.json +1 -1
- package/src/aws/is-aws-sdk-v3-used.ts +24 -0
- package/src/aws/require-aws-config.ts +105 -0
- package/src/index.ts +6 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// src/aws/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,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL2F3cy9pcy1hd3Mtc2RrLXYzLXVzZWQudHMiXSwKICAibWFwcGluZ3MiOiAiO0FBRUEsU0FBUyxZQUFZLFVBQVU7QUFTL0IsSUFBSTtBQUVKLGVBQU8saUJBQTBEO0FBQy9ELE1BQUkseUJBQXlCLFFBQVc7QUFDdEMsV0FBTztBQUFBLEVBQ1Q7QUFFQSxRQUFNLGNBQWMsS0FBSyxNQUFNLE1BQU0sR0FBRyxTQUFTLGdCQUFnQixNQUFNLENBQUM7QUFDeEUsUUFBTSxlQUFlLFlBQVksZ0JBQWdCLENBQUM7QUFFbEQseUJBQXVCLE9BQU8sS0FBSyxZQUFZLEVBQUUsS0FBSyxDQUFDLGVBQWUsV0FBVyxXQUFXLFdBQVcsQ0FBQztBQUN4RyxTQUFPO0FBQ1Q7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
// src/aws/require-aws-config.ts
|
|
2
|
+
import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
|
|
3
|
+
import getDocumentationUrl from "../get-documentation-url.mjs";
|
|
4
|
+
var ruleId = "require-aws-config";
|
|
5
|
+
var MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
6
|
+
var MESSAGE_ID_NO_CHECKDIGIT_AWS = "noCheckdigitAws";
|
|
7
|
+
var createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
8
|
+
function isAwsSdkClientModule(importDeclaration) {
|
|
9
|
+
return importDeclaration.source.value.startsWith("@aws-sdk/client-");
|
|
10
|
+
}
|
|
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));
|
|
16
|
+
}
|
|
17
|
+
var rule = createRule({
|
|
18
|
+
name: ruleId,
|
|
19
|
+
meta: {
|
|
20
|
+
type: "problem",
|
|
21
|
+
docs: {
|
|
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."
|
|
23
|
+
},
|
|
24
|
+
messages: {
|
|
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.'
|
|
27
|
+
},
|
|
28
|
+
schema: []
|
|
29
|
+
},
|
|
30
|
+
defaultOptions: [],
|
|
31
|
+
create(context) {
|
|
32
|
+
const { isAwsSdkV3Used } = context.settings;
|
|
33
|
+
const importedAwsClients = /* @__PURE__ */ new Set();
|
|
34
|
+
return {
|
|
35
|
+
ImportDeclaration(node) {
|
|
36
|
+
if (isAwsSdkV3Used !== true) {
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
if (isCheckdigitAwsModule(node)) {
|
|
40
|
+
context.report({
|
|
41
|
+
node,
|
|
42
|
+
messageId: MESSAGE_ID_NO_CHECKDIGIT_AWS
|
|
43
|
+
});
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
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
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
NewExpression(node) {
|
|
55
|
+
if (isAwsSdkV3Used !== true) {
|
|
56
|
+
return;
|
|
57
|
+
}
|
|
58
|
+
if (node.callee.type === AST_NODE_TYPES.Identifier && isAwsClient(node.callee.name, importedAwsClients)) {
|
|
59
|
+
context.report({
|
|
60
|
+
node,
|
|
61
|
+
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
62
|
+
data: { awsClientName: node.callee.name }
|
|
63
|
+
});
|
|
64
|
+
} else if (node.callee.type === AST_NODE_TYPES.MemberExpression) {
|
|
65
|
+
const property = node.callee.property;
|
|
66
|
+
if (property.type === AST_NODE_TYPES.Identifier && isAwsClient(property.name, importedAwsClients)) {
|
|
67
|
+
context.report({
|
|
68
|
+
node,
|
|
69
|
+
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
70
|
+
data: { awsClientName: property.name }
|
|
71
|
+
});
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
});
|
|
78
|
+
var require_aws_config_default = rule;
|
|
79
|
+
export {
|
|
80
|
+
MESSAGE_ID_NO_CHECKDIGIT_AWS,
|
|
81
|
+
MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
82
|
+
require_aws_config_default as default,
|
|
83
|
+
ruleId
|
|
84
|
+
};
|
|
85
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vLi4vc3JjL2F3cy9yZXF1aXJlLWF3cy1jb25maWcudHMiXSwKICAibWFwcGluZ3MiOiAiO0FBUUEsU0FBUyxnQkFBZ0IsbUJBQTZCO0FBQ3RELE9BQU8seUJBQXlCO0FBRXpCLElBQU0sU0FBUztBQUNmLElBQU0sZ0NBQWdDO0FBQ3RDLElBQU0sK0JBQStCO0FBQzVDLElBQU0sYUFBYSxZQUFZLFlBQVksQ0FBQyxTQUFTLG9CQUFvQixJQUFJLENBQUM7QUFFOUUsU0FBUyxxQkFBcUIsbUJBQXdEO0FBQ3BGLFNBQU8sa0JBQWtCLE9BQU8sTUFBTSxXQUFXLGtCQUFrQjtBQUNyRTtBQUVBLFNBQVMsc0JBQXNCLG1CQUF3RDtBQUNyRixTQUFPLGtCQUFrQixPQUFPLFVBQVU7QUFDNUM7QUFFQSxTQUFTLFlBQVksZUFBdUIsb0JBQTJDO0FBR3JGLFNBQ0UsY0FBYyxTQUFTLFFBQVEsTUFBTSx1QkFBdUIsVUFBYSxtQkFBbUIsSUFBSSxhQUFhO0FBRWpIO0FBRUEsSUFBTSxPQUNKLFdBQVc7QUFBQSxFQUNULE1BQU07QUFBQSxFQUNOLE1BQU07QUFBQSxJQUNKLE1BQU07QUFBQSxJQUNOLE1BQU07QUFBQSxNQUNKLGFBQ0U7QUFBQSxJQUNKO0FBQUEsSUFDQSxVQUFVO0FBQUEsTUFDUixDQUFDLDZCQUE2QixHQUM1QjtBQUFBLE1BQ0YsQ0FBQyw0QkFBNEIsR0FDM0I7QUFBQSxJQUNKO0FBQUEsSUFDQSxRQUFRLENBQUM7QUFBQSxFQUNYO0FBQUEsRUFDQSxnQkFBZ0IsQ0FBQztBQUFBLEVBQ2pCLE9BQU8sU0FBUztBQUNkLFVBQU0sRUFBRSxlQUFlLElBQUksUUFBUTtBQUNuQyxVQUFNLHFCQUFxQixvQkFBSSxJQUFZO0FBRTNDLFdBQU87QUFBQSxNQUNMLGtCQUFrQixNQUFNO0FBQ3RCLFlBQUksbUJBQW1CLE1BQU07QUFDM0I7QUFBQSxRQUNGO0FBRUEsWUFBSSxzQkFBc0IsSUFBSSxHQUFHO0FBQy9CLGtCQUFRLE9BQU87QUFBQSxZQUNiO0FBQUEsWUFDQSxXQUFXO0FBQUEsVUFDYixDQUFDO0FBQ0Q7QUFBQSxRQUNGO0FBRUEsWUFBSSxxQkFBcUIsSUFBSSxHQUFHO0FBQzlCLHFCQUFXLGFBQWEsS0FBSyxZQUFZO0FBQ3ZDLGdCQUFJLFVBQVUsU0FBUyxlQUFlLG1CQUFtQixZQUFZLFVBQVUsTUFBTSxJQUFJLEdBQUc7QUFDMUYsaUNBQW1CLElBQUksVUFBVSxNQUFNLElBQUk7QUFBQSxZQUM3QztBQUFBLFVBQ0Y7QUFBQSxRQUNGO0FBQUEsTUFDRjtBQUFBLE1BRUEsY0FBYyxNQUFNO0FBQ2xCLFlBQUksbUJBQW1CLE1BQU07QUFDM0I7QUFBQSxRQUNGO0FBRUEsWUFBSSxLQUFLLE9BQU8sU0FBUyxlQUFlLGNBQWMsWUFBWSxLQUFLLE9BQU8sTUFBTSxrQkFBa0IsR0FBRztBQUN2RyxrQkFBUSxPQUFPO0FBQUEsWUFDYjtBQUFBLFlBQ0EsV0FBVztBQUFBLFlBQ1gsTUFBTSxFQUFFLGVBQWUsS0FBSyxPQUFPLEtBQUs7QUFBQSxVQUMxQyxDQUFDO0FBQUEsUUFDSCxXQUFXLEtBQUssT0FBTyxTQUFTLGVBQWUsa0JBQWtCO0FBRS9ELGdCQUFNLFdBQVcsS0FBSyxPQUFPO0FBQzdCLGNBQUksU0FBUyxTQUFTLGVBQWUsY0FBYyxZQUFZLFNBQVMsTUFBTSxrQkFBa0IsR0FBRztBQUNqRyxvQkFBUSxPQUFPO0FBQUEsY0FDYjtBQUFBLGNBQ0EsV0FBVztBQUFBLGNBQ1gsTUFBTSxFQUFFLGVBQWUsU0FBUyxLQUFLO0FBQUEsWUFDdkMsQ0FBQztBQUFBLFVBQ0g7QUFBQSxRQUNGO0FBQUEsTUFDRjtBQUFBLElBQ0Y7QUFBQSxFQUNGO0FBQ0YsQ0FBQztBQUVILElBQU8sNkJBQVE7IiwKICAibmFtZXMiOiBbXQp9Cg==
|
package/dist-mjs/index.mjs
CHANGED
|
@@ -18,6 +18,7 @@ import requireServiceCallResponseDeclaration, {
|
|
|
18
18
|
ruleId as requireServiceCallResponseDeclarationRuleId
|
|
19
19
|
} from "./require-service-call-response-declaration.mjs";
|
|
20
20
|
import requireConsistentRead, { ruleId as requireConsistentReadRuleId } from "./aws/require-consistent-read.mjs";
|
|
21
|
+
import requireAwsConfig, { ruleId as requireAwsConfigRuleId } from "./aws/require-aws-config.mjs";
|
|
21
22
|
import filePathComment from "./file-path-comment.mjs";
|
|
22
23
|
import noCardNumbers from "./no-card-numbers.mjs";
|
|
23
24
|
import noEnum from "./no-enum.mjs";
|
|
@@ -33,6 +34,7 @@ import requireAssertPredicateRejectsThrows from "./require-assert-predicate-reje
|
|
|
33
34
|
import requireStrictAssert from "./require-strict-assert.mjs";
|
|
34
35
|
import requireAssertMessage from "./require-assert-message.mjs";
|
|
35
36
|
import requireTsExtensionImportsExports from "./require-ts-extension-imports-exports.mjs";
|
|
37
|
+
import { default as default2 } from "./aws/is-aws-sdk-v3-used.mjs";
|
|
36
38
|
var rules = {
|
|
37
39
|
"file-path-comment": filePathComment,
|
|
38
40
|
"no-card-numbers": noCardNumbers,
|
|
@@ -57,6 +59,7 @@ var rules = {
|
|
|
57
59
|
[noDuplicatedImportsRuleId]: noDuplicatedImports,
|
|
58
60
|
[noServeRuntimeRuleId]: noServeRuntime,
|
|
59
61
|
[requireServiceCallResponseDeclarationRuleId]: requireServiceCallResponseDeclaration,
|
|
62
|
+
[requireAwsConfigRuleId]: requireAwsConfig,
|
|
60
63
|
[requireFixedServicesImportRuleId]: requireFixedServicesImport,
|
|
61
64
|
[requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
|
|
62
65
|
[requireConsistentReadRuleId]: requireConsistentRead
|
|
@@ -97,7 +100,8 @@ var configs = {
|
|
|
97
100
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: "error",
|
|
98
101
|
[`@checkdigit/${noServeRuntimeRuleId}`]: "error",
|
|
99
102
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: "error",
|
|
100
|
-
[`@checkdigit/${requireConsistentReadRuleId}`]: "error"
|
|
103
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: "error",
|
|
104
|
+
[`@checkdigit/${requireAwsConfigRuleId}`]: "error"
|
|
101
105
|
}
|
|
102
106
|
}
|
|
103
107
|
],
|
|
@@ -133,7 +137,8 @@ var configs = {
|
|
|
133
137
|
[`@checkdigit/${requireTypeOutOfTypeOnlyImportsRuleId}`]: "error",
|
|
134
138
|
[`@checkdigit/${noServeRuntimeRuleId}`]: "off",
|
|
135
139
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: "off",
|
|
136
|
-
[`@checkdigit/${requireConsistentReadRuleId}`]: "off"
|
|
140
|
+
[`@checkdigit/${requireConsistentReadRuleId}`]: "off",
|
|
141
|
+
[`@checkdigit/${requireAwsConfigRuleId}`]: "off"
|
|
137
142
|
}
|
|
138
143
|
}
|
|
139
144
|
]
|
|
@@ -144,6 +149,7 @@ var defaultToExport = {
|
|
|
144
149
|
};
|
|
145
150
|
var index_default = defaultToExport;
|
|
146
151
|
export {
|
|
147
|
-
index_default as default
|
|
152
|
+
index_default as default,
|
|
153
|
+
default2 as isAwsSdkV3Used
|
|
148
154
|
};
|
|
149
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
155
|
+
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgIm1hcHBpbmdzIjogIjtBQVVBLE9BQU8sd0JBQXdCLFVBQVUsa0NBQWtDO0FBQzNFLE9BQU8sdUJBQXVCLFVBQVUsaUNBQWlDO0FBQ3pFLE9BQU8seUJBQXlCLFVBQVUsbUNBQW1DO0FBQzdFLE9BQU8sMkJBQTJCLFVBQVUscUNBQXFDO0FBQ2pGLE9BQU8sd0JBQXdCO0FBQy9CLE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTztBQUFBLEVBQ0wsVUFBVTtBQUFBLE9BQ0w7QUFDUCxPQUFPO0FBQUEsRUFDTCxVQUFVO0FBQUEsT0FDTDtBQUNQLE9BQU8sa0JBQWtCLFVBQVUsNEJBQTRCO0FBQy9ELE9BQU87QUFBQSxFQUNMLFVBQVU7QUFBQSxPQUNMO0FBQ1AsT0FBTyx5QkFBeUIsVUFBVSxtQ0FBbUM7QUFDN0UsT0FBTyxvQkFBb0IsVUFBVSw4QkFBOEI7QUFDbkUsT0FBTyxxQkFBcUI7QUFDNUIsT0FBTyxtQkFBbUI7QUFDMUIsT0FBTyxZQUFZO0FBQ25CLE9BQU8sbUJBQW1CO0FBQzFCLE9BQU8sb0JBQW9CO0FBQzNCLE9BQU8sa0JBQWtCO0FBQ3pCLE9BQU8sWUFBWTtBQUNuQixPQUFPLFlBQVk7QUFDbkIsT0FBTyxzQkFBc0I7QUFDN0IsT0FBTywyQkFBMkI7QUFDbEMsT0FBTyxrQkFBa0I7QUFDekIsT0FBTyx5Q0FBeUM7QUFDaEQsT0FBTyx5QkFBeUI7QUFDaEMsT0FBTywwQkFBMEI7QUFDakMsT0FBTyxzQ0FBc0M7QUFFN0MsU0FBb0IsV0FBWEEsZ0JBQWlDO0FBRTFDLElBQU0sUUFBc0Q7QUFBQSxFQUMxRCxxQkFBcUI7QUFBQSxFQUNyQixtQkFBbUI7QUFBQSxFQUNuQixXQUFXO0FBQUEsRUFDWCxxQkFBcUI7QUFBQSxFQUNyQix5QkFBeUI7QUFBQSxFQUN6QixXQUFXO0FBQUEsRUFDWCxXQUFXO0FBQUEsRUFDWCwwQkFBMEI7QUFBQSxFQUMxQix5QkFBeUI7QUFBQSxFQUN6Qix3Q0FBd0M7QUFBQSxFQUN4QyxrQkFBa0I7QUFBQSxFQUNsQixzQkFBc0I7QUFBQSxFQUN0QixtQkFBbUI7QUFBQSxFQUNuQiw4QkFBOEI7QUFBQSxFQUM5QiwyQ0FBMkM7QUFBQSxFQUMzQywyQkFBMkI7QUFBQSxFQUMzQixDQUFDLDBCQUEwQixHQUFHO0FBQUEsRUFDOUIsQ0FBQyw2QkFBNkIsR0FBRztBQUFBLEVBQ2pDLENBQUMsMkJBQTJCLEdBQUc7QUFBQSxFQUMvQixDQUFDLGdDQUFnQyxHQUFHO0FBQUEsRUFDcEMsQ0FBQyx5QkFBeUIsR0FBRztBQUFBLEVBQzdCLENBQUMsb0JBQW9CLEdBQUc7QUFBQSxFQUN4QixDQUFDLDJDQUEyQyxHQUFHO0FBQUEsRUFDL0MsQ0FBQyxzQkFBc0IsR0FBRztBQUFBLEVBQzFCLENBQUMsZ0NBQWdDLEdBQUc7QUFBQSxFQUNwQyxDQUFDLHFDQUFxQyxHQUFHO0FBQUEsRUFDekMsQ0FBQywyQkFBMkIsR0FBRztBQUNqQztBQUVBLElBQU0sU0FBcUM7QUFBQSxFQUN6QztBQUNGO0FBRUEsSUFBTSxVQUF3RDtBQUFBLEVBQzVELEtBQUs7QUFBQSxJQUNIO0FBQUEsTUFDRSxPQUFPLENBQUMsU0FBUztBQUFBLE1BQ2pCLFNBQVM7QUFBQSxRQUNQLGVBQWU7QUFBQSxNQUNqQjtBQUFBLE1BQ0EsT0FBTztBQUFBLFFBQ0wsK0JBQStCO0FBQUEsUUFDL0IsdUJBQXVCO0FBQUEsUUFDdkIsaUNBQWlDO0FBQUEsUUFDakMsaUNBQWlDO0FBQUEsUUFDakMscUNBQXFDO0FBQUEsUUFDckMsdUJBQXVCO0FBQUEsUUFDdkIsdUJBQXVCO0FBQUEsUUFDdkIsc0NBQXNDO0FBQUEsUUFDdEMscUNBQXFDO0FBQUEsUUFDckMsb0RBQW9EO0FBQUEsUUFDcEQsa0NBQWtDO0FBQUEsUUFDbEMsK0JBQStCO0FBQUEsUUFDL0IsMENBQTBDO0FBQUEsUUFDMUMsdURBQXVEO0FBQUEsUUFDdkQsdUNBQXVDO0FBQUEsUUFDdkMsOEJBQThCO0FBQUEsUUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxRQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLFFBQ2xELENBQUMsZUFBZSwyQkFBMkIsRUFBRSxHQUFHO0FBQUEsUUFDaEQsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLFFBQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsUUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxRQUMxRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLFFBQ3pDLENBQUMsZUFBZSwyQ0FBMkMsRUFBRSxHQUFHO0FBQUEsUUFDaEUsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsc0JBQXNCLEVBQUUsR0FBRztBQUFBLE1BQzdDO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLGFBQWE7QUFBQSxJQUNYO0FBQUEsTUFDRSxPQUFPLENBQUMsU0FBUztBQUFBLE1BQ2pCLFNBQVM7QUFBQSxRQUNQLGVBQWU7QUFBQSxNQUNqQjtBQUFBLE1BQ0EsT0FBTztBQUFBLFFBQ0wsK0JBQStCO0FBQUEsUUFDL0IsdUJBQXVCO0FBQUEsUUFDdkIsaUNBQWlDO0FBQUEsUUFDakMsaUNBQWlDO0FBQUEsUUFDakMscUNBQXFDO0FBQUEsUUFDckMsdUJBQXVCO0FBQUEsUUFDdkIsdUJBQXVCO0FBQUEsUUFDdkIsc0NBQXNDO0FBQUEsUUFDdEMscUNBQXFDO0FBQUEsUUFDckMsb0RBQW9EO0FBQUEsUUFDcEQsa0NBQWtDO0FBQUEsUUFDbEMsK0JBQStCO0FBQUEsUUFDL0IsMENBQTBDO0FBQUEsUUFDMUMsdURBQXVEO0FBQUEsUUFDdkQsdUNBQXVDO0FBQUEsUUFDdkMsOEJBQThCO0FBQUEsUUFDOUIsQ0FBQyxlQUFlLDBCQUEwQixFQUFFLEdBQUc7QUFBQSxRQUMvQyxDQUFDLGVBQWUsNkJBQTZCLEVBQUUsR0FBRztBQUFBLFFBQ2xELENBQUMsZUFBZSwyQkFBMkIsRUFBRSxHQUFHO0FBQUEsUUFDaEQsQ0FBQyxlQUFlLGdDQUFnQyxFQUFFLEdBQUc7QUFBQSxRQUNyRCxDQUFDLGVBQWUseUJBQXlCLEVBQUUsR0FBRztBQUFBLFFBQzlDLENBQUMsZUFBZSxnQ0FBZ0MsRUFBRSxHQUFHO0FBQUEsUUFDckQsQ0FBQyxlQUFlLHFDQUFxQyxFQUFFLEdBQUc7QUFBQSxRQUMxRCxDQUFDLGVBQWUsb0JBQW9CLEVBQUUsR0FBRztBQUFBLFFBQ3pDLENBQUMsZUFBZSwyQ0FBMkMsRUFBRSxHQUFHO0FBQUEsUUFDaEUsQ0FBQyxlQUFlLDJCQUEyQixFQUFFLEdBQUc7QUFBQSxRQUNoRCxDQUFDLGVBQWUsc0JBQXNCLEVBQUUsR0FBRztBQUFBLE1BQzdDO0FBQUEsSUFDRjtBQUFBLEVBQ0Y7QUFDRjtBQUVBLElBQU0sa0JBRUY7QUFBQSxFQUNGLEdBQUc7QUFBQSxFQUNIO0FBQ0Y7QUFDQSxJQUFPLGdCQUFROyIsCiAgIm5hbWVzIjogWyJkZWZhdWx0Il0KfQo=
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export default function isAwsSdkV3Used(): Promise<boolean>;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { ESLintUtils } from '@typescript-eslint/utils';
|
|
2
|
+
export declare const ruleId = "require-aws-config";
|
|
3
|
+
export declare const MESSAGE_ID_REQUIRE_AWS_CONFIG = "requireAwsConfig";
|
|
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>;
|
|
6
|
+
export default rule;
|
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 './aws/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
|
};
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@checkdigit/eslint-plugin","version":"7.
|
|
1
|
+
{"name":"@checkdigit/eslint-plugin","version":"7.16.0-PR.136-c0c4","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.46.0","@typescript-eslint/utils":"^8.46.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.2","@eslint/js":"^9.37.0","@types/eslint":"^9.6.1","@types/eslint-config-prettier":"^6.11.3","@typescript-eslint/parser":"^8.46.0","@typescript-eslint/rule-tester":"^8.46.0","eslint":"^9.37.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.46.0"},"peerDependencies":{"eslint":">=9 <10"},"engines":{"node":">=22.18"}}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
// aws/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
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
// aws/require-aws-config.ts
|
|
2
|
+
|
|
3
|
+
/*
|
|
4
|
+
* Copyright (c) 2021-2025 Check Digit, LLC
|
|
5
|
+
*
|
|
6
|
+
* This code is licensed under the MIT license (see LICENSE.txt for details).
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
import { AST_NODE_TYPES, ESLintUtils, TSESTree } from '@typescript-eslint/utils';
|
|
10
|
+
import getDocumentationUrl from '../get-documentation-url.ts';
|
|
11
|
+
|
|
12
|
+
export const ruleId = 'require-aws-config';
|
|
13
|
+
export const MESSAGE_ID_REQUIRE_AWS_CONFIG = 'requireAwsConfig';
|
|
14
|
+
export const MESSAGE_ID_NO_CHECKDIGIT_AWS = 'noCheckdigitAws';
|
|
15
|
+
const createRule = ESLintUtils.RuleCreator((name) => getDocumentationUrl(name));
|
|
16
|
+
|
|
17
|
+
function isAwsSdkClientModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
18
|
+
return importDeclaration.source.value.startsWith('@aws-sdk/client-');
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
function isCheckdigitAwsModule(importDeclaration: TSESTree.ImportDeclaration): boolean {
|
|
22
|
+
return importDeclaration.source.value === '@checkdigit/aws';
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
function isAwsClient(awsClientName: string, importedAwsClients?: Set<string>): boolean {
|
|
26
|
+
// for simplicity, just check if it ends with 'Client'
|
|
27
|
+
// we can consider type checking in the future if needed to verify if it actually extends from AWS SDK's Smithy Client class
|
|
28
|
+
return (
|
|
29
|
+
awsClientName.endsWith('Client') && (importedAwsClients === undefined || importedAwsClients.has(awsClientName))
|
|
30
|
+
);
|
|
31
|
+
}
|
|
32
|
+
|
|
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: [],
|
|
49
|
+
},
|
|
50
|
+
defaultOptions: [],
|
|
51
|
+
create(context) {
|
|
52
|
+
const { isAwsSdkV3Used } = context.settings;
|
|
53
|
+
const importedAwsClients = new Set<string>();
|
|
54
|
+
|
|
55
|
+
return {
|
|
56
|
+
ImportDeclaration(node) {
|
|
57
|
+
if (isAwsSdkV3Used !== true) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
|
|
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)) {
|
|
84
|
+
context.report({
|
|
85
|
+
node,
|
|
86
|
+
messageId: MESSAGE_ID_REQUIRE_AWS_CONFIG,
|
|
87
|
+
data: { awsClientName: node.callee.name },
|
|
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
|
+
}
|
|
99
|
+
}
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
},
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
export default rule;
|
package/src/index.ts
CHANGED
|
@@ -27,6 +27,7 @@ import requireServiceCallResponseDeclaration, {
|
|
|
27
27
|
ruleId as requireServiceCallResponseDeclarationRuleId,
|
|
28
28
|
} from './require-service-call-response-declaration.ts';
|
|
29
29
|
import requireConsistentRead, { ruleId as requireConsistentReadRuleId } from './aws/require-consistent-read.ts';
|
|
30
|
+
import requireAwsConfig, { ruleId as requireAwsConfigRuleId } from './aws/require-aws-config.ts';
|
|
30
31
|
import filePathComment from './file-path-comment.ts';
|
|
31
32
|
import noCardNumbers from './no-card-numbers.ts';
|
|
32
33
|
import noEnum from './no-enum.ts';
|
|
@@ -43,6 +44,8 @@ import requireStrictAssert from './require-strict-assert.ts';
|
|
|
43
44
|
import requireAssertMessage from './require-assert-message';
|
|
44
45
|
import requireTsExtensionImportsExports from './require-ts-extension-imports-exports.ts';
|
|
45
46
|
|
|
47
|
+
export { default as isAwsSdkV3Used } from './aws/is-aws-sdk-v3-used.ts';
|
|
48
|
+
|
|
46
49
|
const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
47
50
|
'file-path-comment': filePathComment,
|
|
48
51
|
'no-card-numbers': noCardNumbers,
|
|
@@ -67,6 +70,7 @@ const rules: Record<string, TSESLint.LooseRuleDefinition> = {
|
|
|
67
70
|
[noDuplicatedImportsRuleId]: noDuplicatedImports,
|
|
68
71
|
[noServeRuntimeRuleId]: noServeRuntime,
|
|
69
72
|
[requireServiceCallResponseDeclarationRuleId]: requireServiceCallResponseDeclaration,
|
|
73
|
+
[requireAwsConfigRuleId]: requireAwsConfig,
|
|
70
74
|
[requireFixedServicesImportRuleId]: requireFixedServicesImport,
|
|
71
75
|
[requireTypeOutOfTypeOnlyImportsRuleId]: requireTypeOutOfTypeOnlyImports,
|
|
72
76
|
[requireConsistentReadRuleId]: requireConsistentRead,
|
|
@@ -110,6 +114,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
110
114
|
[`@checkdigit/${noServeRuntimeRuleId}`]: 'error',
|
|
111
115
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: 'error',
|
|
112
116
|
[`@checkdigit/${requireConsistentReadRuleId}`]: 'error',
|
|
117
|
+
[`@checkdigit/${requireAwsConfigRuleId}`]: 'error',
|
|
113
118
|
},
|
|
114
119
|
},
|
|
115
120
|
],
|
|
@@ -146,6 +151,7 @@ const configs: Record<string, TSESLint.FlatConfig.Config[]> = {
|
|
|
146
151
|
[`@checkdigit/${noServeRuntimeRuleId}`]: 'off',
|
|
147
152
|
[`@checkdigit/${requireServiceCallResponseDeclarationRuleId}`]: 'off',
|
|
148
153
|
[`@checkdigit/${requireConsistentReadRuleId}`]: 'off',
|
|
154
|
+
[`@checkdigit/${requireAwsConfigRuleId}`]: 'off',
|
|
149
155
|
},
|
|
150
156
|
},
|
|
151
157
|
],
|