feat: support cjs and esm both by tshy

BREAKING CHANGE: drop Node.js < 18.19.0 support and only support egg>=4

part of eggjs/egg#3644

eggjs/egg#5257

Author: fengmk2

.eslintignore

@@ -12,6 +12,6 @@ jobs:
     uses: node-modules/github-actions/.github/workflows/node-test-mysql.yml@master
     with:
       os: 'ubuntu-latest'
-      version: '16, 18, 20, 22'
+      version: '18, 20, 22'
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.eslintrc

@@ -0,0 +1,141 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "env": {
+    "node": true,
+    "mocha": true
+  },
+  "categories": {
+    "correctness": "error",
+    "perf": "error",
+    "nursery": "error",
+    "restriction": "error",
+    "style": "error",
+    "pedantic": "error",
+    "suspicious": "error"
+  },
+  "plugins": [
+    "import",
+    "typescript",
+    "unicorn",
+    "jsdoc",
+    "node",
+    "promise",
+    "oxc"
+  ],
+  "rules": {
+    // eslint
+    "constructor-super": "error",
+    "getter-return": "error",
+    "no-undef": "error",
+    "no-unreachable": "error",
+    "no-var": "error",
+    "no-eq-null": "error",
+    "no-await-in-loop": "allow",
+    "eqeqeq": ["error", "smart"],
+    "init-declarations": "allow",
+    "curly": "allow",
+    "no-ternary": "allow",
+    "max-params": ["error", 5],
+    "no-await-expression-member": "error",
+    "no-continue": "allow",
+    "guard-for-in": "allow",
+    "func-style": "allow",
+    "sort-imports": "allow",
+    "yoda": "allow",
+    "sort-keys": "allow",
+    "no-magic-numbers": "allow",
+    "no-duplicate-imports": "error",
+    "no-multi-assign": "error",
+    "func-names": "error",
+    "default-param-last": "error",
+    "prefer-object-spread": "error",
+    "no-undefined": "allow",
+    "no-plusplus": "allow",
+    // maybe warn
+    "no-console": "warn",
+    "no-extraneous-class": "allow",
+    "no-empty-function": "error",
+    "max-depth": ["error", 6],
+    "max-lines-per-function": "allow",
+    "no-lonely-if": "error",
+    "max-lines": "allow",
+    "require-await": "allow",
+    "max-nested-callbacks": ["error", 5],
+    "max-classes-per-file": "allow",
+    "radix": "allow",
+    "no-negated-condition": "error",
+    "no-else-return": "error",
+    "no-throw-literal": "error",
+
+    // import
+    "import/exports-last": "allow",
+    "import/max-dependencies": "allow",
+    "import/no-cycle": "error",
+    "import/no-anonymous-default-export": "allow",
+    "import/no-namespace": "error",
+    "import/named": "error",
+    "import/export": "error",
+    "import/no-default-export": "allow",
+    "import/unambiguous": "error",
+
+    // promise
+    "promise/no-return-wrap": "error",
+    "promise/param-names": "error",
+    "promise/prefer-await-to-callbacks": "error",
+    "promise/prefer-await-to-then": "error",
+    "promise/prefer-catch": "error",
+    "promise/no-return-in-finally": "error",
+    "promise/avoid-new": "error",
+
+    // unicorn
+    "unicorn/error-message": "error",
+    "unicorn/no-null": "allow",
+    "unicorn/filename-case": "allow",
+    "unicorn/prefer-structured-clone": "error",
+    "unicorn/prefer-logical-operator-over-ternary": "error",
+    "unicorn/prefer-number-properties": "error",
+    "unicorn/prefer-array-some": "error",
+    "unicorn/prefer-string-slice": "error",
+    // "unicorn/no-null": "error",
+    "unicorn/throw-new-error": "error",
+    "unicorn/catch-error-name": "allow",
+    "unicorn/prefer-spread": "allow",
+    "unicorn/numeric-separators-style": "error",
+    "unicorn/prefer-string-raw": "error",
+    "unicorn/text-encoding-identifier-case": "error",
+    "unicorn/no-array-for-each": "error",
+    "unicorn/explicit-length-check": "error",
+    "unicorn/no-lonely-if": "error",
+    "unicorn/no-useless-undefined": "allow",
+    "unicorn/prefer-date-now": "error",
+    "unicorn/no-static-only-class": "allow",
+    "unicorn/no-typeof-undefined": "error",
+    "unicorn/prefer-negative-index": "error",
+
+    // oxc
+    "oxc/no-map-spread": "error",
+    "oxc/no-rest-spread-properties": "allow",
+    "oxc/no-optional-chaining": "allow",
+    "oxc/no-async-await": "allow",
+
+    // typescript
+    "typescript/explicit-function-return-type": "allow",
+    "typescript/consistent-type-imports": "error",
+    "typescript/consistent-type-definitions": "error",
+    "typescript/consistent-indexed-object-style": "allow",
+    "typescript/no-inferrable-types": "error",
+    "typescript/array-type": "error",
+    "typescript/no-non-null-assertion": "error",
+    "typescript/no-explicit-any": "error",
+    "typescript/no-import-type-side-effects": "error",
+    "typescript/no-dynamic-delete": "error",
+    "typescript/prefer-ts-expect-error": "error",
+    "typescript/ban-ts-comment": "error",
+    "typescript/prefer-enum-initializers": "error",
+
+    // jsdoc
+    "jsdoc/require-returns": "allow",
+    "jsdoc/require-param": "allow"
+  },
+  "ignorePatterns": ["index.d.ts", "test/fixtures/**"]
+}

