mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
d6be4a4b06
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>
95 lines
2.9 KiB
TypeScript
95 lines
2.9 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 { run } from '@kbn/dev-cli-runner';
|
|
import { createFailError } from '@kbn/dev-cli-errors';
|
|
import { getRepoFiles } from '@kbn/get-repo-files';
|
|
import { PackageFileMap } from '@kbn/repo-file-maps';
|
|
import { getPackages } from '@kbn/repo-packages';
|
|
import { REPO_ROOT } from '@kbn/repo-info';
|
|
import { TS_PROJECTS } from '@kbn/ts-projects';
|
|
import { runLintRules, PackageLintTarget } from '@kbn/repo-linter';
|
|
|
|
import { RULES } from './rules';
|
|
|
|
const kebabCase = (input: string) =>
|
|
input
|
|
.replace(/([a-z])([A-Z])/, '$1 $2')
|
|
.split(/\W+/)
|
|
.filter((f) => !!f)
|
|
.join('-')
|
|
.toLowerCase();
|
|
|
|
function getFilter(input: string) {
|
|
const repoRel = Path.relative(REPO_ROOT, Path.resolve(input));
|
|
return ({ pkg }: PackageLintTarget) =>
|
|
pkg.name === input ||
|
|
pkg.name === `@kbn/${input}` ||
|
|
pkg.name === `@kbn/${kebabCase(input)}` ||
|
|
pkg.normalizedRepoRelativeDir === input ||
|
|
repoRel.startsWith(pkg.normalizedRepoRelativeDir + '/');
|
|
}
|
|
|
|
run(
|
|
async ({ log, flagsReader }) => {
|
|
const filter = flagsReader.getPositionals();
|
|
const packages = getPackages(REPO_ROOT);
|
|
const allTargets = packages
|
|
.map(
|
|
(p) =>
|
|
new PackageLintTarget(
|
|
p,
|
|
TS_PROJECTS.find((ts) => ts.repoRelDir === p.normalizedRepoRelativeDir)
|
|
)
|
|
)
|
|
.sort((a, b) => b.repoRel.length - a.repoRel.length);
|
|
|
|
const toLint = Array.from(
|
|
new Set(
|
|
!filter.length
|
|
? allTargets
|
|
: filter.map((input) => {
|
|
const pkg = allTargets.find(getFilter(input));
|
|
|
|
if (!pkg) {
|
|
throw createFailError(
|
|
`unable to find a package matching [${input}]. Supply either a package id/name or path to a package`
|
|
);
|
|
}
|
|
|
|
return pkg;
|
|
})
|
|
)
|
|
).sort((a, b) => a.repoRel.localeCompare(b.repoRel));
|
|
|
|
const fileMap = new PackageFileMap(packages, await getRepoFiles());
|
|
const { lintingErrorCount } = await runLintRules(log, toLint, RULES, {
|
|
fix: flagsReader.boolean('fix'),
|
|
getFiles: (target) => fileMap.getFiles(target.pkg),
|
|
});
|
|
|
|
if (!lintingErrorCount) {
|
|
log.success('All packages linted successfully');
|
|
} else {
|
|
throw createFailError('see above errors');
|
|
}
|
|
},
|
|
{
|
|
usage: `node scripts/lint_packages [...packages]`,
|
|
flags: {
|
|
boolean: ['fix'],
|
|
alias: { f: 'fix' },
|
|
help: `
|
|
--fix Automatically fix some issues in tsconfig.json files
|
|
`,
|
|
},
|
|
description: 'Validate packages using a set of rules that evolve over time.',
|
|
}
|
|
);
|