Show action input descriptions on hover

This commit is contained in:
Josh Gross
2023-01-23 16:02:13 -05:00
parent 23e2a5c1bc
commit 48c728771e
6 changed files with 166 additions and 31 deletions
@@ -0,0 +1,26 @@
import {DescriptionProvider} from "@github/actions-languageservice/hover";
import {Octokit} from "@octokit/rest";
import {TTLCache} from "./utils/cache";
import {getActionInputDescription} from "./description-providers/action-input";
export function descriptionProvider(sessionToken: string | undefined, cache: TTLCache): DescriptionProvider {
const octokit =
sessionToken &&
new Octokit({
auth: sessionToken
});
const getDescription: DescriptionProvider["getDescription"] = async (context, token, path) => {
if (!octokit) {
return undefined;
}
const parent = path[path.length - 1];
if (context.step && parent.definition?.key === "step-with") {
return await getActionInputDescription(octokit, cache, context.step, token);
}
};
return {
getDescription
};
}