add script to update VSCode config with proper excludes

[spalger]

Fixes #85782

Adds a step to bootstrap which will update the .vscode/settings.json file or create it if it doesn't exist, then add the files.watcherExclude key to it or override that value if it doesn't exist. The process of updating this file uses babel to parse the file to an AST, updates the AST, and then prints it again using babel, then formats it using Prettier. This allows users to keep comments in their file as supported by VSCode and as is very useful if you want to temporarily disable some configuration but keep the values around for later use.

For now the files.watcherExclude is the only key we're setting in the config, but we might expand this to include settings for eslint, prettier, Typescript version, etc in the future.

The settings which will be written/overwritten to the file are defined in https://github.com/spalger/kibana/blob/implement/setup-vscode-workspace-settings/packages/kbn-dev-utils/src/vscode_config/managed_config_keys.ts

Users who want to manage their VSCode settings manually can do so by putting the comment // SELF MANAGED at the top of the file.

Additionally, individual settings can be proceeded with // SELF MANAGED to avoid having their values changed.

[mshustov]

I'm wondering if we should list artifacts in search.exclude setting to speed up the default experience for search operations.

[spalger]

Did you turn off the "Use exclude settings and ignore files" setting? Artifacts should be excluded by default because they're not tracked by git.

[spalger]

I only ask because I've never felt like search was slow and I definitely prefer to rely on the existing ignore files if we can.

[jbudz]

One example that may be useful here is the kbn-pm dist. That's the only one I'm running in to on first glance though, doesn't impact me much.

[spalger]

Yeah, it's checked into the code so it makes sense to me

[spalger]

So, in order to support managing the search.exclude property it felt like people needed to be able to add exclusions for themselves, so I've updated the logic to define management comments on each property it writes like so:

/**
 * @managed
 *
 * Some settings in this file are managed by @kbn/dev-utils. When a setting is managed it is preceeded
 * with a comment "// @managed" comment. Replace that with "// self managed" and the scripts will not
 * touch that value. Put a "// self managed" comment at the top of the file, or above a group of settings
 * to disable management of that entire section.
 */
{
  "workbench.colorTheme": "Noctis Obscuro",
  "files.watcherExclude": {
    // self managed
    "**/.eslintcache": false,
    // @managed
    "**/.es": true,
    // @managed
    "**/.yarn-local-mirror": true,
    // @managed
    "**/.chromium": true,
    // @managed
    "**/bazel-*": true,
    // @managed
    "**/node_modules": true,
    // @managed
    "**/target": true,
    // @managed
    "**/*.log": true,
    // @managed
    "**/packages/kbn-pm/dist/index.js": true
  },
  "search.exclude": {
    // @managed
    "**/packages/kbn-pm/dist/index.js": true
  }
}

Now, when the script runs it will ignore any property which doesn't have a @managed comment, and delete @managed properties which are no longer managed. Additionally, users can self manage a property by replacing the @managed comment with // self managed and then customize things further.

[elasticmachine]

Pinging @elastic/kibana-operations (Team:Operations)

[spalger]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: acbffcc
• Storybooks Preview

Metrics [docs]

✅ unchanged

History

• 💚 Build #149480 succeeded f4ae606
• 💚 Build #149018 succeeded 170a30a
• 💔 Build #148768 failed 974b291

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[kibanamachine]

💚 Backport successful

Status	Branch	Result
✅	7.15
✅	7.x

The backport PRs will be merged automatically after passing CI.