refactor: modernize code (#120)

BREAKING CHANGE: Project is now ESM
BREAKING CHANGE: Now requires Probot v14 or later
BREAKING CHANGE: Requires Node 20, or 22 and later

Author: Uzlopak

.github/workflows/release.yml

@@ -1,5 +1,5 @@
 name: Release
-"on":
+on:
   push:
     branches:
       - master
@@ -11,13 +11,17 @@ jobs:
     name: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: true
+      - uses: actions/setup-node@v6
         with:
           node-version: lts/*
           cache: npm
-      - run: npm ci
-      - run: npx semantic-release
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        run: npx semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.PROBOTBOT_NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,5 +1,5 @@
 name: Test
-"on":
+on:
   push:
     branches:
       - master
@@ -8,13 +8,37 @@ name: Test
       - opened
       - synchronize
 jobs:
-  build:
+  test:
+    name: Test on Node.js ${{ matrix.node-version }}
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22, 24]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v5
         with:
-          node-version: 16
+          persist-credentials: false
+      - uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm run test
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
           cache: npm
-      - run: npm install
-      - run: npm test
+      - name: Install dependencies
+        run: npm install
+      - name: Lint
+        run: npm run lint

README.md

@@ -5,26 +5,26 @@ A [Probot](https://github.com/probot/probot) extension to store metadata on Issu
 ## Usage
 
 ```js
-const metadata = require('probot-metadata');
+import metadata from "probot-metadata";
 
 // where `context` is a Probot `Context`
-await metadata(context).set(key, value)
+await metadata(context).set(key, value);
 
-const value = await metadata(context).get(key)
+const value = await metadata(context).get(key);
 ```
 
 ## Example
 
 ```js
-const metadata = require('probot-metadata');
+import metadata from "probot-metadata";
 
-module.exports = robot => {
-  robot.on('issue_comment.created', async context => {
-    match = context.payload.comment.body.match('/snooze (.*)')
-    if(match) {
-      metadata(context).set('snooze', match[1])
+export default function (robot) {
+  robot.on("issue_comment.created", async (context) => {
+    match = context.payload.comment.body.match("/snooze (.*)");
+    if (match) {
+      metadata(context).set("snooze", match[1]);
     }
-  })
+  });
 }
 ```
 

eslint.config.js

@@ -0,0 +1,3 @@
+import neostandard from 'neostandard'
+
+export default neostandard({})

index.d.ts

@@ -1,18 +1,16 @@
-import { Context } from "probot";
-
-type StringOrNumber = number | string;
-type Key =
-  | { [key: string]: StringOrNumber }
-  | StringOrNumber[]
-  | StringOrNumber;
-type Value = Key;
-
-declare function metadata(
-  context: Context,
-  issue?: { body: string; [key: string]: any }
-): {
-  get(key?: Key): Promise<any>;
-  set(key: Key, value: Value): Promise<any>;
+export default metadata;
+export type StringOrNumber = string | number;
+export type Key = Record<string, StringOrNumber> | StringOrNumber | StringOrNumber[];
+export type Value = Key;
+export type IssueOption = {
+    owner: string;
+    repo: string;
+    issue_number: number;
+    body?: string;
 };
-
-export = metadata;
+export type ProbotMetadata = {
+    get: (key?: Key) => Promise<Value | undefined>;
+    set: (key?: Key, value?: Value) => Promise<void>;
+};
+export type ProbotMetadataConstructor = (context: import("probot").Context<"issue_comment">, issue?: IssueOption) => ProbotMetadata;
+export const metadata: ProbotMetadataConstructor;

index.js

@@ -1,53 +1,89 @@
-const regex = /(\n\n|\r\n)<!-- probot = (.*) -->/
+const probotMetadataRegex = /(?:\n\n|\r\n)<!-- probot = (.*) -->/
+const prototypePollutionKeys = /** @type {const} */(['__proto__', 'constructor', 'prototype'])
 
-module.exports = (context, issue = null) => {
-  const github = context.octokit || context.github
-  const prefix = context.payload.installation.id
+const metadata = /** @type {ProbotMetadataConstructor} */ (context, issue) => {
+  const octokit = context.octokit
+  const prefix = /** @type {{ id: number; node_id: string; }} */ (context.payload.installation).id
 
   if (!issue) issue = context.issue()
 
   return {
-    async get (key = null) {
+    async get (key) {
       let body = issue.body
 
       if (!body) {
-        body = (await github.issues.get(issue)).data.body || ''
+        body = (await octokit.rest.issues.get(issue)).data.body || ''
       }
 
-      const match = body.match(regex)
+      const match = body.match(probotMetadataRegex)
 
       if (match) {
-        const data = JSON.parse(match[2])[prefix]
-        return key ? data && data[key] : data
+        const probotMetadata = JSON.parse(match[1])
+        const data = probotMetadata[prefix]
+        return typeof key === 'string' || typeof key === 'number'
+          ? data && data[key]
+          : data
       }
     },
 
     async set (key, value) {
       let body = issue.body
-      let data = {}
+      /** @type {Record<number, Record<number|string, any>>} */
+      let data = Object.create(null)
 
-      if (!body) body = (await github.issues.get(issue)).data.body || ''
+      if (!body) body = (await octokit.rest.issues.get(issue)).data.body || ''
 
-      const match = body.match(regex)
+      const match = body.match(probotMetadataRegex)
 
       if (match) {
-        data = JSON.parse(match[2])
+        data = JSON.parse(match[1])
       }
 
-      body = body.replace(regex, '')
+      body = body.replace(probotMetadataRegex, '')
 
-      if (!data[prefix]) data[prefix] = {}
+      if (!data[prefix]) data[prefix] = Object.create(null)
 
-      if (typeof key === 'object') {
-        Object.assign(data[prefix], key)
-      } else {
+      // should never happen, but just in case
+      if (typeof prefix === 'string' && prototypePollutionKeys.includes(prefix)) {
+        throw new TypeError('Invalid prefix value')
+      }
+      if (typeof key === 'string' || typeof key === 'number') {
         data[prefix][key] = value
+      } else {
+        Object.assign(data[prefix], key)
       }
 
-      body = `${body}\n\n<!-- probot = ${JSON.stringify(data)} -->`
+      await octokit.rest.issues.update({
+        owner: issue.owner,
+        repo: issue.repo,
+        issue_number: issue.issue_number,
+        body: `${body}\n\n<!-- probot = ${JSON.stringify(data)} -->`
+      })
 
-      const { owner, repo, issue_number } = issue
-      return github.issues.update({ owner, repo, issue_number, body })
+      issue.body = `${body}\n\n<!-- probot = ${JSON.stringify(data)} -->`
     }
   }
 }
+
+export default metadata
+export { metadata }
+
+/** @typedef {string|number} StringOrNumber */
+/** @typedef {Record<string, StringOrNumber>|StringOrNumber|StringOrNumber[]} Key */
+/** @typedef {Key} Value */
+
+/**
+ * @typedef {object} IssueOption
+ * @property {string} owner
+ * @property {string} repo
+ * @property {number} issue_number
+ * @property {string} [body]
+ */
+
+/**
+ * @typedef {object} ProbotMetadata
+ * @property {(key?: Key)=>Promise<Value|undefined>} get
+ * @property {(key?: Key, value?: Value)=>Promise<void>} set
+ */
+
+/** @typedef {(context: import('probot').Context<'issue_comment'>, issue?: IssueOption)=>ProbotMetadata} ProbotMetadataConstructor */