Setup CodeActions and add quickfix for missing inputs

Author: rentziass

languageserver/README.md

@@ -10,6 +10,14 @@ The [package](https://www.npmjs.com/package/@actions/languageserver) contains Ty
 npm install @actions/languageserver
 ```
 
+To install the language server as a standalone CLI:
+
+```bash
+npm install -g @actions/languageserver
+```
+
+This makes the `actions-languageserver` command available globally.
+
 ## Usage
 
 ### Basic usage using `vscode-languageserver-node`
@@ -92,6 +100,150 @@ const clientOptions: LanguageClientOptions = {
 const client = new LanguageClient("actions-language", "GitHub Actions Language Server", serverOptions, clientOptions);
 ```
 
+### Standalone CLI
+
+After installing globally, you can run the language server directly:
+
+```bash
+actions-languageserver --stdio
+```
+
+This starts the language server using stdio transport, which is the standard way for editors to communicate with language servers.
+
+### In Neovim
+
+#### 1. Install the language server
+
+```bash
+npm install -g @actions/languageserver
+```
+
+#### 2. Set up filetype detection
+
+Add this to your `init.lua` to detect GitHub Actions workflow files:
+
+```lua
+vim.filetype.add({
+  pattern = {
+    [".*/%.github/workflows/.*%.ya?ml"] = "yaml.ghactions",
+  },
+})
+```
+
+This sets the filetype to `yaml.ghactions` for YAML files in `.github/workflows/`, allowing you to keep separate YAML LSP configurations if needed.
+
+#### 3. Create the LSP configuration
+
+As of Neovim 0.11+ you can add this configuration in `~/.config/nvim/lsp/actionsls.lua`:
+
+```lua
+local function get_github_token()
+  local handle = io.popen("gh auth token 2>/dev/null")
+  if not handle then return nil end
+  local token = handle: read("*a"):gsub("%s+", "")
+  handle:close()
+  return token ~= "" and token or nil
+end
+
+local function parse_github_remote(url)
+  if not url or url == "" then return nil end
+
+  -- SSH format: git@github.com:owner/repo.git
+  local owner, repo = url:match("git@github%.com:([^/]+)/([^/%.]+)")
+  if owner and repo then
+    return owner, repo: gsub("%.git$", "")
+  end
+
+  -- HTTPS format: https://github.com/owner/repo.git
+  owner, repo = url:match("github%.com/([^/]+)/([^/%.]+)")
+  if owner and repo then
+    return owner, repo:gsub("%.git$", "")
+  end
+
+  return nil
+end
+
+local function get_repo_info(owner, repo)
+  local cmd = string.format(
+    "gh repo view %s/%s --json id,owner --template '{{.id}}\t{{.owner.type}}' 2>/dev/null",
+    owner,
+    repo
+  )
+  local handle = io.popen(cmd)
+  if not handle then return nil end
+  local result = handle: read("*a"):gsub("%s+$", "")
+  handle:close()
+
+  local id, owner_type = result:match("^(%d+)\t(.+)$")
+  if id then
+    return {
+      id = tonumber(id),
+      organizationOwned = owner_type == "Organization",
+    }
+  end
+  return nil
+end
+
+local function get_repos_config()
+  local handle = io.popen("git rev-parse --show-toplevel 2>/dev/null")
+  if not handle then return nil end
+  local git_root = handle: read("*a"):gsub("%s+", "")
+  handle:close()
+
+  if git_root == "" then return nil end
+
+  handle = io.popen("git remote get-url origin 2>/dev/null")
+  if not handle then return nil end
+  local remote_url = handle:read("*a"):gsub("%s+", "")
+  handle:close()
+
+  local owner, name = parse_github_remote(remote_url)
+  if not owner or not name then return nil end
+
+  local info = get_repo_info(owner, name)
+
+  return {
+    {
+      id = info and info.id or 0,
+      owner = owner,
+      name = name,
+      organizationOwned = info and info.organizationOwned or false,
+      workspaceUri = "file://" .. git_root,
+    },
+  }
+end
+
+return {
+  cmd = { "actions-languageserver", "--stdio" },
+  filetypes = { "yaml.ghactions" },
+  root_markers = { ".git" },
+  init_options = {
+    -- Optional: provide a GitHub token and repo context for added functionality
+    -- (e.g., repository-specific completions)
+    sessionToken = get_github_token(),
+    repos = get_repos_config(),
+  },
+}
+```
+
+#### 4. Enable the LSP
+
+Add to your `init.lua`:
+
+```lua
+vim.lsp.enable('actionsls')
+```
+
+#### 5. Verify it's working
+
+Open any `.github/workflows/*.yml` file and run:
+
+```vim
+:checkhealth vim.lsp
+```
+
+You should see `actionsls` in the list of attached clients.
+
 ## Contributing
 
 See [CONTRIBUTING.md](../CONTRIBUTING.md) at the root of the repository for general guidelines and recommendations.
@@ -110,6 +262,27 @@ or to watch for changes
 npm run watch
 ```
 
+### Running the language server locally
+
+After running
+
+```bash
+npm run build:cli
+npm link
+```
+
+`actions-languageserver` will be available globally. You can start it with:
+
+```bash
+actions-languageserver --stdio
+```
+
+Once linked you can also watch for changes and rebuild automatically:
+
+```bash
+npm run watch:cli
+```
+
 ### Test
 
 ```bash

languageserver/bin/actions-languageserver

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../dist/cli.bundle.cjs";

languageserver/package.json

@@ -31,7 +31,8 @@
     "url": "https://github.com/actions/languageservices"
   },
   "scripts": {
-    "build": "tsc --build tsconfig.build.json",
+    "build": "tsc --build tsconfig.build.json && npm run build:cli",
+    "build:cli": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/cli.bundle.cjs",
     "clean": "rimraf dist",
     "format": "prettier --write '**/*.ts'",
     "format-check": "prettier --check '**/*.ts'",
@@ -40,7 +41,11 @@
     "prepublishOnly": "npm run build && npm run test",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules\" jest",
     "test-watch": "NODE_OPTIONS=\"--experimental-vm-modules\" jest --watch",
-    "watch": "tsc --build tsconfig.build.json --watch"
+    "watch": "tsc --build tsconfig.build.json --watch",
+    "watch:cli": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/cli.bundle.cjs --watch"
+  },
+  "bin": {
+    "actions-languageserver": "./bin/actions-languageserver"
   },
   "dependencies": {
     "@actions/languageservice": "^0.3.25",
@@ -55,12 +60,14 @@
     "node": ">= 18"
   },
   "files": [
-    "dist/**/*"
+    "dist/**/*",
+    "bin/**/*"
   ],
   "devDependencies": {
     "@types/jest": "^29.0.3",
     "@typescript-eslint/eslint-plugin": "^5.56.0",
     "@typescript-eslint/parser": "^5.56.0",
+    "esbuild": "^0.27.1",
     "eslint": "^8.36.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^4.2.1",

languageserver/src/connection.ts

@@ -1,8 +1,11 @@
-import {documentLinks, hover, validate, ValidationConfig} from "@actions/languageservice";
+import {documentLinks, getCodeActions, hover, validate, ValidationConfig} from "@actions/languageservice";
 import {registerLogger, setLogLevel} from "@actions/languageservice/log";
 import {clearCache, clearCacheEntry} from "@actions/languageservice/utils/workflow-cache";
 import {Octokit} from "@octokit/rest";
 import {
+  CodeAction,
+  CodeActionKind,
+  CodeActionParams,
   CompletionItem,
   Connection,
   DocumentLink,
@@ -72,6 +75,9 @@ export function initConnection(connection: Connection) {
         hoverProvider: true,
         documentLinkProvider: {
           resolveProvider: false
+        },
+        codeActionProvider: {
+          codeActionKinds: [CodeActionKind.QuickFix]
         }
       }
     };
@@ -158,6 +164,14 @@ export function initConnection(connection: Connection) {
     return documentLinks(getDocument(documents, textDocument), repoContext?.workspaceUri);
   });
 
