feat: support cjs and esm both by tshy (#120)

BREAKING CHANGE: drop Node.js < 18.19.0 support

part of eggjs/egg#3644

eggjs/egg#5257

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Release Notes

- **New Features**
- Introduced a new GitHub Actions workflow for automated package
publishing.
- Added TypeScript configuration to enhance type safety and modern
JavaScript compatibility.
	- New tests for child process management functionality.

- **Updates**
	- Updated ESLint configuration to utilize external presets.
	- Modified GitHub Actions CI to specify a more precise Node.js version.
- Enhanced README with installation and usage examples for ESM and
TypeScript.
- Updated package.json to reflect new module structure and dependencies.
- Improved .gitignore to exclude additional temporary files and
directories.

- **Bug Fixes**
- Improved .gitignore to exclude additional temporary files and
directories.

- **Removals**
- Removed outdated JavaScript files and configurations in favor of
CommonJS and TypeScript standards.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: fengmk2

.eslintrc

@@ -1,198 +1,6 @@
 {
-  "ecmaFeatures": {
-    "jsx": true
-  },
-  "parser": "espree",
-  "env": {
-    "amd": false,
-    "jasmine": false,
-    "node": true,
-    "mocha": true,
-    "browser": true,
-    "builtin": true,
-    "es6": true
-  },
-  "rules": {
-    "no-alert": 2,
-    "no-array-constructor": 2,
-    "no-bitwise": 2,
-    "no-caller": 2,
-    "no-catch-shadow": 2,
-    "no-comma-dangle": 0,
-    "no-cond-assign": [2, "except-parens"],
-    "no-constant-condition": 2,
-    "no-continue": 0,
-    "no-control-regex": 2,
-    "no-debugger": 2,
-    "no-delete-var": 2,
-    "no-div-regex": 0,
-    "no-dupe-keys": 2,
-    "no-dupe-args": 2,
-    "no-duplicate-case": 2,
-    "no-else-return": 0,
-    "no-empty": 2,
-    "no-empty-class": 0,
-    "no-empty-character-class": 2,
-    "no-eq-null": 0,
-    "no-eval": 2,
-    "no-ex-assign": 2,
-    "no-extend-native": 2,
-    "no-extra-bind": 2,
-    "no-extra-boolean-cast": 2,
-    "no-extra-parens": 0,
-    "no-extra-semi": 2,
-    "no-fallthrough": 2,
-    "no-floating-decimal": 0,
-    "no-func-assign": 2,
-    "no-implied-eval": 2,
-    "no-inline-comments": 0,
-    "no-inner-declarations": [2, "functions"],
-    "no-invalid-regexp": 2,
-    "no-irregular-whitespace": 2,
-    "no-iterator": 0,
-    "no-label-var": 2,
-    "no-labels": 2,
-    "no-lone-blocks": 2,
-    "no-lonely-if": 0,
-    "no-loop-func": 2,
-    "no-mixed-requires": [0, false],
-    "no-mixed-spaces-and-tabs": [2, false],
-    "linebreak-style": [0, "unix"],
-    "no-multi-spaces": 2,
-    "no-multi-str": 2,
-    "no-multiple-empty-lines": [0, {
-      "max": 2
-    }],
-    "no-native-reassign": 2,
-    "no-negated-in-lhs": 2,
-    "no-nested-ternary": 0,
-    "no-new": 0,
-    "no-new-func": 2,
-    "no-new-object": 2,
-    "no-new-require": 0,
-    "no-new-wrappers": 2,
-    "no-obj-calls": 2,
-    "no-octal": 2,
-    "no-octal-escape": 2,
-    "no-param-reassign": 0,
-    "no-path-concat": 0,
-    "no-plusplus": 0,
-    "no-process-env": 0,
-    "no-process-exit": 0,
-    "no-proto": 2,
-    "no-redeclare": 0,
-    "no-regex-spaces": 2,
-    "no-reserved-keys": 0,
-    "no-restricted-modules": 0,
-    "no-return-assign": 0,
-    "no-script-url": 2,
-    "no-self-compare": 0,
-    "no-sequences": 2,
-    "no-shadow": 0,
-    "no-shadow-restricted-names": 2,
-    "no-space-before-semi": 0,
-    "no-spaced-func": 2,
-    "no-sparse-arrays": 2,
-    "no-sync": 0,
-    "no-ternary": 0,
-    "no-trailing-spaces": 2,
-    "no-this-before-super": 0,
-    "no-throw-literal": 0,
-    "no-undef": 2,
-    "no-undef-init": 2,
-    "no-undefined": 0,
-    "no-unexpected-multiline": 0,
-    "no-underscore-dangle": 0,
-    "no-unneeded-ternary": 0,
-    "no-unreachable": 2,
-    "no-unused-expressions": 0,
-    "no-unused-vars": 2,
-    "no-use-before-define": [2, "nofunc"],
-    "no-void": 0,
-    "no-var": 0,
-    "prefer-const": 0,
-    "no-warning-comments": [0, {
-      "terms": ["todo", "fixme", "xxx"],
-      "location": "start"
-    }],
-    "no-with": 2,
-    "array-bracket-spacing": [0, "never"],
-    "accessor-pairs": 0,
-    "block-scoped-var": 0,
-    "brace-style": [0, "1tbs"],
-    "camelcase": 0,
-    "comma-dangle": 0,
-    "comma-spacing": 2,
-    "comma-style": 0,
-    "complexity": [0, 11],
-    "computed-property-spacing": [0, "never"],
-    "consistent-return": 0,
-    "consistent-this": [0, "that"],
-    "constructor-super": 0,
-    "curly": [2, "all"],
-    "default-case": 0,
-    "dot-location": 0,
-    "dot-notation": 0,
-    "eol-last": 2,
-    "eqeqeq": 2,
-    "func-names": 0,
-    "func-style": [0, "declaration"],
-    "generator-star": 0,
-    "generator-star-spacing": 0,
-    "global-strict": [0, "never"],
-    "guard-for-in": 0,
-    "handle-callback-err": 0,
-    "indent": [2, 2],
-    "key-spacing": [2, {
-      "beforeColon": false,
-      "afterColon": true
-    }],
-    "keyword-spacing": 2,
-    "lines-around-comment": 0,
-    "max-depth": [0, 4],
-    "max-len": [0, 80, 4],
-    "max-nested-callbacks": [0, 2],
-    "max-params": [0, 3],
-    "max-statements": [0, 10],
-    "new-cap": 0,
-    "new-parens": 2,
-    "newline-after-var": 0,
-    "object-curly-spacing": [0, "never"],
-    "object-shorthand": 0,
-    "one-var": 0,
-    "operator-assignment": [0, "always"],
-    "operator-linebreak": 0,
-    "padded-blocks": 0,
-    "quote-props": 0,
-    "quotes": [2, "single"],
-    "radix": 0,
-    "semi": 2,
-    "semi-spacing": [2, {
-      "before": false,
-      "after": true
-    }],
-    "sort-vars": 0,
-    "space-after-function-name": [0, "never"],
-    "space-after-keywords": [0, "always"],
-    "space-before-blocks": [0, "always"],
-    "space-before-function-paren": [0, "always"],
-    "space-before-function-parentheses": [0, "always"],
-    "space-in-brackets": [0, "never"],
-    "space-in-parens": [0, "never"],
-    "space-infix-ops": 2,
-    "space-unary-ops": [2, {
-      "words": true,
-      "nonwords": false
-    }],
-    "spaced-comment": 0,
-    "spaced-line-comment": [0, "always"],
-    "strict": [2, "global"],
-    "use-isnan": 2,
-    "valid-jsdoc": 0,
-    "valid-typeof": 0,
-    "vars-on-top": 0,
-    "wrap-iife": 0,
-    "wrap-regex": 0,
-    "yoda": [2, "never"]
-  }
+  "extends": [
+    "eslint-config-egg/typescript",
+    "eslint-config-egg/lib/rules/enforce-node-prefix"
+  ]
 }

.github/workflows/nodejs.yml

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

.github/workflows/pkg.pr.new.yml

@@ -0,0 +1,23 @@
+name: Publish Any Commit
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - run: corepack enable
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run prepublishOnly --if-present
+
+      - run: npx pkg-pr-new publish

.gitignore

@@ -13,5 +13,8 @@ results
 
 node_modules
 npm-debug.log
-coverage/
 package-lock.json
+.tshy*
+.eslintcache
+dist
+coverage

README.md

@@ -4,6 +4,7 @@
 [![Node.js CI](https://github.com/node-modules/cfork/actions/workflows/nodejs.yml/badge.svg)](https://github.com/node-modules/cfork/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/cfork.svg?style=flat)](https://nodejs.org/en/download/)
 
 [npm-image]: https://img.shields.io/npm/v/cfork.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/cfork
@@ -21,16 +22,16 @@ cluster fork and restart easy way.
 ## Install
 
 ```bash
-$ npm install cfork --save
+npm install cfork
 ```
 
 ## Usage
 
-### Example
+### ESM and TypeScript
 
-```js
-const cfork = require('cfork');
-const util = require('util');
+```ts
+import util from 'node:util';
+import { cfork } from 'cfork';
 
 const clusterWorker = cfork({
   exec: '/your/app/worker.js',
@@ -68,37 +69,34 @@ process.on('uncaughtException', err => {
 
 // if you want to dynamically disable refork, you can call the setDisableRefork, priority over the refork parameter
 cfork.setDisableRefork(clusterWorker, true);
+```
 
+### CommonJS
 
+```js
+const { cfork } = require('cfork');
 ```
 
 ### Options
 
-- **exec** : exec file path
-- **slaves** : slave process config
-- **args** : exec arguments
-- **count** : fork worker nums, default is `os.cpus().length`
-- **refork** : refork when worker disconnect or unexpected exit, default is `true`
-- **limit**: limit refork times within the `duration`, default is `60`
-- **duration**: default is `60000`, one minute (so, the `refork times` < `limit / duration`)
-- **autoCoverage**: auto fork with istanbul when `running_under_istanbul` env set, default is `false`
-- **env**: attach some environment variable key-value pairs to the worker / slave process, default to an empty object.
-- **windowsHide**: Hide the forked processes console window that would normally be created on Windows systems, default to false.
-- **serialization**: Specify the kind of serialization used for sending messages between processes. Possible values are 'json' and 'advanced'. See Advanced serialization for child_process for more details. Default: false.
+* **exec** : exec file path
+* **slaves** : slave process config
+* **args** : exec arguments
+* **count** : fork worker nums, default is `os.cpus().length`
+* **refork** : refork when worker disconnect or unexpected exit, default is `true`
+* **limit**: limit refork times within the `duration`, default is `60`
+* **duration**: default is `60000`, one minute (so, the `refork times` < `limit / duration`)
+* **autoCoverage**: auto fork with istanbul when `running_under_istanbul` env set, default is `false`
+* **env**: attach some environment variable key-value pairs to the worker / slave process, default to an empty object.
+* **windowsHide**: Hide the forked processes console window that would normally be created on Windows systems, default to false.
+* **serialization**: Specify the kind of serialization used for sending messages between processes. Possible values are 'json' and 'advanced'. See Advanced serialization for child_process for more details. Default: false.
 
 ## 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/14790466?v=4" width="100px;"/><br/><sub><b>greenkeeperio-bot</b></sub>](https://github.com/greenkeeperio-bot)<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/327019?v=4" width="100px;"/><br/><sub><b>JacksonTian</b></sub>](https://github.com/JacksonTian)<br/>|[<img src="https://avatars.githubusercontent.com/u/1474688?v=4" width="100px;"/><br/><sub><b>luckydrq</b></sub>](https://github.com/luckydrq)<br/>|[<img src="https://avatars.githubusercontent.com/u/2842176?v=4" width="100px;"/><br/><sub><b>XadillaX</b></sub>](https://github.com/XadillaX)<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/18315?v=4" width="100px;"/><br/><sub><b>hemanth</b></sub>](https://github.com/hemanth)<br/>|[<img src="https://avatars.githubusercontent.com/u/3230673?v=4" width="100px;"/><br/><sub><b>qingdengyue</b></sub>](https://github.com/qingdengyue)<br/>|[<img src="https://avatars.githubusercontent.com/u/1422472?v=4" width="100px;"/><br/><sub><b>jpuncle</b></sub>](https://github.com/jpuncle)<br/>|[<img src="https://avatars.githubusercontent.com/u/1102038?v=4" width="100px;"/><br/><sub><b>hustxiaoc</b></sub>](https://github.com/hustxiaoc)<br/>|[<img src="https://avatars.githubusercontent.com/u/2972143?v=4" width="100px;"/><br/><sub><b>nightink</b></sub>](https://github.com/nightink)<br/>|
-[<img src="https://avatars.githubusercontent.com/u/7971415?v=4" width="100px;"/><br/><sub><b>paranoidjk</b></sub>](https://github.com/paranoidjk)<br/>|[<img src="https://avatars.githubusercontent.com/u/19849579?v=4" width="100px;"/><br/><sub><b>sinkhaha</b></sub>](https://github.com/sinkhaha)<br/>
-
-This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Sat May 06 2023 00:30:47 GMT+0800`.
+[![Contributors](https://contrib.rocks/image?repo=node-modules/cfork)](https://github.com/node-modules/cfork/graphs/contributors)
 
-<!-- GITCONTRIBUTOR_END -->
+Made with [contributors-img](https://contrib.rocks).