v1.1.0

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -1,125 +0,0 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- security
-- test
-- release
-- metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  image: docker:stable
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

changelog.md

@@ -0,0 +1,64 @@
+# Changelog
+
+## 2025-12-15 - 1.1.0 - feat(smartexit)
+Add silent logging option, structured shutdown logs, and killAll return stats
+
+- Introduce ISmartExitOptions with a silent flag to disable console logging
+- Add internal log() helper and use a [smartexit] prefix for shutdown/error messages
+- killAll() now returns Promise<{ processesKilled, cleanupFunctionsRan }> and tallies processes and cleanup functions run
+- Constructor accepts options (backwards compatible) to configure behavior
+- Documentation (readme.hints.md) updated with usage and example output
+
+## 2025-12-15 - 1.0.24 - fix(deps)
+bump dependencies, update tests and docs, adjust tsconfig and npm release config
+
+- Upgrade devDependencies: @git.zone/tsbuild -> ^4.0.2, @git.zone/tsrun -> ^2.0.1, @git.zone/tstest -> ^3.1.3, @types/node -> ^24.0.3 (removed @push.rocks/tapbundle)
+- Bump runtime deps: @push.rocks/lik -> ^6.2.2, @push.rocks/smartpromise -> ^4.2.3
+- Switch test imports to @git.zone/tstest/tapbundle and export default tap.start()
+- Revise README: expanded documentation, new install instructions (pnpm), issue reporting guidance, examples (Express, killTreeByPid), and wording/formatting improvements
+- Remove experimentalDecorators and useDefineForClassFields from tsconfig compilerOptions
+- Add @git.zone/cli release registry configuration to npmextra.json (verdaccio + npm registry)
+
+## 2024-05-29 - 1.0.23 - docs
+Update package description.
+
+- Updated project/package description text.
+
+## 2024-04-18 - 1.0.22 - fix(core)
+Core fixes and maintenance.
+
+- Miscellaneous core updates and bug fixes.
+
+## 2024-04-18 - 1.0.21 - core/build
+Maintenance and config updates for 1.0.21.
+
+- Miscellaneous core fixes.
+- Updated tsconfig.
+- Updated npmextra.json (githost) across multiple commits.
+
+## 2023-09-11 - 1.0.20 - maintenance
+Organization and core adjustments.
+
+- Switched to new organization scheme.
+- Miscellaneous core fixes.
+
+## 2021-08-17 - 1.0.19 - 1.0.2 - maintenance
+Multiple minor core fixes and release/tag-only commits (grouped).
+
+- Series of minor core fixes and maintenance updates across versions 1.0.2 through 1.0.19.
+- Many commits are release tags or generic core updates without additional user-facing changes.
+
+## 2019-05-23 - 1.0.8 - fix(core)
+Improve process termination behavior.
+
+- Now killing groups of processes with negative PIDs to ensure child process groups are handled correctly.
+
+## 2019-05-22 - 1.0.7 - fix(core)
+Stronger process kill handling.
+
+- Added SIGKILL fallback with a 10-second delay to ensure processes are terminated when needed.
+
+## 2019-05-16 - 1.0.1 - init
+Initial core commit.
+
+- Initial core implementation and setup (recorded as fix(core): initial).

npmextra.json

@@ -1,17 +1,46 @@
 {
   "gitzone": {
+    "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartexit",
-      "shortDescription": "do things before one exists a process",
+      "description": "A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.",
-      "npmPackagename": "@pushrocks/smartexit",
+      "npmPackagename": "@push.rocks/smartexit",
       "license": "MIT",
-      "projectDomain": "push.rocks"
+      "projectDomain": "push.rocks",
+      "keywords": [
+        "Node.js",
+        "TypeScript",
+        "process management",
+        "graceful shutdown",
+        "cleanup operations",
+        "child process termination",
+        "signal handling",
+        "library",
+        "npm package",
+        "async cleanup",
+        "module",
+        "SIGINT handling",
+        "uncaught exception management",
+        "process exit management"
+      ]
     }
   },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  },
