kibana/packages/kbn-managed-vscode-config-cli/index.ts

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the "Elastic License
 * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
 * Public License v 1"; you may not use this file except in compliance with, at
 * your election, the "Elastic License 2.0", the "GNU Affero General Public
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

import Path from 'path';
import Fsp from 'fs/promises';

import { REPO_ROOT } from '@kbn/repo-info';
import dedent from 'dedent';

import { run } from '@kbn/dev-cli-runner';

import {
  MANAGED_CONFIG_KEYS,
  MANAGED_CONFIG_FILES,
  updateVscodeConfig,
} from '@kbn/managed-vscode-config';

const CONFIG_DIR = Path.resolve(REPO_ROOT, '.vscode');

run(async ({ log }) => {
  const path = Path.resolve(CONFIG_DIR, 'settings.json');

  let json;
  try {
    json = await Fsp.readFile(path, 'utf-8');
  } catch (error) {
    if (error.code !== 'ENOENT') {
      throw error;
    }
  }

  const updatedJson = await updateVscodeConfig(
    MANAGED_CONFIG_KEYS,
    dedent`
        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.
      `,
    json
  );
  await Fsp.mkdir(Path.dirname(path), { recursive: true });

  // write managed config files
  for (const { name, content } of MANAGED_CONFIG_FILES) {
    await Fsp.writeFile(Path.resolve(CONFIG_DIR, name), content);
  }

  await Fsp.writeFile(path, updatedJson);

  log.success('updated', path);
});