@compas/cli
Version:
CLI containing utilities and simple script runner
30 lines (29 loc) • 720 B
TypeScript
/**
* @typedef {object} CollectedScript
* @property {"user"|"package"} type
* @property {string} name
* @property {string|undefined} [path]
* @property {string|undefined} [script]
*/
/**
* @typedef {{[k: string]: CollectedScript}} ScriptCollection
*/
/**
* Load scripts directory and package.json scripts.
*
* @returns {ScriptCollection}
*/
export function collectScripts(): ScriptCollection;
/**
* @returns {ScriptCollection}
*/
export function collectPackageScripts(): ScriptCollection;
export type CollectedScript = {
type: "user" | "package";
name: string;
path?: string | undefined;
script?: string | undefined;
};
export type ScriptCollection = {
[k: string]: CollectedScript;
};