+  "@git.zone/cli": {
+    "release": {
+      "registries": [
+        "https://verdaccio.lossleess.digital",
+        "https://registry.npmjs.org"
+      ],
+      "accessLevel": "public"
+    }
   }
 }

package.json

@@ -1,27 +1,64 @@
 {
-  "name": "@pushrocks/smartexit",
+  "name": "@push.rocks/smartexit",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "private": false,
-  "description": "do things before one exists a process",
+  "description": "A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@git.zone/tsbuild": "^4.0.2",
-    "@gitzone/tstest": "^1.0.15",
+    "@git.zone/tsrun": "^2.0.1",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@git.zone/tstest": "^3.1.3",
-    "@types/node": "^12.0.2",
+    "@types/node": "^24.0.3"
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.5",
+    "@push.rocks/lik": "^6.2.2",
-    "@pushrocks/smartdelay": "^2.0.3"
+    "@push.rocks/smartdelay": "^3.0.5",
+    "@push.rocks/smartpromise": "^4.2.3",
+    "tree-kill": "^1.2.2"
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "type": "module",
+  "keywords": [
+    "Node.js",
+    "TypeScript",
+    "process management",
+    "graceful shutdown",
+    "cleanup operations",
+    "child process termination",
+    "signal handling",
+    "library",
+    "npm package",
+    "async cleanup",
+    "module",
+    "SIGINT handling",
+    "uncaught exception management",
+    "process exit management"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartexit",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartexit.git"
   }
 }

readme.hints.md

@@ -0,0 +1,29 @@
+# SmartExit - Development Hints
+
+## Logging System
+
+The module uses consolidated logging with a `[smartexit]` prefix:
+
+- **Default behavior**: Logs a single summary line on shutdown
+- **Silent mode**: Pass `{ silent: true }` to constructor to disable all logging
+
+### Example output
+```
+[smartexit] Shutdown complete: killed 3 child processes, ran 2 cleanup functions
+```
+
+### Usage
+```typescript
+// Default - logs summary
+const smartExit = new SmartExit();
+
+// Silent - no logging
+const smartExit = new SmartExit({ silent: true });
+```
+
+## killAll() Return Value
+
+The `killAll()` method returns stats about the cleanup:
+```typescript
+const { processesKilled, cleanupFunctionsRan } = await smartExit.killAll();
+```

readme.md

@@ -1,26 +1,148 @@
-# @pushrocks/smartexit
+# @push.rocks/smartexit
-do things before one exists a process
 
