[wip] first pass

Author: nodeselector

README.md

@@ -59,7 +59,7 @@ We currently do not have the capability to support Operating System (OS) certifi
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md). A description of the architecture of the extension can be found [here](./docs/project-architecture.md).
+See [CONTRIBUTING.md](CONTRIBUTING.md). A description of the architecture of the extension can be found [here](./docs/project-architecture.md). If you are working on unreleased GitHub Actions language service changes, see the [development guide](./docs/development.md#working-with-local-languageservices-changes) for local setup steps.
 
 ## License
 

docs/development.md

@@ -44,6 +44,39 @@ get working packages.
 1. Start and debug extension with the `Watch & Launch Extension` configuration from the "Run and Debug" side panel menu
 1. Open a workspace in the remote extension host that contains workflow files in the `.github/workflows` directory
 
+### Working with local languageservices changes
+
+The extension consumes the GitHub Actions language stack from [actions/languageservices](https://github.com/actions/languageservices):
+
+- `@actions/expressions`
+- `@actions/workflow-parser`
+- `@actions/languageservice`
+- `@actions/languageserver`
+
+When you run `script/bootstrap`, the workspace links those packages into this repository's `node_modules/@actions` directory. That means local extension builds can pick up unreleased language service changes before the packages are published.
+
+For example, from a local workspace where `vscode-github-actions` and `actions/languageservices` are sibling repositories:
+
+```shell
+cd ~/vscode/actions/languageservices
+npm -w @actions/workflow-parser run build
+npm -w @actions/languageservice run build
+npm -w @actions/languageserver run build
+
+cd ~/vscode/vscode-github-actions
+npm run build
+```
+
+You can verify the local links with:
+
+```shell
+ls -la node_modules/@actions
+```
+
+The `@actions/*` packages should point back to the sibling `actions/languageservices` checkout. If they point to registry-installed packages instead, rerun `script/bootstrap` and reinstall from the workspace root before rebuilding.
+
+After rebuilding, reload or restart the Extension Development Host so it starts the newly bundled language server from `dist/server-node.js`.
+
 ### Updating dependencies
 
 Once you're happy with your changes, publish the changes to the respective packages. You might have to adjust package versions, so if you made a change to `actions-workflow-parser` and increase the version there, you will have to consume the updated package in `actions-languageservice`.

package-lock.json

@@ -26,6 +26,8 @@
     "onView:workflows",
     "onView:settings",
     "workspaceContains:**/.github/workflows/**",
+    "workspaceContains:**/.github/actions.lock.yml",
+    "workspaceContains:**/.github/actions.lock.yaml",
     "workspaceContains:**/action.yml",
     "workspaceContains:**/action.yaml"
   ],
@@ -39,6 +41,8 @@
           "GitHub Actions Workflow"
         ],
         "filenamePatterns": [
+          "**/.github/actions.lock.yml",
+          "**/.github/actions.lock.yaml",
           "**/.github/workflows/**/*.yml",
           "**/.github/workflows/**/*.yaml"
         ],
@@ -563,8 +567,8 @@
     "webpack-cli": "^4.10.0"
   },
   "dependencies": {
-    "@actions/languageserver": "^0.3.46",
-    "@actions/workflow-parser": "^0.3.46",
+    "@actions/languageserver": "^0.3.53",
+    "@actions/workflow-parser": "^0.3.53",
     "@octokit/rest": "^21.1.1",
     "@vscode/vsce": "^2.19.0",
     "buffer": "^6.0.3",
@@ -589,4 +593,4 @@
       "elliptic": "6.6.1"
     }
   }
-}
+}

package.json

@@ -2,6 +2,10 @@ export const WorkflowSelector = {
   pattern: "**/.github/workflows/*.{yaml,yml}"
 };
 
+export const DependencyLockfileSelector = {
+  pattern: "**/.github/actions.lock.{yaml,yml}"
+};
+
 export const ActionSelector = {
   pattern: "**/action.{yml,yaml}"
 };

src/workflow/documentSelector.ts

@@ -10,7 +10,7 @@ import {LanguageClient as NodeLanguageClient, ServerOptions, TransportKind} from
 import {userAgent} from "../api/api";
 import {getSession} from "../auth/auth";
 import {getGitHubContext} from "../git/repository";
-import {WorkflowSelector, ActionSelector} from "./documentSelector";
+import {ActionSelector, DependencyLockfileSelector, WorkflowSelector} from "./documentSelector";
 import {getGitHubApiUri, useEnterprise} from "../configuration/configuration";
 
 let client: BaseLanguageClient;
@@ -24,6 +24,13 @@ export async function initLanguageServer(context: vscode.ExtensionContext) {
   const session = await getSession();
 
   const ghContext = await getGitHubContext();
+  const experimentalFeatures: NonNullable<InitializationOptions["experimentalFeatures"]> = {
+    allowCaseFunction: true
+  };
+  Object.assign(experimentalFeatures, {
+    allowDependencies: true
+  });
+
   const initializationOptions: InitializationOptions = {
     sessionToken: session?.accessToken,
     userAgent: userAgent,
@@ -36,13 +43,11 @@ export async function initLanguageServer(context: vscode.ExtensionContext) {
       organizationOwned: repo.organizationOwned
     })),
     logLevel: PRODUCTION ? LogLevel.Warn : LogLevel.Debug,
-    experimentalFeatures: {
-      allowCaseFunction: true
-    }
+    experimentalFeatures
   };
 
   const clientOptions: LanguageClientOptions = {
-    documentSelector: [WorkflowSelector, ActionSelector],
+    documentSelector: [WorkflowSelector, DependencyLockfileSelector, ActionSelector],
     initializationOptions: initializationOptions,
     progressOnInitialization: true
   };