Files
languageservices/languageservice/src/context-providers/needs.ts
T
eric scipleandGitHub 656a821a94 ESM migration: Add .js extensions for node16 moduleResolution (#257)
Migrate expressions, workflow-parser, and languageservice packages to use
proper ESM imports with .js extensions that work with node16 moduleResolution.

Changes:
- Update tsconfig.build.json in each package to use module: node16 and
  moduleResolution: node16
- Add .js extensions to all relative import paths (Option B approach)
- Fix yaml internal type imports in workflow-parser by defining local types
- Add skipLibCheck to handle @types/node compatibility issues
- Add TypeScript 5.8.3 override in root package.json
- Add ESM migration plan documentation

The languageserver package is deferred due to test hang issues that need
further investigation.

Related #154 - Upgrade moduleResolution from node to node16 or nodenext
Related #110 - Published ESM code has imports without file extensions
Related #64 - expressions: ERR_MODULE_NOT_FOUND attempting to run example
Related #146 - Can not import @actions/workflow-parser

Test results:
- expressions: 1068 tests passed
- workflow-parser: 292 tests passed
- languageservice: 452 tests passed

* docs: update ESM migration plan with findings

- Update languageserver blocker: vscode-languageserver v8.0.2 lacks ESM
  exports (not a test hang issue)
- Document that Option B (manual .js extensions) was chosen over Option A
  due to ts-jest compatibility issues
- Add workaround for yaml package internal types (LinePos, NodeBase)
- Update migration status table with accurate reason for deferral
- Add skipLibCheck note for @types/node compatibility
2025-12-18 13:35:48 -06:00

74 lines
2.2 KiB
TypeScript

import {data, DescriptionDictionary} from "@actions/expressions";
import {isMapping, isScalar, isString} from "@actions/workflow-parser";
import {isJob} from "@actions/workflow-parser/model/type-guards";
import {WorkflowJob} from "@actions/workflow-parser/model/workflow-template";
import {TemplateToken} from "@actions/workflow-parser/templates/tokens/template-token";
import {WorkflowContext} from "../context/workflow-context.js";
export function getNeedsContext(workflowContext: WorkflowContext): DescriptionDictionary {
const d = new DescriptionDictionary();
const job = workflowContext.job || workflowContext.reusableWorkflowJob;
if (!job?.needs) {
return d;
}
for (const jobID of 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?: WorkflowJob): DescriptionDictionary {
// https://docs.github.com/en/actions/learn-github-actions/contexts#needs-context
const d = new DescriptionDictionary();
if (job) {
d.add("outputs", jobOutputs(job));
}
// Can be "success", "failure", "cancelled", or "skipped"
d.add("result", new data.Null());
return d;
}
function jobOutputs(job?: WorkflowJob): DescriptionDictionary {
const d = new DescriptionDictionary();
if (!job?.outputs) {
return d;
}
for (const output of job.outputs) {
if (!isString(output.key)) {
continue;
}
d.add(output.key.value, ...jobOutput(job, output.value));
}
return d;
}
function jobOutput(job: WorkflowJob, outputValue: TemplateToken): [data.ExpressionData, string | undefined] {
if (isJob(job)) {
// A regular workflow job won't have a description
return isScalar(outputValue)
? [new data.StringData(outputValue.toDisplayString()), undefined]
: [new data.Null(), undefined];
}
if (!isMapping(outputValue)) {
return [new data.Null(), undefined];
}
const description = outputValue.find("description");
const value = outputValue.find("value");
return [
value && isScalar(value) ? new data.StringData(value.toDisplayString()) : new data.Null(),
description && isString(description) ? description.value : undefined
];
}