Convert to TypeScript.

Signed-off-by: Anders Kaseorg <anders@zulip.com>

Author: andersk

.github/README.md

@@ -27,12 +27,12 @@ the **zulipbot wiki**.
 
 ## Usage
 
-If you're using the [Zulip project configuration](../config/config-example.js)
-(`./config/config-example.js`), see zulipbot's [usage
+If you're using the [Zulip project configuration](../config/config-example.ts)
+(`./config/config-example.ts`), see zulipbot's [usage
 instructions](https://zulip.readthedocs.io/en/latest/contributing/zulipbot-usage.html)
 on the Zulip documentation.
 
-If you're using your own custom configuration (`./config/config.js` is different
+If you're using your own custom configuration (`./config/config.ts` is different
 from the Zulip project configuration), please visit the
 [Commands](https://github.com/zulip/zulipbot/wiki/Commands) page on the
 **zulipbot wiki**.

.github/workflows/node.js.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: pnpm
-      - run: ln -s config-example.js config/config.js
+      - run: ln -s config-example.ts config/config.ts
       - run: pnpm install --frozen-lockfile
       - run: pnpm test
       - uses: codecov/codecov-action@v5

.gitignore

@@ -1,4 +1,4 @@
 .tap
 node_modules
-/config/config.js
+/config/config.ts
 /config/secrets.json

.prettierignore

@@ -1,5 +1,5 @@
 .tap
-/config/config.js
+/config/config.ts
 /config/secrets.json
 /pnpm-lock.yaml
 /pnpm-workspace.yaml

config/config-example.js config/config-example.tsconfig/config-example.js renamed to config/config-example.ts

@@ -5,10 +5,16 @@
  * explanations on each option.
  */
 
+import { safeCastTo } from "ts-extras";
+
 // Default authentication specified by environment variables
-export const auth = {
-  oAuthToken: process.env.OAUTH_TOKEN,
-  webhookSecret: process.env.WEBHOOK_SECRET,
+export const auth: {
+  oAuthToken: string | undefined;
+  webhookSecret: string | undefined;
+  username?: string;
+} = {
+  oAuthToken: process.env["OAUTH_TOKEN"],
+  webhookSecret: process.env["WEBHOOK_SECRET"],
 };
 
 /**
@@ -20,27 +26,27 @@ export const auth = {
 export const issues = {
   commands: {
     assign: {
-      claim: [],
-      abandon: [],
+      claim: new Array<string>(),
+      abandon: new Array<string>(),
       limit: Number.POSITIVE_INFINITY,
       newContributors: {
-        permission: null,
+        permission: safeCastTo<string | null>(null),
         restricted: Number.POSITIVE_INFINITY,
       },
       warn: {
-        labels: [],
+        labels: new Array<string>(),
         presence: false,
         force: true,
       },
     },
     label: {
-      add: [],
-      remove: [],
-      self: false,
+      add: new Array<string>(),
+      remove: new Array<string>(),
+      self: safeCastTo<boolean | { users: string[] }>(false),
     },
   },
   area: {
-    labels: null,
+    labels: safeCastTo<Map<string, string> | null>(null),
     references: false,
   },
 };
@@ -56,18 +62,22 @@ export const pulls = {
   status: {
     mergeConflicts: {
       branch: "main",
-      label: null,
+      label: safeCastTo<string | null>(null),
       comment: false,
     },
-    wip: null,
+    wip: safeCastTo<string | null>(null),
     size: {
-      labels: null,
-      exclude: [],
+      labels: safeCastTo<Map<string, number> | null>(null),
+      exclude: new Array<string>(),
     },
   },
   references: {
     required: false,
-    labels: false,
+    labels: safeCastTo<
+      | { include: string[]; exclude?: never }
+      | { include?: never; exclude: string[] }
+      | false
+    >(false),
   },
 };
 
@@ -79,25 +89,25 @@ export const pulls = {
  */
 
 export const activity = {
-  inactive: null,
+  inactive: safeCastTo<string | null>(null),
   check: {
-    repositories: [],
-    interval: null,
-    reminder: null,
-    limit: null,
+    repositories: new Array<string>(),
+    interval: safeCastTo<number | null>(null),
+    reminder: safeCastTo<number | null>(null),
+    limit: safeCastTo<number | null>(null),
   },
   issues: {
-    inProgress: null,
+    inProgress: safeCastTo<string | undefined>(undefined),
     clearClosed: false,
   },
   pulls: {
     autoUpdate: true,
     reviewed: {
-      label: null,
-      assignee: null,
+      label: safeCastTo<string | null>(null),
+      assignee: safeCastTo<boolean | null>(null),
     },
     needsReview: {
-      label: null,
+      label: safeCastTo<string | null>(null),
       ignore: false,
     },
   },

config/default.js config/default.tsconfig/default.js renamed to config/default.ts

@@ -26,6 +26,8 @@ export default defineConfig(
     },
     rules: {
       "@stylistic/curly-newline": "off", // https://github.com/prettier/eslint-config-prettier/issues/351
+      "@typescript-eslint/naming-convention": "off",
+      "@typescript-eslint/no-restricted-types": "off",
       "arrow-body-style": "error",
       "capitalized-comments": "off",
       curly: ["error", "multi-line", "consistent"],
@@ -50,6 +52,7 @@ export default defineConfig(
       strict: "error",
       "unicorn/no-null": "off",
       "unicorn/no-process-exit": "off",
+      "unicorn/no-useless-undefined": "off",
       "unicorn/numeric-separators-style": "off",
       "unicorn/prefer-node-protocol": "off",
       "unicorn/prefer-ternary": "off",

eslint.config.js

@@ -4,8 +4,8 @@
   "description": "GitHub workflow-optimizing bot",
   "type": "module",
   "scripts": {
-    "start": "node ./src/index.js",
-    "pretest": "eslint . && prettier --check . '!**/*.js' '!**/*.ts'",
+    "start": "node ./src/index.ts",
+    "pretest": "tsc && eslint . && prettier --check . '!**/*.js' '!**/*.ts'",
     "test": "tap --coverage-report=lcovonly"
   },
   "packageManager": "pnpm@10.26.2+sha512.0e308ff2005fc7410366f154f625f6631ab2b16b1d2e70238444dd6ae9d630a8482d92a451144debc492416896ed16f7b114a86ec68b8404b2443869e68ffda6",

package.json

@@ -4,23 +4,51 @@ import { retry } from "@octokit/plugin-retry";
 import { throttling } from "@octokit/plugin-throttling";
 import { Octokit } from "@octokit/rest";
 import _ from "lodash";
+import { assertDefined } from "ts-extras";
+import type { Writable } from "type-fest";
 
-import * as custom from "../config/config.js";
-import * as defaults from "../config/default.js";
+import * as custom from "../config/config.ts";
+import * as defaults from "../config/default.ts";
 
-import commands from "./commands/index.js";
-import Template from "./structures/template.js";
+import commands, {
+  type CommandAliases,
+  type CommandPayload,
+} from "./commands/index.ts";
+import Template from "./structures/template.ts";
+
+const MyOctokit: typeof Octokit &
+  (new (
+    ...args: any[]
+  ) => ReturnType<typeof retry> & ReturnType<typeof throttling>) =
+  Octokit.plugin(retry, throttling);
+
+export class Client extends MyOctokit {
+  cfg: Writable<typeof defaults>;
+  commands: Map<
+    string,
+    {
+      run: (
+        this: Client,
+        payload: CommandPayload,
+        commenter: string,
+        args: string,
+      ) => Promise<unknown>;
+      aliasPath: (commands: CommandAliases) => string[];
+    }
+  >;
+
+  invites: Map<string, number>;
+  templates: Map<string, Template>;
 
-export class Client extends Octokit.plugin(retry, throttling) {
   constructor() {
-    const cfg = _.merge({}, defaults, custom);
+    const cfg: Writable<typeof defaults> = _.merge({}, defaults, custom);
     super({
       auth: cfg.auth.oAuthToken,
       retry: {
-        enabled: process.env.NODE_ENV !== "test",
+        enabled: process.env["NODE_ENV"] !== "test",
       },
       throttle: {
-        enabled: process.env.NODE_ENV !== "test",
+        enabled: process.env["NODE_ENV"] !== "test",
         onRateLimit: (retryAfter, { method, url }, _octokit, retryCount) => {
           if (retryCount < 3) {
             this.log.warn(
@@ -36,8 +64,9 @@ export class Client extends Octokit.plugin(retry, throttling) {
               retryCount + 1
             } times for ${method} ${url}; aborting`,
           );
+          return; // eslint-disable-line no-useless-return
         },
-        onSecondaryRateLimit: (retryAfter, { method, url }) => {
+        onSecondaryRateLimit: (_retryAfter, { method, url }) => {
           this.log.warn(
             `Secondary rate limit detected for ${method} ${url}; aborting`,
           );
@@ -62,6 +91,7 @@ export class Client extends Octokit.plugin(retry, throttling) {
     );
     for (const file of templates) {
       const [name] = file.split(".md");
+      assertDefined(name);
       const content = fs.readFileSync(
         new URL(`../config/templates/${file}`, import.meta.url),
         "utf8",

src/client.js src/client.tssrc/client.js renamed to src/client.ts

@@ -1,8 +1,16 @@
-export const run = function (payload, commenter) {
+import type { Client } from "../client.ts";
+
+import type { CommandAliases, CommandPayload } from "./index.ts";
+
+export const run = async function (
+  this: Client,
+  payload: CommandPayload,
+  commenter: string,
+) {
   const repoOwner = payload.repository.owner.login;
   const repoName = payload.repository.name;
   const number = payload.issue.number;
-  const assignees = payload.issue.assignees.map((assignee) => assignee.login);
+  const assignees = payload.issue.assignees.map((assignee) => assignee?.login);
 
   if (!assignees.includes(commenter)) {
     const error = "**ERROR:** You have not claimed this issue to work on yet.";
@@ -22,4 +30,4 @@ export const run = function (payload, commenter) {
   });
 };
 
-export const aliasPath = (commands) => commands.assign.abandon;
+export const aliasPath = (commands: CommandAliases) => commands.assign.abandon;