@horietakehiro/aws-cdk-utul 0.9.0 → 0.10.0

package/README.md

@@ -6,7 +6,7 @@
    </a>
 </p>
 
-**aws-cdk-utul(unit test utility library) makes it faster, more efficient, and less mistaken for you to code AWS CDK unit tests.**
+**aws-cdk-utul(unit test utility library) makes it faster, more efficient with less mistakes for you to code AWS CDK unit tests.**
 
 ---
 
@@ -16,16 +16,15 @@
 
 ### TypedTemplate
 
-When you code AWS CDK unit tests in some IDE(e.g. VSCode), `TypedTemplate` class provides you a type hinting and type validation for (alomost) all AWS CloudFormation resource types.
+`TypedTemplate` class provides you proper type definitions for (almost) all AWS CloudFormation resource types. So you can easily and quickly code AWS CDK unit tests without trivial mistakes and googling.
 
 ![type-hinting-1](./docs/type-hinting-1.png)
 
-The key concepts are:
-- You can define unit tests for your AWS CloudFormation templates by using well-type-defined methods via `TypedTemplate` class - a proxy for original `Template` class.
-- Returned values from methods of `TypedTemplate` are also well-type-defined.
-- You can still use `Matcher` and other arbitrary objects too.
+- You can use by just wrapping AWS CDK's `Template` class.
+- You can use all methods implemented by AWS CDK's `Template` class with proper type definitions.
+- Return values of some methods - e.g. `findResources` - are changed from original ones, so that succeeding processes can handle and access them more easily.
+- You can still use AWS CDK's `Matcher` class and other arbitrary objects too.
 
-So you can quickly code AWS CDK unit tests without any trivial mistakes and googling.
 ```js
 import { Stack } from "aws-cdk-lib";
 import { Template } from "aws-cdk-lib/assertions";
@@ -56,7 +55,7 @@ subnets.forEach((sn) => {
 
 ### ExtraMatch
 
-`ExtraMatch` class provides you some kind of a syntax sugar for original `Match` class.
+`ExtraMatch` class provides you some kind of a syntax sugar for AWS CDK's `Match` class.
 
 ```js
 import { ExtraMatch } from "@horietakehiro/aws-cdk-utul/lib/assertions"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@horietakehiro/aws-cdk-utul",
   "license": "MIT",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/horietakehiro/aws-cdk-utul"
@@ -21,17 +21,17 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "~5.3.3"
-  },
-  "dependencies": {
+    "typescript": "~5.3.3",
     "@types/decompress": "^4.2.7",
     "@types/node-fetch": "^2.6.11",
-    "aws-cdk-lib": "2.X.0",
-    "constructs": "^10.0.0",
     "decompress": "^4.2.1",
     "https-proxy-agent": "^7.0.5",
     "json-schema-to-typescript": "^15.0.2",
     "node-fetch": "^2.7.0",
     "source-map-support": "^0.5.21"
+  },
+  "dependencies": {
+    "aws-cdk-lib": "2.X.0",
+    "constructs": "^10.0.0"
   }
 }

package/.env

@@ -1 +0,0 @@
-export NODE_OPTIONS="$NODE_OPTIONS --experimental-vm-modules"

package/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "commonjs",
-    "lib": [
-      "es2020",
-      "dom"
-    ],
-    "declaration": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": false,
-    "inlineSourceMap": true,
-    "inlineSources": true,
-    "experimentalDecorators": true,
-    "strictPropertyInitialization": false,
-    // "emitDeclarationOnly": true,
-    "typeRoots": [
-      "./node_modules/@types",
-      // "./lib/types"
-    ],
-    // "outDir": "./dist"
-  },
-  "include": [
-    "./lib",
-    "./index.ts",
-  ],
-  "exclude": [
-    "node_modules",
-    "cdk.out",
-    "test",
-    "scripts",
-    "bin",
-
-  ]
-}