@breadc/death 0.9.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 XLor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# @breadc/death
+
+[![version](https://img.shields.io/npm/v/@breadc/death&label=@breadc/death)](https://www.npmjs.com/package/@breadc/death) [![CI](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml/badge.svg)](https://github.com/yjl9903/Breadc/actions/workflows/ci.yml)
+
+Easily register termination signals callbacks.
+
+It will listen `SIGINT`, `SIGTERM`, `SIGQUIT` these three signals. When receive any one of them, it will invoke all the callbacks **in the reverse order** (it also **await the asynchronous callbacks**), and finally send the original signal again.
+
+> In [Signal events](https://nodejs.org/dist/latest-v20.x/docs/api/process.html#signal-events), it says that `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that reset the terminal mode before exiting with code 128 + signal number. **If one of these signals has a listener installed, its default behavior will be removed (Node.js will no longer exit).**
+
+## Installation
+
+```bash
+npm i @breadc/death
+```
+
+## Usage
+
+```ts
+import { onDeath } from '@breadc/death'
+
+onDeath((signal) => {
+  console.log(`Receive signal: ${signal}`);
+  console.log('Process is being killed');
+})
+```
+
+You can also use `process.exit` instead of `process.kill`, or disable terminating the current process, which is the default behavior of this package. Note that **the context object is shared between different callbacks**.
+
+```ts
+onDeath((signal, context) => {
+  // Use process.exit(1)
+  context.terminate = 'exit'
+  context.exit = 1
+})
+```
+
+```ts
+onDeath((signal, context) => {
+  // Disable terminate
+  context.terminate = false
+})
+```
+
+## License
+
+MIT License © 2023 [XLor](https://github.com/yjl9903)

package/dist/index.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+const node_events = require('node:events');
+
+const emitter = new node_events.EventEmitter();
+const handlers = {
+  SIGINT: makeHandler(),
+  SIGTERM: makeHandler(),
+  SIGQUIT: makeHandler()
+};
+function onDeath(callback, { SIGINT = true, SIGTERM = true, SIGQUIT = true } = {}) {
+  const cleanUps = [];
+  if (SIGINT) {
+    registerCallback("SIGINT", handlers.SIGINT);
+    emitter.addListener("SIGINT", callback);
+    cleanUps.push(() => emitter.removeListener("SIGINT", callback));
+  }
+  if (SIGTERM) {
+    registerCallback("SIGTERM", handlers.SIGTERM);
+    emitter.addListener("SIGTERM", callback);
+    cleanUps.push(() => emitter.removeListener("SIGTERM", callback));
+  }
+  if (SIGQUIT) {
+    registerCallback("SIGQUIT", handlers.SIGQUIT);
+    emitter.addListener("SIGQUIT", callback);
+    cleanUps.push(() => emitter.removeListener("SIGQUIT", callback));
+  }
+  return () => {
+    for (const cleanUp of cleanUps) {
+      cleanUp();
+    }
+  };
+}
+function registerCallback(signal, callback) {
+  process.on(signal, callback);
+  return () => {
+    process.off(signal, callback);
+  };
+}
+function makeHandler(signal) {
+  return async (signal2) => {
+    const listeners = emitter.listeners(signal2);
+    const context = {
+      terminate: "kill",
+      exit: void 0,
+      kill: signal2
+    };
+    for (const listener of listeners.reverse()) {
+      await listener(signal2, context);
+    }
+    if (context.terminate === "kill" || context.terminate === "exit") {
+      process.removeListener("SIGINT", handlers.SIGINT);
+      process.removeListener("SIGTERM", handlers.SIGTERM);
+      process.removeListener("SIGQUIT", handlers.SIGQUIT);
+      if (context.terminate === "kill") {
+        process.kill(process.pid, context.kill);
+      } else {
+        process.exit(context.exit);
+      }
+    }
+  };
+}
+
+exports.onDeath = onDeath;

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+type DeathSignals = 'SIGINT' | 'SIGTERM' | 'SIGQUIT';
+interface OnDeathContext {
+    terminate: 'exit' | 'kill' | false;
+    exit: number | undefined;
+    kill: NodeJS.Signals | undefined;
+}
+type OnDeathCallback = (signal: DeathSignals, context: OnDeathContext) => unknown | Promise<unknown>;
+interface OnDeathOptions {
+    SIGINT?: boolean;
+    SIGTERM?: boolean;
+    SIGQUIT?: boolean;
+}
+declare function onDeath(callback: OnDeathCallback, { SIGINT, SIGTERM, SIGQUIT }?: OnDeathOptions): () => void;
+
+export { DeathSignals, OnDeathCallback, OnDeathContext, OnDeathOptions, onDeath };

package/dist/index.mjs

@@ -0,0 +1,62 @@
+import { EventEmitter } from 'node:events';
+
+const emitter = new EventEmitter();
+const handlers = {
+  SIGINT: makeHandler(),
+  SIGTERM: makeHandler(),
+  SIGQUIT: makeHandler()
+};
+function onDeath(callback, { SIGINT = true, SIGTERM = true, SIGQUIT = true } = {}) {
+  const cleanUps = [];
+  if (SIGINT) {
+    registerCallback("SIGINT", handlers.SIGINT);
+    emitter.addListener("SIGINT", callback);
+    cleanUps.push(() => emitter.removeListener("SIGINT", callback));
+  }
+  if (SIGTERM) {
+    registerCallback("SIGTERM", handlers.SIGTERM);
+    emitter.addListener("SIGTERM", callback);
+    cleanUps.push(() => emitter.removeListener("SIGTERM", callback));
+  }
+  if (SIGQUIT) {
+    registerCallback("SIGQUIT", handlers.SIGQUIT);
+    emitter.addListener("SIGQUIT", callback);
+    cleanUps.push(() => emitter.removeListener("SIGQUIT", callback));
+  }
+  return () => {
+    for (const cleanUp of cleanUps) {
+      cleanUp();
+    }
+  };
+}
+function registerCallback(signal, callback) {
+  process.on(signal, callback);
+  return () => {
+    process.off(signal, callback);
+  };
+}
+function makeHandler(signal) {
+  return async (signal2) => {
+    const listeners = emitter.listeners(signal2);
+    const context = {
+      terminate: "kill",
+      exit: void 0,
+      kill: signal2
+    };
+    for (const listener of listeners.reverse()) {
+      await listener(signal2, context);
+    }
+    if (context.terminate === "kill" || context.terminate === "exit") {
+      process.removeListener("SIGINT", handlers.SIGINT);
+      process.removeListener("SIGTERM", handlers.SIGTERM);
+      process.removeListener("SIGQUIT", handlers.SIGQUIT);
+      if (context.terminate === "kill") {
+        process.kill(process.pid, context.kill);
+      } else {
+        process.exit(context.exit);
+      }
+    }
+  };
+}
+
+export { onDeath };

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@breadc/death",
+  "version": "0.9.4",
+  "description": "Easily register termination signals callbacks.",
+  "keywords": [
+    "breadc",
+    "death",
+    "terminal",
+    "signal",
+    "cli",
+    "command-line"
+  ],
+  "homepage": "https://github.com/yjl9903/Breadc/tree/main/packages/death#readme",
+  "bugs": {
+    "url": "https://github.com/yjl9903/Breadc/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yjl9903/Breadc.git",
+    "directory": "packages/death"
+  },
+  "license": "MIT",
+  "author": "XLor",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.16.7",
+    "vitest": "^0.31.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "format": "prettier --write src/**/*.ts test/*.ts",
+    "test": "vitest",
+    "test:ci": "vitest --run",
+    "typecheck": "tsc --noEmit"
+  }
+}