+  connection.onCodeAction((params: CodeActionParams): CodeAction[] => {
+    return getCodeActions({
+      uri: params.textDocument.uri,
+      diagnostics: params.context.diagnostics,
+      only: params.context.only
+    });
+  });
+
   // Make the text document manager listen on the connection
   // for open, change and close text document events
   documents.listen(connection);

languageservice/src/code-actions/index.ts

@@ -0,0 +1,50 @@
+import {CodeAction, CodeActionKind, Diagnostic} from "vscode-languageserver-types";
+import {CodeActionContext, CodeActionProvider} from "./types";
+import {quickfixProviders} from "./quickfix";
+
+// Aggregate all providers by kind
+const providersByKind: Map<string, CodeActionProvider[]> = new Map([
+  [CodeActionKind.QuickFix, quickfixProviders]
+  // [CodeActionKind.Refactor, refactorProviders],
+  // [CodeActionKind.Source, sourceProviders],
+  // etc
+]);
+
+export interface CodeActionParams {
+  uri: string;
+  diagnostics: Diagnostic[];
+  only?: string[];
+}
+
+export function getCodeActions(params: CodeActionParams): CodeAction[] {
+  const actions: CodeAction[] = [];
+  const context: CodeActionContext = {
+    uri: params.uri
+  };
+
+  // Filter to requested kinds, or use all if none specified
+  const requestedKinds = params.only;
+  const kindsToCheck = requestedKinds
+    ? [...providersByKind.keys()].filter(kind => requestedKinds.some(requested => kind.startsWith(requested)))
+    : [...providersByKind.keys()];
+
+  for (const diagnostic of params.diagnostics) {
+    for (const kind of kindsToCheck) {
+      const providers = providersByKind.get(kind) ?? [];
+      for (const provider of providers) {
+        if (provider.diagnosticCodes.includes(diagnostic.code)) {
+          const action = provider.createCodeAction(context, diagnostic);
+          if (action) {
+            action.kind = kind;
+            action.diagnostics = [diagnostic];
+            actions.push(action);
+          }
+        }
+      }
+    }
+  }
+
+  return actions;
+}
+
+export type {CodeActionContext, CodeActionProvider} from "./types";