-## Availabililty and Links
+A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartexit)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartexit)
-* [github.com (source mirror)](https://github.com/pushrocks/smartexit)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartexit/)
 
-## Status for master
+## Issue Reporting and Security
-[![build status](https://gitlab.com/pushrocks/smartexit/badges/master/build.svg)](https://gitlab.com/pushrocks/smartexit/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartexit/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartexit/commits/master)
+For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartexit.svg)](https://www.npmjs.com/package/@pushrocks/smartexit)
+
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartexit/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartexit)
+## Install
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+To install `@push.rocks/smartexit`, use pnpm:
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+```bash
+pnpm install @push.rocks/smartexit
+```
 
 ## Usage
 
-For further information read the linked docs at the top of this readme.
+`@push.rocks/smartexit` helps you gracefully shut down Node.js applications by running cleanup operations before the process exits. It handles signal interception (`SIGINT`, `SIGTERM`), uncaught exception management, and child process termination.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+### Basic Setup
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+```typescript
+import { SmartExit } from '@push.rocks/smartexit';
+
+// Create an instance - this automatically hooks into process signals
+const smartExit = new SmartExit();
+```
+
+### Registering Cleanup Functions
+
+Define custom async cleanup functions that execute before the process exits:
+
+```typescript
+smartExit.addCleanupFunction(async () => {
+  console.log('Closing database connections...');
+  await database.close();
+});
+
+smartExit.addCleanupFunction(async () => {
+  console.log('Flushing logs...');
+  await logger.flush();
+});
+```
+
+### Managing Child Processes
+
+Track spawned child processes so they get properly terminated on exit:
+
+```typescript
+import { spawn } from 'child_process';
+
+const childProcess = spawn('node', ['worker.js']);
+smartExit.addProcess(childProcess);
+
+// Remove from tracking if the process ends naturally
+childProcess.on('exit', () => {
+  smartExit.removeProcess(childProcess);
+});
+```
+
+### Kill Process Trees by PID
+
+Terminate an entire process tree using the static `killTreeByPid` method:
+
+```typescript
+import { SmartExit, type TProcessSignal } from '@push.rocks/smartexit';
+
+// Kill with default SIGKILL
+await SmartExit.killTreeByPid(12345);
+
+// Kill with a specific signal
+await SmartExit.killTreeByPid(12345, 'SIGTERM');
+```
+
+### Triggering Cleanup Manually
+
+While `SmartExit` automatically hooks into `SIGINT`, `SIGTERM`, and uncaught exceptions, you can manually trigger cleanup:
+
+```typescript
+await smartExit.killAll();
+process.exit(0);
+```
+
+### Integrating with Express
+
+Gracefully close an Express server on shutdown:
+
+```typescript
+import express from 'express';
+import { SmartExit } from '@push.rocks/smartexit';
+
+const app = express();
+const smartExit = new SmartExit();
+
+const server = app.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+
+smartExit.addCleanupFunction(async () => {
+  console.log('Closing Express server...');
+  await new Promise<void>((resolve) => server.close(() => resolve()));
+});
+```
+
+### Available Process Signals
+
+The `TProcessSignal` type provides all standard POSIX signals:
+
+```typescript
+import type { TProcessSignal } from '@push.rocks/smartexit';
+
+// Examples: 'SIGINT', 'SIGTERM', 'SIGKILL', 'SIGHUP', 'SIGUSR1', 'SIGUSR2', etc.
+```
+
+### How It Works
+
+When you create a `SmartExit` instance, it automatically:
+
+1. **Hooks `SIGINT`** (Ctrl+C): Runs cleanup and exits with code 0
+2. **Hooks process `exit`**: Runs cleanup when `process.exit(0)` is called
+3. **Catches uncaught exceptions**: Logs the error, runs cleanup, and exits with code 1
+
+On `killAll()`, it:
+- Sends `SIGINT` to all tracked child processes
+- Waits 10 seconds, then sends `SIGKILL` if processes are still alive
+- Executes all registered cleanup functions
+
+## License and Legal Information
+
+This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
+
+Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
+
+### Company Information
+
+Task Venture Capital GmbH
+Registered at District Court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@git.zone/tstest/tapbundle';
-import * as smartexit from '../ts/index';
+import * as smartexit from '../ts/index.js';
 
 let testSmartexit: smartexit.SmartExit;
 
@@ -7,8 +7,8 @@ tap.test('first test', async () => {
   testSmartexit = new smartexit.SmartExit();
 });
 
-tap.test('should end processes upon SIGINT', async tools => {
+tap.test('should end processes upon SIGINT', async (tools) => {
   await tools.delayFor(5000);
 });
 
-tap.start();
+export default tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartexit',
+  version: '1.1.0',
+  description: 'A library for managing graceful shutdowns of Node.js processes by handling cleanup operations, including terminating child processes.'
+}

ts/index.ts

@@ -1,7 +1,78 @@
-import * as plugins from './smartexit.plugins';
+import * as plugins from './smartexit.plugins.js';
+
+export interface ISmartExitOptions {
+  silent?: boolean;  // Completely disable logging
+}
+
+export type TProcessSignal =
+  | 'SIGHUP'    // Hangup detected on controlling terminal or death of controlling process
+  | 'SIGINT'    // Interrupt from keyboard
+  | 'SIGQUIT'   // Quit from keyboard
+  | 'SIGILL'    // Illegal Instruction
+  | 'SIGTRAP'   // Trace/breakpoint trap
+  | 'SIGABRT'   // Abort signal from abort(3)
+  | 'SIGIOT'    // IOT trap. A synonym for SIGABRT
+  | 'SIGBUS'    // Bus error (bad memory access)
+  | 'SIGFPE'    // Floating-point exception
+  | 'SIGKILL'   // Kill signal
+  | 'SIGUSR1'   // User-defined signal 1
+  | 'SIGSEGV'   // Invalid memory reference
+  | 'SIGUSR2'   // User-defined signal 2
+  | 'SIGPIPE'   // Broken pipe: write to pipe with no readers
+  | 'SIGALRM'   // Timer signal from alarm(2)
+  | 'SIGTERM'   // Termination signal
+  | 'SIGCHLD'   // Child stopped or terminated
+  | 'SIGCONT'   // Continue if stopped
+  | 'SIGSTOP'   // Stop process
+  | 'SIGTSTP'   // Stop typed at terminal
+  | 'SIGTTIN'   // Terminal input for background process
+  | 'SIGTTOU'   // Terminal output for background process
+  | 'SIGURG'    // Urgent condition on socket
+  | 'SIGXCPU'   // CPU time limit exceeded
+  | 'SIGXFSZ'   // File size limit exceeded
+  | 'SIGVTALRM' // Virtual alarm clock
+  | 'SIGPROF'   // Profiling timer expired
+  | 'SIGWINCH'  // Window resize signal
+  | 'SIGPOLL'   // Pollable event (Sys V). Synonym for SIGIO
+  | 'SIGIO'     // I/O now possible (4.2BSD)
+  | 'SIGPWR'    // Power failure (System V)
+  | 'SIGINFO'   // Information request (some systems)
+  | 'SIGLOST'   // Resource lost (unused on most UNIX systems)
+  | 'SIGSYS'    // Bad system call (unused on most UNIX systems)
+  | 'SIGUNUSED'; // Synonym for SIGSYS
 
 export class SmartExit {
-  public processesToEnd = new plugins.lik.Objectmap<plugins.childProcess.ChildProcess>();
+  public static async killTreeByPid(pidArg: number, signalArg: TProcessSignal = 'SIGKILL') {
+    const done = plugins.smartpromise.defer();
+    plugins.treeKill.default(pidArg, signalArg, (err) => {
+      if (err) {
+        done.reject(err);
+      } else {
+        done.resolve();
+      }
+    });
+    await done.promise;
+  }
+
+  // Instance
+  public processesToEnd = new plugins.lik.ObjectMap<plugins.childProcess.ChildProcess>();
+  public cleanupFunctions = new plugins.lik.ObjectMap<() => Promise<any>>();
+  private options: ISmartExitOptions;
+
+  /**
+   * Internal logging helper that respects silent option
+   */
+  private log(message: string, isError = false): void {
+    if (this.options.silent) {
+      return;
+    }
+    const prefix = '[smartexit]';
+    if (isError) {
+      console.error(`${prefix} ${message}`);
+    } else {
+      console.log(`${prefix} ${message}`);
+    }
+  }
 
   /**
    * adds a process to be exited
@@ -11,6 +82,10 @@ export class SmartExit {
     this.processesToEnd.add(childProcessArg);
   }
 
+  public addCleanupFunction(cleanupFunctionArg: () => Promise<any>) {
+    this.cleanupFunctions.add(cleanupFunctionArg);
+  }
+
   /**
    * removes a process to be exited
    */
@@ -18,44 +93,67 @@ export class SmartExit {
     this.processesToEnd.remove(childProcessArg);
   }
 
-  public async killAll() {
+  public async killAll(): Promise<{ processesKilled: number; cleanupFunctionsRan: number }> {
-    console.log('Checking for remaining child processes before exit...');
+    const processes = this.processesToEnd.getArray();
-    if (this.processesToEnd.getArray().length > 0) {
+    const cleanupFuncs = this.cleanupFunctions.getArray();
-      console.log('found remaining child processes');
+    let processesKilled = 0;
-      let counter = 1;
+    let cleanupFunctionsRan = 0;
-      this.processesToEnd.forEach(async childProcessArg => {
-        console.log(`killing process #${counter}`);
-        plugins.smartdelay.delayFor(10000).then(() => {
-          if (childProcessArg.killed) {
-            return;
-          }
-          childProcessArg.kill('SIGKILL');
-        })
-        childProcessArg.kill('SIGINT');
 
-        counter++;
+    // Kill child processes
-      });
+    if (processes.length > 0) {
-    } else {
+      for (const childProcessArg of processes) {
-      console.log(`Everything looks clean. Ready to exit!`);
+        const pid = childProcessArg.pid;
+        if (pid) {
+          plugins.smartdelay.delayFor(10000).then(() => {
+            if (childProcessArg.killed) {
+              return;
+            }
+            process.kill(pid, 'SIGKILL');
+          });
+          process.kill(pid, 'SIGINT');
+          processesKilled++;
+        }
+      }
     }
+
+    // Run cleanup functions
+    if (cleanupFuncs.length > 0) {
+      for (const cleanupFunction of cleanupFuncs) {
+        await cleanupFunction();
+        cleanupFunctionsRan++;
+      }
+    }
+
+    return { processesKilled, cleanupFunctionsRan };
   }
 
-  constructor() {
+  constructor(optionsArg: ISmartExitOptions = {}) {
+    this.options = optionsArg;
+
     // do app specific cleaning before exiting
-    process.on('exit', async () => {
+    process.on('exit', async (code) => {
-      await this.killAll();
+      if (code === 0) {
+        const { processesKilled, cleanupFunctionsRan } = await this.killAll();
+        this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions`);
+      } else {
+        const { processesKilled, cleanupFunctionsRan } = await this.killAll();
+        this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions (exit code: ${code})`, true);
+      }
     });
 
     // catch ctrl+c event and exit normally
     process.on('SIGINT', async () => {
-      console.log('Ctrl-C...');
+      const { processesKilled, cleanupFunctionsRan } = await this.killAll();
-      await this.killAll();
+      this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions`);
+      process.exit(0);
     });
 
-    //catch uncaught exceptions, trace, then exit normally
+    // catch uncaught exceptions, trace, then exit normally
-    process.on('uncaughtException', async err => {
+    process.on('uncaughtException', async (err) => {
-      console.log('Ctrl-C...');
+      this.log(`Uncaught exception: ${err.message}`, true);
-      await this.killAll();
+      const { processesKilled, cleanupFunctionsRan } = await this.killAll();
+      this.log(`Shutdown complete: killed ${processesKilled} child processes, ran ${cleanupFunctionsRan} cleanup functions (exit code: 1)`, true);
+      process.exit(1);
     });
   }
 }

ts/smartexit.plugins.ts

@@ -4,7 +4,15 @@ import * as childProcess from 'child_process';
 export { childProcess };
 
 // pushrocks scope
-import * as lik from '@pushrocks/lik';
+import * as lik from '@push.rocks/lik';
-import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartdelay from '@push.rocks/smartdelay';
+import * as smartpromise from '@push.rocks/smartpromise';
 
-export { lik, smartdelay };
+export { lik, smartdelay, smartpromise };
+
+// third party scope
+import * as treeKill from 'tree-kill';
+
+export {
+  treeKill
+}

tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}