Merge pull request #77 from github/cschleiden/user-agent

Set custom user agent including the extension's version

Author: cschleiden

package-lock.json

@@ -1,9 +1,12 @@
 import {Octokit} from "@octokit/rest";
+import {version} from "../../package.json";
+
+// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+export const userAgent = `VS Code GitHub Actions (${version})`;
 
 export function getClient(token: string): Octokit {
   return new Octokit({
     auth: token,
-    userAgent: "VS Code GitHub Actions",
-    previews: ["jane-hopper"]
+    userAgent: userAgent
   });
 }

src/api/api.ts

@@ -6,6 +6,7 @@ import {InitializationOptions, LogLevel} from "@github/actions-languageserver/in
 import {BaseLanguageClient, LanguageClientOptions} from "vscode-languageclient";
 import {LanguageClient as BrowserLanguageClient} from "vscode-languageclient/browser";
 import {LanguageClient as NodeLanguageClient, ServerOptions, TransportKind} from "vscode-languageclient/node";
+import {userAgent} from "../api/api";
 import {getSession} from "../auth/auth";
 import {getGitHubContext} from "../git/repository";
 import {WorkflowSelector} from "./documentSelector";
@@ -23,6 +24,7 @@ export async function initLanguageServer(context: vscode.ExtensionContext) {
   const ghContext = await getGitHubContext();
   const initializationOptions: InitializationOptions = {
     sessionToken: session.accessToken,
+    userAgent: userAgent,
     repos: ghContext?.repos.map(repo => ({
       id: repo.id,
       owner: repo.owner,

src/client/client.ts

@@ -8,7 +8,7 @@
     "sourceMap": true,
     "strict": true,
     "moduleResolution": "node",
-    "rootDir": "src",
-    "outDir": "out"
+    "outDir": "out",
+    "resolveJsonModule": true
   }
 }