Compare commits
No commits in common. "master" and "v2.0.1" have entirely different histories.
@ -1,66 +0,0 @@
|
|||||||
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
|
|
||||||
@ -1,124 +0,0 @@
|
|||||||
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
|
|
||||||
128
.gitlab-ci.yml
Normal file
128
.gitlab-ci.yml
Normal file
@ -0,0 +1,128 @@
|
|||||||
|
# gitzone ci_default
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
|
cache:
|
||||||
|
paths:
|
||||||
|
- .npmci_cache/
|
||||||
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
|
stages:
|
||||||
|
- security
|
||||||
|
- test
|
||||||
|
- release
|
||||||
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- pnpm install -g pnpm
|
||||||
|
- pnpm install -g @shipzone/npmci
|
||||||
|
- npmci npm prepare
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --prod
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --dev
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# test stage
|
||||||
|
# ====================
|
||||||
|
|
||||||
|
testStable:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci npm test
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
testBuild:
|
||||||
|
stage: test
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run build
|
||||||
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
release:
|
||||||
|
stage: release
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm publish
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
# ====================
|
||||||
|
# metadata stage
|
||||||
|
# ====================
|
||||||
|
codequality:
|
||||||
|
stage: metadata
|
||||||
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
script:
|
||||||
|
- npmci command npm install -g typescript
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci npm install
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
|
pages:
|
||||||
|
stage: metadata
|
||||||
|
script:
|
||||||
|
- npmci node install stable
|
||||||
|
- npmci npm install
|
||||||
|
- npmci command npm run buildDocs
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
allow_failure: true
|
||||||
31
changelog.md
31
changelog.md
@ -1,31 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2025-03-03 - 2.0.8 - fix(core)
|
|
||||||
Update project dependencies and resolve minor issues in file paths
|
|
||||||
|
|
||||||
- Updated devDependencies and dependencies to latest versions
|
|
||||||
- Resolved minor issues in file paths within systemd manager
|
|
||||||
|
|
||||||
## 2025-03-03 - 2.0.7 - fix(core)
|
|
||||||
Update @types/node to fix compatibility issues.
|
|
||||||
|
|
||||||
- Updated @types/node from version 20.12.7 to 22.13.8 to ensure compatibility with the latest Node.js features.
|
|
||||||
- Improved type definitions which might resolve minor type errors in development.
|
|
||||||
|
|
||||||
## 2024-05-29 - 2.0.6 - Documentation
|
|
||||||
updated project description
|
|
||||||
|
|
||||||
## 2024-04-19 - 2.0.5 to 2.0.4 - Core Updates
|
|
||||||
Improved core functionality across multiple versions.
|
|
||||||
|
|
||||||
- Updated tsconfig for better build performance.
|
|
||||||
- Revised npmextra.json to update githost configuration.
|
|
||||||
|
|
||||||
## 2023-07-25 - 2.0.3 - Organizational Changes
|
|
||||||
implemented a new organizational scheme
|
|
||||||
|
|
||||||
## 2022-10-19 - 2.0.0 - Core Updates and Breaking Changes
|
|
||||||
Major overhaul with breaking changes and core updates.
|
|
||||||
|
|
||||||
- **Breaking Change:** Transitioned the project architecture from CommonJS to ECMAScript modules (ESM) to enhance compatibility and future-proofing.
|
|
||||||
|
|
||||||
@ -2,29 +2,17 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartdaemon",
|
"gitrepo": "smartdaemon",
|
||||||
"description": "Start scripts as long running daemons and manage them.",
|
"description": "start scripts as long running daemons and manage them",
|
||||||
"npmPackagename": "@push.rocks/smartdaemon",
|
"npmPackagename": "@pushrocks/smartdaemon",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks",
|
"projectDomain": "push.rocks"
|
||||||
"keywords": [
|
|
||||||
"daemon",
|
|
||||||
"service management",
|
|
||||||
"Linux systemd",
|
|
||||||
"process management",
|
|
||||||
"Node.js",
|
|
||||||
"system administration",
|
|
||||||
"background services"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"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"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
47
package.json
47
package.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartdaemon",
|
"name": "@pushrocks/smartdaemon",
|
||||||
"version": "2.0.8",
|
"version": "2.0.1",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "Start scripts as long running daemons and manage them.",
|
"description": "start scripts as long running daemons and manage them",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
@ -13,21 +13,20 @@
|
|||||||
"buildDocs": "tsdoc"
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.66",
|
"@gitzone/tsbuild": "^2.1.25",
|
||||||
"@git.zone/tsrun": "^1.2.44",
|
"@gitzone/tstest": "^1.0.52",
|
||||||
"@git.zone/tstest": "^1.0.77",
|
"@pushrocks/tapbundle": "^5.0.4",
|
||||||
"@push.rocks/tapbundle": "^5.0.23",
|
"@types/node": "^18.11.2"
|
||||||
"@types/node": "^22.13.8"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/lik": "^6.0.15",
|
"@pushrocks/lik": "^6.0.0",
|
||||||
"@push.rocks/smartfile": "^11.0.14",
|
"@pushrocks/smartfile": "^10.0.5",
|
||||||
"@push.rocks/smartfm": "^2.0.4",
|
"@pushrocks/smartfm": "^2.0.4",
|
||||||
"@push.rocks/smartlog": "^3.0.3",
|
"@pushrocks/smartlog": "^3.0.1",
|
||||||
"@push.rocks/smartlog-destination-local": "^9.0.1",
|
"@pushrocks/smartlog-destination-local": "^8.0.8",
|
||||||
"@push.rocks/smartpath": "^5.0.14",
|
"@pushrocks/smartpath": "^5.0.5",
|
||||||
"@push.rocks/smartshell": "^3.0.5",
|
"@pushrocks/smartshell": "^2.0.26",
|
||||||
"@push.rocks/smartsystem": "^3.0.1"
|
"@pushrocks/smartsystem": "^3.0.1"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@ -44,19 +43,5 @@
|
|||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
],
|
],
|
||||||
"type": "module",
|
"type": "module"
|
||||||
"keywords": [
|
|
||||||
"daemon",
|
|
||||||
"service management",
|
|
||||||
"Linux systemd",
|
|
||||||
"process management",
|
|
||||||
"Node.js",
|
|
||||||
"system administration",
|
|
||||||
"background services"
|
|
||||||
],
|
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartdaemon",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://code.foss.global/push.rocks/smartdaemon.git"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
11957
pnpm-lock.yaml
generated
11957
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
|||||||
|
|
||||||
129
readme.md
129
readme.md
@ -1,112 +1,41 @@
|
|||||||
# @push.rocks/smartdaemon
|
# @pushrocks/smartdaemon
|
||||||
start scripts as long running daemons and manage them
|
start scripts as long running daemons and manage them
|
||||||
|
|
||||||
## Install
|
## Availabililty and Links
|
||||||
To install `@push.rocks/smartdaemon`, run the following command in your terminal:
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdaemon)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdaemon)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartdaemon)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartdaemon/)
|
||||||
|
|
||||||
```bash
|
## Status for master
|
||||||
npm install @push.rocks/smartdaemon --save
|
|
||||||
```
|
Status Category | Status Badge
|
||||||
This will add `@push.rocks/smartdaemon` to your project's dependencies.
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
`@push.rocks/smartdaemon` is a powerful module designed to help you manage long-running daemons for your applications. Whether you're running background services, scheduled tasks, or any other continuous or long-term operations in a Node.js environment, `smartdaemon` provides an intuitive and flexible API to control these processes.
|
## Contribution
|
||||||
|
|
||||||
### Getting Started
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
First, ensure you import `SmartDaemon` from the package in your TypeScript files:
|
|
||||||
|
|
||||||
```typescript
|
## Contribution
|
||||||
import { SmartDaemon } from '@push.rocks/smartdaemon';
|
|
||||||
```
|
|
||||||
|
|
||||||
### Initialize SmartDaemon
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
Create an instance of `SmartDaemon`. This instance will be the central point for managing your services.
|
|
||||||
|
|
||||||
```typescript
|
For further information read the linked docs at the top of this readme.
|
||||||
const myDaemon = new SmartDaemon();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Adding a Service
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
To manage a daemon, you first need to define it as a service. A service in `smartdaemon` is essentially a description of the daemon process you want to manage — including how it should be started, where it should run, and other operational metadata.
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
Here's an example of adding a simple service that executes a shell command:
|
[](https://maintainedby.lossless.com)
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function addSampleService() {
|
|
||||||
const myService = await myDaemon.addService({
|
|
||||||
name: 'mySampleService',
|
|
||||||
description: 'A sample service running a long-lived process',
|
|
||||||
command: 'node path/to/your/script.js',
|
|
||||||
workingDir: '/absolute/path/to/working/directory',
|
|
||||||
version: '1.0.0'
|
|
||||||
});
|
|
||||||
|
|
||||||
await myService.enable();
|
|
||||||
}
|
|
||||||
addSampleService();
|
|
||||||
```
|
|
||||||
|
|
||||||
In this example:
|
|
||||||
- `name`: Unique identifier for the service.
|
|
||||||
- `description`: A brief explanation of the service.
|
|
||||||
- `command`: The command that starts your daemon (e.g., node application, shell script).
|
|
||||||
- `workingDir`: The working directory from which the command will be executed.
|
|
||||||
- `version`: The version of your service. This can be used for your own versioning and tracking.
|
|
||||||
|
|
||||||
### Starting and Stopping Services
|
|
||||||
After adding and enabling a service, you can control it using the start and stop methods.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function controlService() {
|
|
||||||
const myServiceName = 'mySampleService'; // The name of the service you added before
|
|
||||||
const myService = await myDaemon.getService(myServiceName);
|
|
||||||
|
|
||||||
// To start the service
|
|
||||||
await myService.start();
|
|
||||||
|
|
||||||
// To stop the service
|
|
||||||
await myService.stop();
|
|
||||||
}
|
|
||||||
controlService();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Advanced Management
|
|
||||||
`smartdaemon` also provides advanced functionalities to manage your daemons effectively, including:
|
|
||||||
- Checking the status of your services
|
|
||||||
- Automatically restarting services on failure
|
|
||||||
- Configuring environment variables or execution parameters
|
|
||||||
|
|
||||||
### Working with Systemd
|
|
||||||
If you're operating on a Linux environment, `smartdaemon` can generate and control services using `systemd`. This integration allows for robust management capabilities, utilizing system-level features for daemon management.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// Example: Creating a systemd service
|
|
||||||
await myDaemon.systemdManager.saveService(myService);
|
|
||||||
```
|
|
||||||
|
|
||||||
### Conclusion
|
|
||||||
`@push.rocks/smartdaemon` streamlines the management of long-running daemons and background services in Node.js applications. By leveraging its comprehensive API, developers can efficiently control the lifecycle of their services, ensuring their applications run smoothly and reliably.
|
|
||||||
|
|
||||||
This module opens up possibilities for more structured and system-integrated application architectures, especially in environments where long-running tasks are essential.
|
|
||||||
|
|
||||||
**Note**: Ensure to check permissions and system compatibility, especially when integrating with system-level service managers like `systemd`.
|
|
||||||
|
|
||||||
## License and Legal Information
|
|
||||||
|
|
||||||
This 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.
|
|
||||||
|
|
||||||
**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 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.
|
|
||||||
|
|
||||||
### Company Information
|
|
||||||
|
|
||||||
Task Venture Capital GmbH
|
|
||||||
Registered at District court Bremen HRB 35230 HB, Germany
|
|
||||||
|
|
||||||
For any legal inquiries or if you require 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.
|
|
||||||
|
|||||||
@ -1,3 +1,5 @@
|
|||||||
import * as smartpath from '@push.rocks/smartpath';
|
import * as smartpath from '@pushrocks/smartpath';
|
||||||
|
|
||||||
export { smartpath };
|
export {
|
||||||
|
smartpath
|
||||||
|
};
|
||||||
|
|||||||
@ -1,9 +1,11 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
|
||||||
import * as plugins from './plugins.js';
|
import * as plugins from './plugins.js';
|
||||||
|
|
||||||
import * as smartdaemon from '../ts/index.js';
|
import * as smartdaemon from '../ts/index.js';
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
let testSmartdaemon: smartdaemon.SmartDaemon;
|
let testSmartdaemon: smartdaemon.SmartDaemon;
|
||||||
|
|
||||||
tap.test('should create an instance of smartdaemon', async () => {
|
tap.test('should create an instance of smartdaemon', async () => {
|
||||||
@ -21,4 +23,4 @@ tap.test('should create a service', async () => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
export default tap.start();
|
tap.start();
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
/**
|
/**
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartdaemon',
|
name: '@pushrocks/smartdaemon',
|
||||||
version: '2.0.8',
|
version: '2.0.1',
|
||||||
description: 'Start scripts as long running daemons and manage them.'
|
description: 'start scripts as long running daemons and manage them'
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
import * as plugins from './smartdaemon.plugins.js';
|
import * as plugins from './smartdaemon.plugins.js';
|
||||||
import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager.js';
|
import { SmartDaemonTemplateManager } from './smartdaemon.classes.templatemanager.js';
|
||||||
import {
|
import {
|
||||||
type ISmartDaemonServiceConstructorOptions,
|
|
||||||
SmartDaemonService,
|
SmartDaemonService,
|
||||||
|
ISmartDaemonServiceConstructorOptions,
|
||||||
} from './smartdaemon.classes.service.js';
|
} from './smartdaemon.classes.service.js';
|
||||||
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager.js';
|
import { SmartDaemonSystemdManager } from './smartdaemon.classes.systemdmanager.js';
|
||||||
|
|
||||||
|
|||||||
@ -2,7 +2,7 @@ import * as plugins from './smartdaemon.plugins.js';
|
|||||||
import * as paths from './smartdaemon.paths.js';
|
import * as paths from './smartdaemon.paths.js';
|
||||||
import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
|
import { SmartDaemon } from './smartdaemon.classes.smartdaemon.js';
|
||||||
import {
|
import {
|
||||||
type ISmartDaemonServiceConstructorOptions,
|
ISmartDaemonServiceConstructorOptions,
|
||||||
SmartDaemonService,
|
SmartDaemonService,
|
||||||
} from './smartdaemon.classes.service.js';
|
} from './smartdaemon.classes.service.js';
|
||||||
|
|
||||||
|
|||||||
@ -1,7 +1,4 @@
|
|||||||
import * as plugins from './smartdaemon.plugins.js';
|
import * as plugins from './smartdaemon.plugins.js';
|
||||||
|
|
||||||
export const packageDir = plugins.path.join(
|
export const packageDir = plugins.path.join(plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
|
||||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
|
||||||
'../'
|
|
||||||
);
|
|
||||||
export const systemdDir = plugins.path.join('/lib/systemd/system/');
|
export const systemdDir = plugins.path.join('/lib/systemd/system/');
|
||||||
|
|||||||
@ -4,24 +4,15 @@ import * as path from 'path';
|
|||||||
export { path };
|
export { path };
|
||||||
|
|
||||||
// @pushrocks scope
|
// @pushrocks scope
|
||||||
import * as lik from '@push.rocks/lik';
|
import * as lik from '@pushrocks/lik';
|
||||||
import * as smartfile from '@push.rocks/smartfile';
|
import * as smartfile from '@pushrocks/smartfile';
|
||||||
import * as smartfm from '@push.rocks/smartfm';
|
import * as smartfm from '@pushrocks/smartfm';
|
||||||
import * as smartlog from '@push.rocks/smartlog';
|
import * as smartlog from '@pushrocks/smartlog';
|
||||||
import * as smartlogDestinationLocal from '@push.rocks/smartlog-destination-local';
|
import * as smartlogDestinationLocal from '@pushrocks/smartlog-destination-local';
|
||||||
import * as smartpath from '@push.rocks/smartpath';
|
import * as smartpath from '@pushrocks/smartpath';
|
||||||
import * as smartshell from '@push.rocks/smartshell';
|
import * as smartshell from '@pushrocks/smartshell';
|
||||||
import * as smartsystem from '@push.rocks/smartsystem';
|
import * as smartsystem from '@pushrocks/smartsystem';
|
||||||
|
|
||||||
export {
|
export { lik, smartfile, smartfm, smartlog, smartlogDestinationLocal, smartpath, smartshell, smartsystem };
|
||||||
lik,
|
|
||||||
smartfile,
|
|
||||||
smartfm,
|
|
||||||
smartlog,
|
|
||||||
smartlogDestinationLocal,
|
|
||||||
smartpath,
|
|
||||||
smartshell,
|
|
||||||
smartsystem,
|
|
||||||
};
|
|
||||||
|
|
||||||
// third party
|
// third party
|
||||||
|
|||||||
@ -3,12 +3,8 @@
|
|||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"useDefineForClassFields": false,
|
"useDefineForClassFields": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"module": "NodeNext",
|
"module": "ES2022",
|
||||||
"moduleResolution": "NodeNext",
|
"moduleResolution": "nodenext",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true
|
||||||
"verbatimModuleSyntax": true
|
}
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"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"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user