Files
languageservices/actions-languageservice/src/context-providers/needs.ts
T

48 lines
1.4 KiB
TypeScript

import {data, DescriptionDictionary} from "@github/actions-expressions";
import {isScalar, isString} from "@github/actions-workflow-parser";
import {Job} from "@github/actions-workflow-parser/model/workflow-template";
import {WorkflowContext} from "../context/workflow-context";
export function getNeedsContext(workflowContext: WorkflowContext): DescriptionDictionary {
const d = new DescriptionDictionary();
if (!workflowContext.job || !workflowContext.job.needs) {
return d;
}
for (const jobID of workflowContext.job.needs) {
const job = workflowContext.template?.jobs.find(job => job.id.value === jobID.value);
d.add(jobID.value, needsJobContext(job));
}
return d;
}
function needsJobContext(job?: Job): DescriptionDictionary {
// https://docs.github.com/en/actions/learn-github-actions/contexts#needs-context
const d = new DescriptionDictionary();
d.add("outputs", jobOutputs(job));
// Can be "success", "failure", "cancelled", or "skipped"
d.add("result", new data.Null());
return d;
}
function jobOutputs(job?: Job): DescriptionDictionary {
const d = new DescriptionDictionary();
if (!job?.outputs) {
return d;
}
for (const output of job.outputs) {
if (!isString(output.key)) {
continue;
}
// Include the value for hover purposes
const value = isScalar(output.value) ? new data.StringData(output.value.toDisplayString()) : new data.Null();
d.add(output.key.value, value);
}
return d;
}