kibana/packages/kbn-lint-ts-projects-cli/rules/forbidden_compiler_options.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 { removeCompilerOption } from '@kbn/json-ast';

import { TsProjectRule } from '@kbn/repo-linter';

const NAMES = [
  'declaration',
  'declarationMap',
  'emitDeclarationOnly',
  'skipLibCheck',
  'target',
  'paths',
  'incremental',
  'composite',
  'rootDir',
];

export const forbiddenCompilerOptions = TsProjectRule.create('forbiddenCompilerOptions', {
  check({ repoRel, tsProject }) {
    for (const optName of NAMES) {
      if (repoRel === '.buildkite/tsconfig.json' && optName === 'paths') {
        // allow "paths" in this specific config file
        continue;
      }

      const value = tsProject.config.compilerOptions?.[optName];
      if (value === undefined) {
        continue;
      }

      this.err(`specifying the "${optName}" compiler option is forbidden`, {
        ['tsconfig.json']: (source) => {
          return removeCompilerOption(source, optName);
        },
      });
    }
  },
});