kibana/packages/kbn-lint-ts-projects-cli/rules/reference_pkg_ids.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 { REPO_ROOT } from '@kbn/repo-info';
import { readPackageMap } from '@kbn/repo-packages';
import { replaceReferences } from '@kbn/json-ast';

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

export const refPkgsIds = TsProjectRule.create('refPkgIds', {
  check({ tsProject }) {
    const dirsToPkgIds = this.getCache(() => {
      const pkgMap = readPackageMap();
      return new Map(Array.from(pkgMap).map(([k, v]) => [v, k]));
    });

    const getPkgId = (tsconfigPath: string) =>
      dirsToPkgIds.get(Path.relative(REPO_ROOT, Path.dirname(tsconfigPath)));

    const replaceWithPkgId: Array<[string, string]> = [];

    for (const ref of tsProject.config.kbn_references ?? []) {
      if (typeof ref === 'string' || ref.force === true) {
        continue;
      }

      const refPath = this.resolve(ref.path);
      const pkgIdJson = getPkgId(refPath);
      if (pkgIdJson) {
        replaceWithPkgId.push([ref.path, pkgIdJson]);
      }
    }

    if (!replaceWithPkgId.length) {
      return;
    }

    const list = replaceWithPkgId
      .map(([from, to]) => `  - {"path": "${from}"} => ${JSON.stringify(to)}`)
      .join('\n');

    return {
      msg: `kbn_references must use pkgIds to refer to other packages (use --fix to autofix, or add "force": true to ignore):\n${list}`,
      fixes: {
        'tsconfig.json': (source) => {
          return replaceReferences(source, replaceWithPkgId);
        },
      },
    };
  },
});