mirror of
https://github.com/AikidoSec/safe-chain.git
synced 2026-05-26 20:20:49 +00:00
484cbcd960
When you write @typedef {Object} ScanResult, you’re telling both JSDoc and TypeScript’s parser that this typedef represents an object type, not just an abstract name. This is important because it makes tools like IDEs, linters, and TypeScript’s JSDoc inference more reliable. It avoids ambiguity, especially in cases where the typedef might later be confused with something like a primitive, union, or function type. The official TypeScript documentation and the JSDoc spec both show this form as the canonical one for object shapes.
37 lines
1.1 KiB
JavaScript
37 lines
1.1 KiB
JavaScript
import zsh from "./supported-shells/zsh.js";
|
|
import bash from "./supported-shells/bash.js";
|
|
import powershell from "./supported-shells/powershell.js";
|
|
import windowsPowershell from "./supported-shells/windowsPowershell.js";
|
|
import fish from "./supported-shells/fish.js";
|
|
import { ui } from "../environment/userInteraction.js";
|
|
|
|
/**
|
|
* @typedef {Object} Shell
|
|
* @property {string} name
|
|
* @property {() => boolean} isInstalled
|
|
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} setup
|
|
* @property {(tools: import("./helpers.js").AikidoTool[]) => boolean} teardown
|
|
*/
|
|
|
|
/**
|
|
* @returns {Shell[]}
|
|
*/
|
|
export function detectShells() {
|
|
let possibleShells = [zsh, bash, powershell, windowsPowershell, fish];
|
|
let availableShells = [];
|
|
|
|
try {
|
|
for (const shell of possibleShells) {
|
|
if (shell.isInstalled()) {
|
|
availableShells.push(shell);
|
|
}
|
|
}
|
|
} catch (/** @type {any} */ error) {
|
|
ui.writeError(
|
|
`We were not able to detect which shells are installed on your system. Please check your shell configuration. Error: ${error.message}`
|
|
);
|
|
return [];
|
|
}
|
|
|
|
return availableShells;
|
|
}
|