Update documentation

This commit is contained in:
Reinier Criel 2025-10-23 10:23:42 -07:00
parent c85802dd2e
commit f817bf887a
8 changed files with 82 additions and 20 deletions

View file

@ -46,8 +46,14 @@ function createUnixShims(shimsDir) {
const template = fs.readFileSync(templatePath, "utf-8");
// Create a shim for each tool
// Create a shim for each tool except pip for now.
// TODO(pip): Enable pip and pip3 CI support
let created = 0;
for (const toolInfo of knownAikidoTools) {
if (toolInfo.tool === "pip") {
continue; // Skip pip shims in CI for now
}
const shimContent = template
.replaceAll("{{PACKAGE_MANAGER}}", toolInfo.tool)
.replaceAll("{{AIKIDO_COMMAND}}", toolInfo.aikidoCommand);
@ -57,10 +63,11 @@ function createUnixShims(shimsDir) {
// Make the shim executable on Unix systems
fs.chmodSync(shimPath, 0o755);
created++;
}
ui.writeInformation(
`Created ${knownAikidoTools.length} Unix shim(s) in ${shimsDir}`
`Created ${created} Unix shim(s) in ${shimsDir}`
);
}
@ -82,18 +89,25 @@ function createWindowsShims(shimsDir) {
const template = fs.readFileSync(templatePath, "utf-8");
// Create a shim for each tool
// Create a shim for each tool except pip for now.
// TODO(pip): Enable pip and pip3 CI support
let created = 0;
for (const toolInfo of knownAikidoTools) {
if (toolInfo.tool === "pip") {
continue; // Skip pip shims in CI for now
}
const shimContent = template
.replaceAll("{{PACKAGE_MANAGER}}", toolInfo.tool)
.replaceAll("{{AIKIDO_COMMAND}}", toolInfo.aikidoCommand);
const shimPath = path.join(shimsDir, `${toolInfo.tool}.cmd`);
fs.writeFileSync(shimPath, shimContent, "utf-8");
created++;
}
ui.writeInformation(
`Created ${knownAikidoTools.length} Windows shim(s) in ${shimsDir}`
`Created ${created} Windows shim(s) in ${shimsDir}`
);
}