feat: support cjs and esm both by tshy

BREAKING CHANGE: drop Node.js < 18.19.0 support part of eggjs/egg#3644
eggjs · Jun 23, 2024 · f97666d · f97666d
1 parent 2d22d6d
commit f97666d
Show file tree

Hide file tree

Showing 26 changed files with 646 additions and 811 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -1,6 +1,6 @@
 {
-  "extends": "eslint-config-egg",
-  "parserOptions": {
-    "ecmaVersion": 2017
-  }
+  "extends": [
+    "eslint-config-egg/typescript",
+    "eslint-config-egg/lib/rules/enforce-node-prefix"
+  ]
 }
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -3,7 +3,6 @@ name: CI
 on:
   push:
     branches: [ master ]
-
   pull_request:
     branches: [ master ]
 
@@ -13,4 +12,6 @@ jobs:
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest'
-      version: '10, 12, 14, 16, 18, 20'
+      version: '18.19.0, 20, 22'
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ node_modules
 coverage
 test/ts/report
 package-lock.json
+.eslintcache
diff --git a/README.md b/README.md
@@ -1,27 +1,28 @@
-# egg-cookies
+# @eggjs/cookies
 
 [![NPM version][npm-image]][npm-url]
 [![build status][ci-image]][ci-url]
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
 
-[npm-image]: https://img.shields.io/npm/v/egg-cookies.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-cookies
+[npm-image]: https://img.shields.io/npm/v/@eggjs/cookies.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/cookies
 [ci-image]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml/badge.svg
 [ci-url]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml
 [codecov-image]: https://codecov.io/gh/eggjs/egg-cookies/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/eggjs/egg-cookies
