kibana/packages/kbn-repo-file-maps/package_file_map.ts
Spencer d6be4a4b06
Implement package linter (#148496)
This PR implements a linter like the TS Project linter, except for
packages in the repo. It does this by extracting the reusable bits from
the TS Project linter and reusing them for the project linter. The only
rule that exists for packages right now is that the "name" in the
package.json file matches the "id" in Kibana.jsonc. The goal is to use a
rule to migrate kibana.json files on the future.

Additionally, a new rule for validating the indentation of tsconfig.json
files was added.

Validating and fixing violations is what has triggered review by so many
teams, but we plan to treat those review requests as notifications of
the changes and not as blockers for merging.

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-01-09 16:49:29 -07:00

74 lines
2.1 KiB
TypeScript

/*
* 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 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 or the Server
* Side Public License, v 1.
*/
import Path from 'path';
import { SetMap } from '@kbn/set-map';
import type { Package } from '@kbn/repo-packages';
import type { RepoPath } from '@kbn/repo-path';
import type { LintTarget } from '@kbn/repo-linter';
export class PackageFileMap {
private readonly filesByPackage = new SetMap<Package, RepoPath>();
private readonly packagesByFile = new Map<string, Package>();
private readonly unassignedFiles: RepoPath[] = [];
constructor(packages: Package[], private readonly allFiles: Iterable<RepoPath>) {
const repoRelCache = new Map<string, Package | null>(
packages.map((p) => [p.normalizedRepoRelativeDir, p])
);
const findPkg = (repoRel: string): Package | null => {
if (repoRel === '.') {
return null;
}
const cached = repoRelCache.get(repoRel);
if (cached !== undefined) {
return cached;
}
const pkg = findPkg(Path.dirname(repoRel));
repoRelCache.set(repoRel, pkg);
return pkg;
};
for (const file of allFiles) {
const pkg = findPkg(file.repoRel);
if (!pkg) {
this.unassignedFiles.push(file);
continue;
}
this.packagesByFile.set(file.repoRel, pkg);
this.filesByPackage.add(pkg, file);
}
}
getAllFiles() {
return Array.from(this.allFiles);
}
getFiles(pkg: Package): Iterable<RepoPath> {
return this.filesByPackage.get(pkg) ?? [];
}
getPackage(repoRel: string) {
return this.packagesByFile.get(repoRel);
}
getUnassigned(): Iterable<RepoPath> {
return Array.from(this.unassignedFiles);
}
getFilesForLintTarget(target: LintTarget): Iterable<RepoPath> {
const pkg = target.getPkg();
return (pkg && this.filesByPackage.get(pkg)) || [];
}
}