Add VSCode settings (#15885)

.gitignore

@@ -10,7 +10,9 @@
 *.log
 /errors
 /test*.*
-/.vscode
+/.vscode/**/*
+!/.vscode/extensions.json
+!/.vscode/settings.example.json
 /dist*
 /website/build
 /website/i18n

.gitpod.yml

@@ -4,22 +4,3 @@ tasks:
   - init: |
       brew install hyperfine
       yarn
-
-github:
-  # https://www.gitpod.io/docs/prebuilds/#configure-prebuilds
-  prebuilds:
-    master: true # enable for the default branch (even if it's not named "master")
-    branches: true
-    pullRequests: true
-    pullRequestsFromForks: true
-    addCheck: true
-    addComment: false
-    addBadge: true
-    addLabel: false
-
-vscode:
-  extensions:
-    - esbenp.prettier-vscode
-    - dbaeumer.vscode-eslint
-    - editorconfig.editorconfig
-    - streetsidesoftware.code-spell-checker

.prettierrc

@@ -5,3 +5,7 @@ overrides:
   - files: "bin/prettier.cjs"
     options:
       trailingComma: none
+  # TODO: Enable this after `jsonc` parser released
+  # - files: ".vscode/*.json"
+  #   options:
+  #     parser: jsonc

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "esbenp.prettier-vscode",
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

.vscode/settings.example.json

@@ -0,0 +1,15 @@
+{
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": ["source.fixAll.eslint"]
+  },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "prettier.requireConfig": true,
+  "eslint.experimental.useFlatConfig": true,
+  "files.exclude": {
+    "dist*": true
+  }
+}

.yarn/plugins/plugin-setup-editor.cjs

@@ -0,0 +1,30 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+module.exports = {
+  name: "plugin-setup-editor",
+  factory: () => ({
+    hooks: {
+      afterAllInstalled() {
+        const settingsFile = path.join(
+          __dirname,
+          "../../.vscode/settings.json",
+        );
+
+        const settingsExampleFile = path.join(
+          __dirname,
+          "../../.vscode/settings.example.json",
+        );
+
+        if (
+          fs.existsSync(settingsFile) ||
+          !fs.existsSync(settingsExampleFile)
+        ) {
+          return;
+        }
+
+        fs.writeFileSync(settingsFile, fs.readFileSync(settingsExampleFile));
+      },
+    },
+  }),
+};

.yarnrc.yml

@@ -6,4 +6,7 @@ enableGlobalCache: true
 
 nodeLinker: node-modules
 
+plugins:
+  - .yarn/plugins/plugin-setup-editor.cjs
+
 yarnPath: .yarn/releases/yarn-4.0.2.cjs