Stop ignoring cdk.context.json (#1851)

AaronMoat · 72636c · web-flow · commit ae3a339f790d · 2025-04-08T22:07:51.000Z
Co-authored-by: Ryan Ling &lt;ryan@outlook.com.au&gt;
diff --git a/.changeset/cuddly-sides-grab.md b/.changeset/cuddly-sides-grab.md
@@ -0,0 +1,9 @@
+---
+'skuba': minor
+---
+
+format, lint: Remove `cdk.context.json` from managed `.gitignore`
+
+AWS CDK generates a `cdk.context.json` file when running commands like `cdk synth` or `cdk deploy`. This file is [recommended to be included in source control](https://docs.aws.amazon.com/cdk/v2/guide/context.html#context_construct).
+
+If this change is incompatible with your project's setup, manually add `cdk.context.json` back to your `.gitignore` file, outside of the **skuba**-managed section.
diff --git a/.gitignore b/.gitignore
@@ -6,7 +6,6 @@
 .cdk.staging/
 .serverless/
 cdk.out/
-cdk.context.json
 node_modules*/
 
 /coverage*/
diff --git a/package.json b/package.json
@@ -31,9 +31,11 @@
     "build": "scripts/build.sh",
     "changeset": "changeset",
     "deploy": "scripts/deploy.sh",
-    "format": "pnpm --silent skuba format",
-    "lint": "pnpm --silent skuba lint && pnpm --silent lint:md",
+    "format": "pnpm --silent skuba format && pnpm format:packages",
+    "format:packages": "pnpm --filter '!./template/**' format",
+    "lint": "pnpm --silent skuba lint && pnpm lint:packages && pnpm --silent lint:md",
     "lint:md": "remark --frail --quiet .",
+    "lint:packages": "pnpm --filter '!./template/**' lint",
     "prepack": "pnpm --filter './template/**' exec rm -rf node_modules",
     "release": "pnpm --silent build && changeset publish",
     "skuba": "pnpm --silent build && pnpm --silent skuba:exec",
diff --git a/packages/eslint-config-skuba/.gitignore b/packages/eslint-config-skuba/.gitignore
@@ -6,7 +6,6 @@
 .cdk.staging/
 .serverless/
 cdk.out/
-cdk.context.json
 node_modules*/
 
 /coverage*/
diff --git a/packages/eslint-config-skuba/package.json b/packages/eslint-config-skuba/package.json
@@ -49,6 +49,6 @@
     "entryPoint": "index.js",
     "template": "oss-npm-package",
     "type": "package",
-    "version": "10.0.1"
+    "version": "10.1.0"
   }
 }
diff --git a/packages/skuba-dive/.gitignore b/packages/skuba-dive/.gitignore
@@ -6,7 +6,6 @@
 .cdk.staging/
 .serverless/
 cdk.out/
-cdk.context.json
 node_modules*/
 
 /coverage*/
diff --git a/packages/skuba-dive/package.json b/packages/skuba-dive/package.json
@@ -44,6 +44,6 @@
     "entryPoint": "src/index.ts",
     "template": "oss-npm-package",
     "type": "package",
-    "version": "8.2.1"
+    "version": "10.1.0"
   }
 }
diff --git a/src/cli/configure/analysis/__snapshots__/project.test.ts.snap b/src/cli/configure/analysis/__snapshots__/project.test.ts.snap
@@ -39,7 +39,6 @@ yarn-error.log
 .cdk.staging/
 .serverless/
 cdk.out/
-cdk.context.json
 node_modules*/
 
 /coverage*/
diff --git a/template/base/_.gitignore b/template/base/_.gitignore
@@ -6,7 +6,6 @@
 .cdk.staging/
 .serverless/
 cdk.out/
-cdk.context.json
 node_modules*/
 
 /coverage*/

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,6 @@`
`49`	`49`	`"entryPoint": "index.js",`
`50`	`50`	`"template": "oss-npm-package",`
`51`	`51`	`"type": "package",`
`52`		`- "version": "10.0.1"`
	`52`	`+ "version": "10.1.0"`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,6 @@`
`44`	`44`	`"entryPoint": "src/index.ts",`
`45`	`45`	`"template": "oss-npm-package",`
`46`	`46`	`"type": "package",`
`47`		`- "version": "8.2.1"`
	`47`	`+ "version": "10.1.0"`
`48`	`48`	`}`
`49`	`49`	`}`