Feat: convert koa to ts

.github/workflows/node.js.yml

@@ -2,27 +2,31 @@ name: Node.js CI
 
 on:
   push:
-    branch: master
+    branches: [master]
   pull_request:
-    branch: master
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [18.x, 20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run lint
-    - run: npm run test:coverage
-    - run: npx codecov
-      continue-on-error: true
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build
+      # https://github.com/nodejs/node/issues/55054 multiple issues with experimental code coverage
+      # with source maps make test coverage unusable.
+      # TODO: use code coverage when it is fixed by node core teams
+      - run: npm run test
+      # - run: npm run test:coverage
+      # - run: npx codecov
+      #   continue-on-error: true

.xo-config.json

@@ -0,0 +1,29 @@
+{
+  "prettier": true,
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "ignore": "**/*.js",
+  "rules": {
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/naming-convention": "off",
+    "@typescript-eslint/consistent-type-definitions": "off",
+    "@typescript-eslint/promise-function-async": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-namespace": "off",
+    "unicorn/prevent-abbreviations": "off",
+    "unicorn/prefer-module": "off",
+    "unicorn/prefer-ternary": "off",
+    "capitalized-comments": "off",
+    "unicorn/no-array-reduce": "off",
+    "no-warning-comments": "off",
+    "max-depth": "off",
+    "complexity": "off",
+    "no-multi-assign": "off",
+    "accessor-pairs": "error",
+    "prefer-destructuring": "off",
+    "logical-assignment-operators": "off"
+  }
+}

__tests__/application/compose.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.compose', () => {
   it('should work with default compose ', async () => {

__tests__/application/context.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.context', () => {
   const app1 = new Koa()

__tests__/application/currentContext.test.js

@@ -1,20 +1,12 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.currentContext', () => {
-  it('should throw error if AsyncLocalStorage not support', () => {
-    if (require('async_hooks').AsyncLocalStorage) return
-    assert.throws(() => new Koa({ asyncLocalStorage: true }),
-      /Requires node 12\.17\.0 or higher to enable asyncLocalStorage/)
-  })
-
   it('should get currentContext return context when asyncLocalStorage enable', async () => {
-    if (!require('async_hooks').AsyncLocalStorage) return
-
     const app = new Koa({ asyncLocalStorage: true })
 
     app.use(async ctx => {

__tests__/application/index.test.js

@@ -1,9 +1,10 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
+import CreateError from 'http-errors'
 
 describe('app', () => {
   // ignore test on Node.js v18
@@ -64,8 +65,6 @@ describe('app', () => {
   })
 
   it('should have a static property exporting `HttpError` from http-errors library', () => {
-    const CreateError = require('http-errors')
-
     assert.notEqual(Koa.HttpError, undefined)
     assert.deepStrictEqual(Koa.HttpError, CreateError.HttpError)
     assert.throws(() => { throw new CreateError(500, 'test error') }, Koa.HttpError)

__tests__/application/inspect.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const assert = require('assert')
-const util = require('util')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import assert from 'assert'
+import util from 'util'
+import Koa from '../../dist/application.js'
 
 process.env.NODE_ENV = 'test'
 const app = new Koa()

__tests__/application/onerror.test.js

@@ -1,8 +1,9 @@
 'use strict'
 
-const { describe, it, mock } = require('node:test')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it, mock } from 'node:test'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
+import vm from 'node:vm'
 
 describe('app.onerror(err)', () => {
   it('should throw an error if a non-error is given', () => {
@@ -14,7 +15,7 @@ describe('app.onerror(err)', () => {
   })
 
   it('should accept errors coming from other scopes', () => {
-    const ExternError = require('vm').runInNewContext('Error')
+    const ExternError = vm.runInNewContext('Error')
 
     const app = new Koa()
     const error = Object.assign(new ExternError('boom'), {

__tests__/application/request.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.request', () => {
   const app1 = new Koa()

__tests__/application/respond.test.js

@@ -1,11 +1,17 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const statuses = require('statuses')
-const assert = require('assert')
-const Koa = require('../..')
-const fs = require('fs')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import statuses from 'statuses'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
+import fs from 'fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, '..', '..', 'package.json')))
 
 describe('app.respond', () => {
   describe('when ctx.respond === false', () => {
@@ -616,7 +622,6 @@ describe('app.respond', () => {
         .get('/')
         .expect('Content-Type', 'application/json; charset=utf-8')
 
-      const pkg = require('../../package')
       assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), false)
       assert.deepStrictEqual(res.body, pkg)
     })
@@ -634,7 +639,6 @@ describe('app.respond', () => {
         .get('/')
         .expect('Content-Type', 'application/json; charset=utf-8')
 
-      const pkg = require('../../package')
       assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), false)
       assert.deepStrictEqual(res.body, pkg)
     })
@@ -652,7 +656,6 @@ describe('app.respond', () => {
         .get('/')
         .expect('Content-Type', 'application/json; charset=utf-8')
 
-      const pkg = require('../../package')
       assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), true)
       assert.deepStrictEqual(res.body, pkg)
     })
@@ -673,7 +676,6 @@ describe('app.respond', () => {
           .get('/')
           .expect('Content-Type', 'application/json; charset=utf-8')
 
-        const pkg = require('../../package')
         assert.strictEqual(Object.prototype.hasOwnProperty.call(res.headers, 'content-length'), true)
         assert.deepStrictEqual(res.body, pkg)
       })

__tests__/application/response.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.response', () => {
   const app1 = new Koa()

__tests__/application/toJSON.test.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.toJSON()', () => {
   it('should work', () => {

__tests__/application/use.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('app.use(fn)', () => {
   it('should compose middleware', async () => {

__tests__/context/assert.test.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const context = require('../../test-helpers/context')
-const assert = require('assert')
+import { describe, it } from 'node:test'
+import context from '../../test-helpers/context.js'
+import assert from 'assert'
 
 describe('ctx.assert(value, status)', () => {
   it('should throw an error', () => {

__tests__/context/cookies.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const assert = require('assert')
-const request = require('supertest')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import assert from 'assert'
+import request from 'supertest'
+import Koa from '../../dist/application.js'
 
 describe('ctx.cookies', () => {
   describe('ctx.cookies.set()', () => {

__tests__/context/inspect.test.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const prototype = require('../../lib/context')
-const assert = require('assert')
-const util = require('util')
-const context = require('../../test-helpers/context')
+import { describe, it } from 'node:test'
+import prototype from '../../dist/context.js'
+import assert from 'assert'
+import util from 'util'
+import context from '../../test-helpers/context.js'
 
 describe('ctx.inspect()', () => {
   it('should return a json representation', () => {

__tests__/context/onerror.test.js

@@ -1,11 +1,11 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const assert = require('assert')
-const request = require('supertest')
-const Koa = require('../..')
-const context = require('../../test-helpers/context')
-
+import { describe, it } from 'node:test'
+import assert from 'assert'
+import request from 'supertest'
+import Koa from '../../dist/application.js'
+import context from '../../test-helpers/context.js'
+import vm from 'node:vm'
 describe('ctx.onerror(err)', () => {
   it('should respond', () => {
     const app = new Koa()
@@ -192,8 +192,7 @@ describe('ctx.onerror(err)', () => {
 
   describe('when error from another scope thrown', () => {
     it('should handle it like a normal error', async () => {
-      const ExternError = require('vm').runInNewContext('Error')
-
+      const ExternError = vm.runInNewContext('Error')
       const app = new Koa()
       const error = Object.assign(new ExternError('boom'), {
         status: 418,

__tests__/context/state.test.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const request = require('supertest')
-const assert = require('assert')
-const Koa = require('../..')
+import { describe, it } from 'node:test'
+import request from 'supertest'
+import assert from 'assert'
+import Koa from '../../dist/application.js'
 
 describe('ctx.state', () => {
   it('should provide a ctx.state namespace', () => {

__tests__/context/throw.test.js

@@ -1,8 +1,8 @@
 'use strict'
 
-const { describe, it } = require('node:test')
-const context = require('../../test-helpers/context')
-const assert = require('assert')
+import { describe, it } from 'node:test'
+import context from '../../test-helpers/context.js'
+import assert from 'assert'
 
 describe('ctx.throw(msg)', () => {
   it('should set .status to 500', () => {