eric sciple
d2ffb50a92
- Add validation, completion, hover, and document links for action.yml files - Implement document type detection to route action.yml to action-specific handlers - Add expression context for composite actions (inputs, steps, github, runner, etc.) - Add schema validation for required fields, branding, and composite step requirements - Support JavaScript (node20/node24), Docker, and composite action types - Validate action references in composite action uses steps - Add JSDoc comments to parser and template functions - Refactor hover to use hoverToken consistently - Fix lint errors and add return type annotations
110 lines
3.4 KiB
TypeScript
110 lines
3.4 KiB
TypeScript
import {isMapping, isSequence, WorkflowTemplate} from "@actions/workflow-parser";
|
|
import {isJob, isReusableWorkflowJob} from "@actions/workflow-parser/model/type-guards";
|
|
import {Job, ReusableWorkflowJob, Step} from "@actions/workflow-parser/model/workflow-template";
|
|
import {MappingToken} from "@actions/workflow-parser/templates/tokens/mapping-token";
|
|
import {SequenceToken} from "@actions/workflow-parser/templates/tokens/sequence-token";
|
|
import {StringToken} from "@actions/workflow-parser/templates/tokens/string-token";
|
|
import {TemplateToken} from "@actions/workflow-parser/templates/tokens/template-token";
|
|
|
|
/**
|
|
* Represents the contextual position within a workflow file.
|
|
* Used to determine which expression contexts are available at a given location.
|
|
*/
|
|
export interface WorkflowContext {
|
|
uri: string;
|
|
|
|
template: WorkflowTemplate | undefined;
|
|
|
|
/** If the context is for a position within a regular job, this will be the job */
|
|
job?: Job;
|
|
|
|
/** If the context is for a position within a reusable workflow job, this will be the reusable workflow job */
|
|
reusableWorkflowJob?: ReusableWorkflowJob;
|
|
|
|
/** If the context is for a position within a step, this will be the step */
|
|
step?: Step;
|
|
}
|
|
|
|
/**
|
|
* Builds a WorkflowContext by walking the token path to identify the current job and step.
|
|
* @param uri - The URI of the workflow file
|
|
* @param template - The parsed workflow template
|
|
* @param tokenPath - The path of tokens from root to the current position
|
|
*/
|
|
export function getWorkflowContext(
|
|
uri: string,
|
|
template: WorkflowTemplate | undefined,
|
|
tokenPath: TemplateToken[]
|
|
): WorkflowContext {
|
|
const context: WorkflowContext = {uri: uri, template};
|
|
if (!template) {
|
|
return context;
|
|
}
|
|
|
|
let stepsSequence: SequenceToken | undefined = undefined;
|
|
let stepToken: MappingToken | undefined = undefined;
|
|
|
|
// Iterate through the token path to find the job and step
|
|
for (const token of tokenPath) {
|
|
switch (token.definition?.key) {
|
|
case "job": {
|
|
const jobID = (token as StringToken).value;
|
|
const job = template.jobs.find(job => job.id.value === jobID);
|
|
if (!job) {
|
|
break;
|
|
}
|
|
if (isJob(job)) {
|
|
context.job = job;
|
|
} else if (isReusableWorkflowJob(job)) {
|
|
context.reusableWorkflowJob = job;
|
|
}
|
|
break;
|
|
}
|
|
case "steps": {
|
|
if (isSequence(token)) {
|
|
stepsSequence = token;
|
|
}
|
|
break;
|
|
}
|
|
case "regular-step":
|
|
case "run-step": {
|
|
if (isMapping(token)) {
|
|
stepToken = token;
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (context.job && isJob(context.job)) {
|
|
context.step = findStep(context.job.steps, stepsSequence, stepToken);
|
|
}
|
|
|
|
return context;
|
|
}
|
|
|
|
/**
|
|
* Finds a Step by matching the step token's position in the steps sequence.
|
|
* Steps may not have IDs, so we locate them by index rather than by identifier.
|
|
*/
|
|
function findStep(steps?: Step[], stepSequence?: SequenceToken, stepToken?: MappingToken): Step | undefined {
|
|
if (!steps || !stepSequence || !stepToken) {
|
|
return undefined;
|
|
}
|
|
|
|
// Steps may not define an ID, so find the step by index
|
|
let stepIndex = -1;
|
|
for (let i = 0; i < stepSequence.count; i++) {
|
|
if (stepSequence.get(i) === stepToken) {
|
|
stepIndex = i;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (stepIndex === -1 || stepIndex >= steps.length) {
|
|
return undefined;
|
|
}
|
|
|
|
return steps[stepIndex];
|
|
}
|