ts plugin: Suggest 'use workflow' and 'use step' autocomplete

also: add a fix id for the typo code fix
so it won't be repeated.

Author: Schniz

packages/typescript-plugin/src/code-fixes.ts

@@ -77,6 +77,7 @@ export function getCodeFixes(
 
   fixes.push({
     fixName: 'fix-directive-typo',
+    fixId: 'workflow--fix-directive-typo',
     description: `Replace with '${expectedDirective}'`,
     changes: [change],
   });

packages/typescript-plugin/src/completions.ts

@@ -8,15 +8,55 @@ export function enhanceCompletions(
   program: ts.Program,
   ts: typeof import('typescript/lib/tsserverlibrary')
 ): ts.WithMetadata<ts.CompletionInfo> | undefined {
-  if (!prior) return prior;
-
   const sourceFile = program.getSourceFile(fileName);
   if (!sourceFile) return prior;
 
   // Find the enclosing function
   const node = findNodeAtPosition(sourceFile, position);
+
   if (!node) return prior;
 
+  if (
+    node.parent.getChildAt(0) === node &&
+    node.kind === ts.SyntaxKind.StringLiteral
+  ) {
+    // return `"use workflow"` or `"use step"` completions
+    return {
+      ...prior,
+      entries: [
+        {
+          name: '"use workflow"',
+          kind: ts.ScriptElementKind.string,
+          kindModifiers: '',
+          sortText: '0',
+          labelDetails: {
+            description: 'Marks the function as a workflow',
+          },
+          source: 'Workflow Development Kit',
+          insertText: '"use workflow";',
+          replacementSpan: { start: node.getStart(), length: node.getWidth() },
+          isRecommended: true,
+        },
+        {
+          name: '"use step"',
+          kind: ts.ScriptElementKind.string,
+          kindModifiers: '',
+          sortText: '0',
+          insertText: '"use step";',
+          labelDetails: {
+            description: 'Marks the function as a step',
+          },
+          source: 'Workflow Development Kit',
+          replacementSpan: { start: node.getStart(), length: node.getWidth() },
+          isRecommended: true,
+        },
+        ...(prior ? prior.entries : []),
+      ],
+    };
+  }
+
+  if (!prior) return prior;
+
   const enclosingFunction = findEnclosingFunction(node);
   if (!enclosingFunction) return prior;
 

packages/world-testing/package.json

@@ -32,6 +32,7 @@
     "@types/node": "catalog:",
     "@types/jsonlines": "^0.1.5",
     "@workflow/tsconfig": "workspace:*",
+    "@workflow/typescript-plugin": "workspace:*",
     "vitest": "catalog:"
   },
   "peerDependencies": {

packages/world-testing/tsconfig.json

@@ -4,8 +4,13 @@
     "moduleResolution": "NodeNext",
     "allowJs": true,
     "module": "NodeNext",
-    "outDir": "dist"
+    "outDir": "dist",
+    "plugins": [
+      {
+        "name": "workflow"
+      }
+    ]
   },
-  "include": ["src", ".well-known"],
+  "include": ["src", ".well-known", "workflows"],
   "exclude": ["node_modules", "**/*.test.ts"]
 }