feat: rewrite the whole module with typescript (including upgrade node, drop mocha and replace it native test module ...etc)

3imed-jaberi · 3imed-jaberi · commit caaa49b8ddca · 2025-11-09T13:57:17.000+01:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,23 @@
+name: Continuous Integration
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 20
+          - 22
+          - 24
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+      - name: Install dependencies
+        run: yarn install
+      - name: Run tests
+        run: yarn test-ci
diff --git a/.gitignore b/.gitignore
@@ -11,10 +11,15 @@ temp/
 ###################
 node_modules
 package-lock.json
+yarn.lock
 npm-debug.log
 yarn-debug.log
 yarn-error.log
 
+#      Build      #
+###################
+dist
+build
 
 #       NYC       #
 ###################
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# [**koa-is-json**](https://github.com/koajs/is-json)
+# [**@koa/is-json**](https://github.com/koajs/is-json)
 
 [![Greenkeeper badge](https://badges.greenkeeper.io/koajs/is-json.svg)](https://greenkeeper.io/)
 
@@ -7,4 +7,4 @@
 
 ## License
 
-[MIT](/LICENSE)
+[MIT](/LICENSE)
diff --git a/package.json b/package.json
@@ -1,22 +1,39 @@
 {
-  "name": "koa-is-json",
-  "description": "Check if a koa body should be interpreted as JSON",
+  "name": "@koa/is-json",
   "version": "1.0.0",
-  "scripts": {
-    "lint": "eslint --fix .",
-    "test-only": "mocha",
-    "test": "npm run lint & npm run test-only",
-    "test-cov": "nyc npm run test"
+  "description": "Check if a koa body should be interpreted as JSON",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/koajs/is-json.git"
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "tsup",
+    "test": "node  --require ts-node/register --test",
+    "test-ci": "npm run test -- --experimental-test-coverage",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
+    "koa",
+    "utils",
+    "helpers",
     "json",
-    "is-json",
-    "koa"
+    "is-json"
   ],
+  "license": "MIT",
+  "peerDependencies": {
+    "koa": ">= 2"
+  },
   "author": {
     "name": "Jonathan Ong",
     "email": "me@jongleberry.com",
@@ -37,26 +54,19 @@
       "twitter": "https://twitter.com/3imed_jaberi"
     }
   ],
-  "license": "MIT",
-  "nyc": {
-    "reporter": [
-      "lcov",
-      "text-summary"
-    ],
-    "report-dir": "./coverage"
-  },
   "devDependencies": {
-    "eslint": "^8.19.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.8.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "eslint-plugin-standard": "^5.0.0",
-    "mocha": "^10.0.0",
-    "nyc": "^15.0.0"
+    "@types/node": "^24.10.0",
+    "rimraf": "^6.1.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.3"
   },
   "engines": {
-    "node": ">= 8"
+    "node": ">= 20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/koajs/is-json.git"
   },
   "bugs": {
     "url": "https://github.com/koajs/is-json/issues"
diff --git a/src/index.ts b/src/index.ts
@@ -3,12 +3,13 @@
  * Check if `body` should be interpreted as json.
  *
  */
-
-module.exports = function isJSON (body) {
+export const isJSON = (body?: any): boolean => {
   return !(
     !body ||
     typeof body === 'string' ||
     typeof body.pipe === 'function' ||
     Buffer.isBuffer(body)
   )
 }
+
+export default isJSON;
diff --git a/test/.eslintrc b/test/.eslintrc
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -1,6 +1,7 @@
+import assert from 'node:assert';
+import { describe, it } from 'node:test';
 
-const assert = require('assert')
-const isJSON = require('..')
+import isJSON from '../src';
 
 describe('koa-is-json test', () => {
   let body
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "lib": [
+      "dom",
+      "es6",
+      "es2017",
+      "esnext.asynciterable"
+    ],
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "moduleResolution": "node",
+    "removeComments": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "resolveJsonModule": true,
+    "baseUrl": ".",
+    "types": ["node"]
+  },
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "exclude": [
+    "dist",
+    "node_modules",
+    "src/**/*.test.tsx"
+  ]
+}
diff --git a/tsup.config.ts b/tsup.config.ts
@@ -0,0 +1,15 @@
+import {defineConfig} from 'tsup';
+
+const tsupConfig = defineConfig({
+  name: '@koa/is-json',
+  entry: ['src/*.ts'],
+  target: 'esnext',
+  format: ['cjs', 'esm'],
+  dts: true,
+  splitting: false,
+  sourcemap: false,
+  clean: true,
+  platform: 'node',
+});
+
+export default tsupConfig;

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,13 @@`
`3`	`3`	* Check if `body` should be interpreted as json.
`4`	`4`	`*`
`5`	`5`	`*/`
`6`		`-`
`7`		`-module.exports = function isJSON (body) {`
	`6`	`+export const isJSON = (body?: any): boolean => {`
`8`	`7`	`return !(`
`9`	`8`	`!body \|\|`
`10`	`9`	`typeof body === 'string' \|\|`
`11`	`10`	`typeof body.pipe === 'function' \|\|`
`12`	`11`	`Buffer.isBuffer(body)`
`13`	`12`	`)`
`14`	`13`	`}`
	`14`	`+`
	`15`	`+export default isJSON;`