languageservice/src/code-actions/quickfix/add-missing-inputs.ts

@@ -0,0 +1,67 @@
+import {CodeAction, TextEdit} from "vscode-languageserver-types";
+import {CodeActionProvider} from "../types";
+import {DiagnosticCode, MissingInputsDiagnosticData} from "../../validate-action";
+
+export const addMissingInputsProvider: CodeActionProvider = {
+  diagnosticCodes: [DiagnosticCode.MissingRequiredInputs],
+
+  createCodeAction(context, diagnostic): CodeAction | undefined {
+    const data = diagnostic.data as MissingInputsDiagnosticData | undefined;
+    if (!data) {
+      return undefined;
+    }
+
+    const edits = createInputEdits(data);
+    if (!edits) {
+      return undefined;
+    }
+
+    const inputNames = data.missingInputs.map(i => i.name).join(", ");
+
+    return {
+      title: `Add missing input${data.missingInputs.length > 1 ? "s" : ""}: ${inputNames}`,
+      edit: {
+        changes: {
+          [context.uri]: edits
+        }
+      }
+    };
+  }
+};
+
+function createInputEdits(data: MissingInputsDiagnosticData): TextEdit[] | undefined {
+  const edits: TextEdit[] = [];
+
+  if (data.hasWithKey && data.withIndent !== undefined) {
+    // `with:` exists - use its indentation + 2 for inputs
+    const inputIndent = " ".repeat(data.withIndent + 2);
+
+    const inputLines = data.missingInputs.map(input => {
+      const value = input.default !== undefined ? input.default : '""';
+      return `${inputIndent}${input.name}: ${value}`;
+    });
+
+    edits.push({
+      range: {start: data.insertPosition, end: data.insertPosition},
+      newText: inputLines.map(line => line + "\n").join("")
+    });
+  } else {
+    // No `with:` key - `with:` at step indentation, inputs at step indentation + 2
+    const withIndent = " ".repeat(data.stepIndent);
+    const inputIndent = " ".repeat(data.stepIndent + 2);
+
+    const inputLines = data.missingInputs.map(input => {
+      const value = input.default !== undefined ? input.default : '""';
+      return `${inputIndent}${input.name}: ${value}`;
+    });
+
+    const newText = [`${withIndent}with:\n`, ...inputLines.map(line => `${line}\n`)].join("");
+
+    edits.push({
+      range: {start: data.insertPosition, end: data.insertPosition},
+      newText
+    });
+  }
+
+  return edits;
+}

languageservice/src/code-actions/quickfix/index.ts

@@ -0,0 +1,4 @@
+import {CodeActionProvider} from "../types";
+import {addMissingInputsProvider} from "./add-missing-inputs";
+
+export const quickfixProviders: CodeActionProvider[] = [addMissingInputsProvider];