Fredrik Adelöw
135 lines
3.8 KiB
JavaScript
Executable File
135 lines
3.8 KiB
JavaScript
Executable File
/*
|
|
* Copyright 2020 The Backstage Authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
const { spawnSync } = require('node:child_process');
|
|
const {
|
|
resolve: resolvePath,
|
|
join: joinPath,
|
|
relative: relativePath,
|
|
} = require('node:path');
|
|
const fs = require('node:fs').promises;
|
|
|
|
const IGNORED_WHEN_LISTING = [
|
|
/^ADOPTERS\.md$/,
|
|
/^OWNERS\.md$/,
|
|
/^.*[/\\]CHANGELOG\.md$/,
|
|
/^.*[/\\]([^\/]+-)?api-report\.md$/,
|
|
/^.*[/\\]knip-report\.md$/,
|
|
/^docs[/\\]releases[/\\].*-changelog\.md$/,
|
|
/^docs[/\\]reference[/\\]/,
|
|
/^README-[a-z]{2}_[A-Z]{2}\.md$/,
|
|
];
|
|
|
|
const IGNORED_WHEN_EXPLICIT = [
|
|
/^ADOPTERS\.md$/,
|
|
/^OWNERS\.md$/,
|
|
/^.*[/\\]knip-report\.md$/,
|
|
];
|
|
|
|
const rootDir = resolvePath(__dirname, '..');
|
|
|
|
// Manual listing to avoid dependency install for listing files in CI
|
|
async function listFiles(dir = '') {
|
|
const files = await fs.readdir(dir || rootDir);
|
|
const paths = await Promise.all(
|
|
files
|
|
.filter(file => file !== 'node_modules')
|
|
.map(async file => {
|
|
const path = joinPath(dir, file);
|
|
|
|
if (IGNORED_WHEN_LISTING.some(pattern => pattern.test(path))) {
|
|
return [];
|
|
}
|
|
if ((await fs.stat(path)).isDirectory()) {
|
|
return listFiles(path);
|
|
}
|
|
if (!path.endsWith('.md')) {
|
|
return [];
|
|
}
|
|
return path;
|
|
}),
|
|
);
|
|
return paths.flat();
|
|
}
|
|
|
|
// Proceed with the script only if Vale linter is installed. Limit the friction and surprises
|
|
// caused by the script. In CI, we want to ensure vale linter is run.
|
|
async function exitIfMissingVale() {
|
|
try {
|
|
// eslint-disable-next-line @backstage/no-undeclared-imports
|
|
await require('command-exists')('vale');
|
|
} catch (e) {
|
|
console.log(
|
|
`Language linter (vale) was not found. Please install vale linter (https://vale.sh/docs/vale-cli/installation/).\n`,
|
|
);
|
|
process.exit(process.env.CI ? 1 : 0);
|
|
}
|
|
}
|
|
|
|
async function runVale(files) {
|
|
const result = spawnSync(
|
|
'vale',
|
|
['--config', resolvePath(rootDir, '.vale.ini'), ...files],
|
|
{
|
|
stdio: 'inherit',
|
|
},
|
|
);
|
|
|
|
if (result.status !== 0) {
|
|
// TODO(Rugvip): This logic was here before but seems a bit odd, could use some verification on windows.
|
|
// If it contains system level error. In this case vale does not exist.
|
|
if (process.platform !== 'win32' || result.error) {
|
|
console.log(`Language linter (vale) generated errors. Please check the errors and review any markdown files that you changed.
|
|
Possibly update .github/vale/config/vocabularies/Backstage/accept.txt to add new valid words.\n`);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
async function main() {
|
|
if (process.argv.includes('--ci-args')) {
|
|
const files = await listFiles();
|
|
|
|
process.stdout.write(
|
|
// Workaround for not being able to pass arguments to the vale action
|
|
JSON.stringify([...files]),
|
|
);
|
|
return;
|
|
}
|
|
|
|
await exitIfMissingVale();
|
|
|
|
const absolutePaths = process.argv
|
|
.slice(2)
|
|
.filter(path => !path.startsWith('-'));
|
|
const relativePaths = absolutePaths
|
|
.map(path => relativePath(rootDir, path))
|
|
.filter(path => !IGNORED_WHEN_EXPLICIT.some(pattern => pattern.test(path)));
|
|
const success = await runVale(
|
|
relativePaths.length === 0 ? await listFiles() : relativePaths,
|
|
);
|
|
if (!success) {
|
|
process.exit(2);
|
|
}
|
|
}
|
|
|
|
main().catch(error => {
|
|
console.error(error);
|
|
process.exit(1);
|
|
});
|