Show action description on hover

This commit is contained in:
Josh Gross
2023-03-06 14:44:18 -05:00
parent 861cb8aaeb
commit 6dde0b554d
6 changed files with 153 additions and 51 deletions
+23 -3
View File
@@ -2,20 +2,40 @@ import {DescriptionProvider} from "@github/actions-languageservice/hover";
import {Octokit} from "@octokit/rest";
import {getActionInputDescription} from "./description-providers/action-input";
import {TTLCache} from "./utils/cache";
import {isString} from "@github/actions-workflow-parser/templates/tokens/type-guards";
import {TemplateToken} from "@github/actions-workflow-parser/templates/tokens/template-token";
import {getActionDescription} from "./description-providers/action-description";
export function descriptionProvider(client: Octokit | undefined, cache: TTLCache): DescriptionProvider {
const getDescription: DescriptionProvider["getDescription"] = async (context, token, path) => {
if (!client) {
if (!client || !context.step) {
return undefined;
}
const parent = path[path.length - 1];
if (context.step && parent.definition?.key === "step-with") {
if (isStepInput(path)) {
return await getActionInputDescription(client, cache, context.step, token);
}
if (isStepUses(path)) {
return await getActionDescription(client, cache, context.step);
}
};
return {
getDescription
};
}
function isStepInput(path: TemplateToken[]): boolean {
const parent = path[path.length - 1];
return parent.definition?.key === "step-with";
}
function isStepUses(path: TemplateToken[]): boolean {
if (path.length < 2) {
return false;
}
const parent = path[path.length - 1];
const grandparent = path[path.length - 2];
return isString(parent) && parent.value === "uses" && grandparent.definition?.key === "regular-step";
}