.github/workflows/nodejs.yml

@@ -1,23 +1,26 @@
-# egg-mysql
+# @eggjs/mysql
 
 [![NPM version][npm-image]][npm-url]
-[![Node.js CI](https://github.com/eggjs/egg-mysql/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-mysql/actions/workflows/nodejs.yml)
+[![CI](https://github.com/eggjs/mysql/actions/workflows/nodejs.yml/badge.svg?branch=master)](https://github.com/eggjs/mysql/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/mysql.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/mysql)
 
-[npm-image]: https://img.shields.io/npm/v/egg-mysql.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-mysql
-[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-mysql.svg?style=flat-square
-[codecov-url]: https://codecov.io/github/eggjs/egg-mysql?branch=master
-[download-image]: https://img.shields.io/npm/dm/egg-mysql.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-mysql
+[npm-image]: https://img.shields.io/npm/v/@eggjs/mysql.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/mysql
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/mysql.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs/mysql?branch=master
+[download-image]: https://img.shields.io/npm/dm/@eggjs/mysql.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/mysql
 
-Aliyun rds client(support mysql protocol) for egg framework
+MySQL plugin for Egg.js
 
 ## Install
 
 ```bash
-npm i egg-mysql --save
+npm i @eggjs/mysql
 ```
 
 MySQL Plugin for egg, support egg application access to MySQL database.
@@ -32,7 +35,7 @@ Change `${app_root}/config/plugin.ts` to enable MySQL plugin:
 export default {
   mysql: {
     enable: true,
-    package: 'egg-mysql',
+    package: '@eggjs/mysql',
   },
 }
 ```
@@ -57,9 +60,9 @@ export default {
       // database
       database: 'test',
     },
-    // load into app, default is open
+    // load into app, default is `true`
     app: true,
-    // load into agent, default is close
+    // load into agent, default is `false`
     agent: false,
   },
 }
@@ -107,10 +110,10 @@ export default {
 Usage:
 
 ```ts
-const client1 = app.mysqls.get('db1');
+const client1 = app.mysqls.getSingletonInstance('db1');
 await client1.query(sql, values);
 
-const client2 = app.mysqls.get('db2');
+const client2 = app.mysqls.getSingletonInstance('db2');
 await client2.query(sql, values);
 ```
 
@@ -239,17 +242,38 @@ await app.mysql.insert(table, {
 // INSERT INTO `$table`(`id`, `fullname`) VALUES(123, CONCAT("James", "Bond"))
 ```
 
+## For the local dev
+
+Run docker compose to start test mysql service
+
+```bash
+docker compose -f docker-compose.yml up -d
+# if you run the first time, should wait for ~20s to let mysql service init started
+```
+
+Run the unit tests
+
+```bash
+npm test
+```
+
+Stop test mysql service
+
+```bash
+docker compose -f docker-compose.yml down
+```
+
 ## Questions & Suggestions
 
-Please open an issue [here](https://github.com/eggjs/egg/issues).
+Please open an issue [here](https://github.com/eggjs/mysql/issues).
 
 ## License
 
 [MIT](LICENSE)
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/core)](https://github.com/eggjs/core/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/mysql)](https://github.com/eggjs/mysql/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).
 

.oxlintrc.json

@@ -1,16 +1,19 @@
-# egg-mysql
+# @eggjs/mysql
 
 [![NPM version][npm-image]][npm-url]
-[![Node.js CI](https://github.com/eggjs/egg-mysql/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-mysql/actions/workflows/nodejs.yml)
+[![CI](https://github.com/eggjs/mysql/actions/workflows/nodejs.yml/badge.svg?branch=master)](https://github.com/eggjs/mysql/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/mysql.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/mysql)
 
-[npm-image]: https://img.shields.io/npm/v/egg-mysql.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-mysql
-[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-mysql.svg?style=flat-square
-[codecov-url]: https://codecov.io/github/eggjs/egg-mysql?branch=master
-[download-image]: https://img.shields.io/npm/dm/egg-mysql.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-mysql
+[npm-image]: https://img.shields.io/npm/v/@eggjs/mysql.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/mysql
+[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/mysql.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/eggjs/mysql?branch=master
+[download-image]: https://img.shields.io/npm/dm/@eggjs/mysql.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/mysql
 
 MySQL 插件是为 egg 提供 MySQL 数据库访问的功能
 
@@ -19,7 +22,7 @@ MySQL 插件是为 egg 提供 MySQL 数据库访问的功能
 ## 安装
 
 ```bash
-npm i egg-mysql --save
+npm i @eggjs/mysql
 ```
 
 ## 配置
@@ -30,7 +33,7 @@ npm i egg-mysql --save
 export default {
   mysql: {
     enable: true,
-    package: 'egg-mysql',
+    package: '@eggjs/mysql',
   },
 }
 ```
@@ -119,22 +122,22 @@ await client2.query(sql, values);
 
 #### app.mysql
 
-如果开启了 `config.mysql.app = true`，则会在 app 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
+如果开启了 `config.mysql.app = true`，则会在 app 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/core/blob/master/src/singleton.ts)。
 
 ```ts
 await app.mysql.query(sql);
-await app.mysqls.get('db1').query(sql);
+await app.mysqls.getSingletonInstance('db1').query(sql);
 ```
 
 ### Agent
 
 #### agent.mysql
 
-如果开启了 `config.mysql.agent = true`，则会在 agent 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/egg/blob/master/lib/core/singleton.js)。
+如果开启了 `config.mysql.agent = true`，则会在 agent 上注入 [@eggjs/rds] 客户端 的 [Singleton 单例](https://github.com/eggjs/core/blob/master/src/singleton.ts)。
 
 ```ts
 await agent.mysql.query(sql);
-await agent.mysqls.get('db1').query(sql);
+await agent.mysqls.getSingletonInstance('db1').query(sql);
 ```
 
 ## CRUD 使用指南
@@ -236,7 +239,7 @@ const results = await app.mysql.query('update posts set hits = (hits + ?) where
 
 #### 内置表达式
 
-- NOW(): 数据库当前系统时间，通过`app.mysql.literals.now`获取。
+- `NOW()`: 数据库当前系统时间，通过 `app.mysql.literals.now` 获取。
 
 ```ts
 await app.mysql.insert(table, {
@@ -248,7 +251,7 @@ await app.mysql.insert(table, {
 
 #### 自定义表达式
 
-下例展示了如何调用mysql内置的`CONCAT(s1, ...sn)`函数，做字符串拼接。
+下例展示了如何调用mysql内置的 `CONCAT(s1, ...sn)` 函数，做字符串拼接。
 
 ```ts
 const Literal = app.mysql.literals.Literal;
@@ -264,15 +267,15 @@ await app.mysql.insert(table, {
 
 ## Questions & Suggestions
 
-Please open an issue [here](https://github.com/eggjs/egg/issues).
+Please open an issue [here](https://github.com/eggjs/mysql/issues).
 
 ## License
 
 [MIT](LICENSE)
 
 ## Contributors
 
-[![Contributors](https://contrib.rocks/image?repo=eggjs/core)](https://github.com/eggjs/core/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=eggjs/mysql)](https://github.com/eggjs/mysql/graphs/contributors)
 
 Made with [contributors-img](https://contrib.rocks).