VS Code extension recommendations (#1556)

Co-authored-by: Aaron Moat <2937187+AaronMoat@users.noreply.github.com> Co-authored-by: Sam Chung <samchungy@gmail.com>
seek-oss · May 7, 2024 · 81780d9 · 81780d9
1 parent 478b72a
commit 81780d9
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 0 deletions.
diff --git a/.changeset/eight-ties-crash.md b/.changeset/eight-ties-crash.md
@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+template: Add extension recommendations to `.vscode/extensions.json`
diff --git a/.changeset/spotty-suits-argue.md b/.changeset/spotty-suits-argue.md
@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+lint: Exclude `.vscode/extensions.json` from being ignored by `.gitignore`
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}
diff --git a/docs/cli/init.md b/docs/cli/init.md
@@ -153,6 +153,7 @@ Familiarise yourself with the directory structure that **skuba** has created:
 ```shell
 ├── .buildkite
 ├── .github
+├── .vscode
 └── src
     ├── app.test.ts
     ├── app.ts

diff --git a/packages/eslint-config-skuba/.gitignore b/packages/eslint-config-skuba/.gitignore
@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

diff --git a/packages/skuba-dive/.gitignore b/packages/skuba-dive/.gitignore
@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

diff --git a/src/cli/configure/analysis/__snapshots__/project.test.ts.snap b/src/cli/configure/analysis/__snapshots__/project.test.ts.snap
@@ -60,6 +60,7 @@ node_modules*/
     "data": "# managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

diff --git a/src/utils/dir.test.ts b/src/utils/dir.test.ts
@@ -134,6 +134,7 @@ describe('createInclusionFilter', () => {
       '.buildkite/pipeline.yml',
       '.eslintignore',
       '.prettierrc.js',
+      '.vscode/extensions.json',
       'Dockerfile',
       'jest.config.ts',
       'README.md',

diff --git a/template/base/.vscode/extensions.json b/template/base/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}
diff --git a/template/base/_.gitignore b/template/base/_.gitignore
@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/