-[download-image]: https://img.shields.io/npm/dm/egg-cookies.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-cookies
+[download-image]: https://img.shields.io/npm/dm/@eggjs/cookies.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/cookies
 
 Extends [pillarjs/cookies](https://github.com/pillarjs/cookies) to adapt koa and egg with some additional features.
 
 ## Encrypt
 
-egg-cookies provide an alternative `encrypt` mode like `signed`. An encrypt cookie's value will be encrypted base on keys. Anyone who don't have the keys are unable to know the original cookie's value.
+`@eggjs/cookies` provide an alternative `encrypt` mode like `signed`. An encrypt cookie's value will be encrypted base on keys. Anyone who don't have the keys are unable to know the original cookie's value.
+
+```ts
+import { Cookies } from '@eggjs/cookies';
 
-```js
-const Cookies = require('egg-cookies');
 const cookies = new Cookies(ctx, keys[, defaultCookieOptions]);
 
 cookies.set('foo', 'bar', { encrypt: true });
@@ -32,13 +33,14 @@ cookies.get('foo', { encrypt: true });
 
 ## Cookie Length Check
 
-[Browsers all had some limitation in cookie's length](http://browsercookielimits.squawky.net/), so if set a cookie with an extremely long value(> 4093), egg-cookies will emit an `cookieLimitExceed` event. You can listen to this event and record.
+[Browsers all had some limitation in cookie's length](http://browsercookielimits.squawky.net/), so if set a cookie with an extremely long value(> 4093), `@eggjs/cookies` will emit an `cookieLimitExceed` event. You can listen to this event and record.
+
+```ts
+import { Cookies } from '@eggjs/cookies';
 
-```js
-const Cookies = require('egg-cookies');
 const cookies = new Cookies(ctx, keys);
 
-cookies.on('cookieLimitExceed', { name, value } => {
+cookies.on('cookieLimitExceed', ({ name, value }) => {
   // log
 });
 
@@ -48,15 +50,9 @@ cookies.set('foo', longText);
 ## License
 
 [MIT](LICENSE)
-<!-- GITCONTRIBUTOR_START -->
 
 ## Contributors
 
-|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/5856440?v=4" width="100px;"/><br/><sub><b>whxaxes</b></sub>](https://github.com/whxaxes)<br/>|[<img src="https://avatars.githubusercontent.com/u/5102113?v=4" width="100px;"/><br/><sub><b>xyeric</b></sub>](https://github.com/xyeric)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-|[<img src="https://avatars.githubusercontent.com/u/3939959?v=4" width="100px;"/><br/><sub><b>jedmeng</b></sub>](https://github.com/jedmeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/17005098?v=4" width="100px;"/><br/><sub><b>Junyan</b></sub>](https://github.com/Junyan)<br/>|[<img src="https://avatars.githubusercontent.com/u/12657964?v=4" width="100px;"/><br/><sub><b>beliefgp</b></sub>](https://github.com/beliefgp)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/22520131?v=4" width="100px;"/><br/><sub><b>tang-xy</b></sub>](https://github.com/tang-xy)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/1276859?v=4" width="100px;"/><br/><sub><b>ziyunfei</b></sub>](https://github.com/ziyunfei)<br/>|[<img src="https://avatars.githubusercontent.com/u/12656301?v=4" width="100px;"/><br/><sub><b>brizer</b></sub>](https://github.com/brizer)<br/>|[<img src="https://avatars.githubusercontent.com/u/7692708?v=4" width="100px;"/><br/><sub><b>xuezier</b></sub>](https://github.com/xuezier)<br/>|[<img src="https://avatars.githubusercontent.com/u/16103358?v=4" width="100px;"/><br/><sub><b>onlylovermb</b></sub>](https://github.com/onlylovermb)<br/>
-
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Feb 19 2024 17:41:40 GMT+0800`.
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-cookies)](https://github.com/eggjs/egg-cookies/graphs/contributors)
 
-<!-- GITCONTRIBUTOR_END -->
+Made with [contributors-img](https://contrib.rocks).
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -1,23 +1,24 @@
-# egg-cookies
+# @eggjs/cookies
 
 [![NPM version][npm-image]][npm-url]
 [![build status][ci-image]][ci-url]
 [![Test coverage][codecov-image]][codecov-url]
 [![npm download][download-image]][download-url]
 
-[npm-image]: https://img.shields.io/npm/v/egg-cookies.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/egg-cookies
+[npm-image]: https://img.shields.io/npm/v/@eggjs/cookies.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/cookies
 [ci-image]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml/badge.svg
 [ci-url]: https://github.com/eggjs/egg-cookies/actions/workflows/nodejs.yml
 [codecov-image]: https://codecov.io/gh/eggjs/egg-cookies/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/eggjs/egg-cookies
-[download-image]: https://img.shields.io/npm/dm/egg-cookies.svg?style=flat-square
-[download-url]: https://npmjs.org/package/egg-cookies
+[download-image]: https://img.shields.io/npm/dm/@eggjs/cookies.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/cookies
 
 为 egg 提供 cookie 操作的封装。
 
-```js
+```ts
 ctx.cookies = new Cookies(ctx, keys[, defaultCookieOptions]);
+
 ctx.cookies.get('key', 'value', options);
 ctx.cookies.set('key', 'value', options);
 ```
@@ -68,15 +69,8 @@ ctx.cookies.set('key', 'value', options);
 
 [MIT](LICENSE)
 
-<!-- GITCONTRIBUTOR_START -->
-
-## 贡献者
-
-|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/227713?v=4" width="100px;"/><br/><sub><b>atian25</b></sub>](https://github.com/atian25)<br/>|[<img src="https://avatars.githubusercontent.com/u/5856440?v=4" width="100px;"/><br/><sub><b>whxaxes</b></sub>](https://github.com/whxaxes)<br/>|[<img src="https://avatars.githubusercontent.com/u/5102113?v=4" width="100px;"/><br/><sub><b>xyeric</b></sub>](https://github.com/xyeric)<br/>|
-| :---: | :---: | :---: | :---: | :---: | :---: |
-|[<img src="https://avatars.githubusercontent.com/u/3939959?v=4" width="100px;"/><br/><sub><b>jedmeng</b></sub>](https://github.com/jedmeng)<br/>|[<img src="https://avatars.githubusercontent.com/u/17005098?v=4" width="100px;"/><br/><sub><b>Junyan</b></sub>](https://github.com/Junyan)<br/>|[<img src="https://avatars.githubusercontent.com/u/12657964?v=4" width="100px;"/><br/><sub><b>beliefgp</b></sub>](https://github.com/beliefgp)<br/>|[<img src="https://avatars.githubusercontent.com/u/52845048?v=4" width="100px;"/><br/><sub><b>snapre</b></sub>](https://github.com/snapre)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/22520131?v=4" width="100px;"/><br/><sub><b>tang-xy</b></sub>](https://github.com/tang-xy)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/1276859?v=4" width="100px;"/><br/><sub><b>ziyunfei</b></sub>](https://github.com/ziyunfei)<br/>|[<img src="https://avatars.githubusercontent.com/u/12656301?v=4" width="100px;"/><br/><sub><b>brizer</b></sub>](https://github.com/brizer)<br/>|[<img src="https://avatars.githubusercontent.com/u/7692708?v=4" width="100px;"/><br/><sub><b>xuezier</b></sub>](https://github.com/xuezier)<br/>|[<img src="https://avatars.githubusercontent.com/u/16103358?v=4" width="100px;"/><br/><sub><b>onlylovermb</b></sub>](https://github.com/onlylovermb)<br/>
+## Contributors
 
-[git-contributor 说明](https://github.com/xudafeng/git-contributor)，自动生成时间：`Mon Feb 19 2024 17:41:40 GMT+0800`。
+[![Contributors](https://contrib.rocks/image?repo=eggjs/egg-cookies)](https://github.com/eggjs/egg-cookies/graphs/contributors)
 
-<!-- GITCONTRIBUTOR_END -->
+Made with [contributors-img](https://contrib.rocks).
diff --git a/index.d.ts b/index.d.ts