Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 71f44f64fb | |||
| 3eac579317 | |||
| f87fa3bf2b | |||
| 8b101369b8 | |||
| 89d9692701 | |||
| 69b22df534 | |||
| 0b2e88f430 |
128
.gitlab-ci.yml
128
.gitlab-ci.yml
@@ -1,128 +0,0 @@
|
||||
# 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:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- 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 prepare
|
||||
- npmci npm install
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
46
changelog.md
Normal file
46
changelog.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-08-29 - 3.0.2 - fix(smartsystem)
|
||||
Normalize package scopes, update dev dependencies and tooling, add pnpm workspace and packageManager, remove GitLab CI, and update imports/docs/tests
|
||||
|
||||
- Normalize package scope names from @pushrocks/* to @push.rocks/* across source, commit info and README
|
||||
- Update dependency versions: bump @push.rocks/smartpromise to ^4.0.2 and ensure other @push.rocks packages use caret ranges
|
||||
- Switch dev tooling namespaces to @git.zone (tsbuild/tsrun/tstest) and add @git.zone/tsrun
|
||||
- Enhance npm scripts: make test run with verbose, logfile and increased timeout
|
||||
- Add packageManager field (pnpm@10.14.0+sha512...) to package.json and add pnpm-workspace.yaml with onlyBuiltDependencies: [esbuild]
|
||||
- Remove legacy .gitlab-ci.yml CI configuration
|
||||
- Update imports in ts and test files to match new package namespaces
|
||||
|
||||
## 2024-05-29 - 3.0.1 - chore
|
||||
Update of package metadata and TypeScript configuration.
|
||||
|
||||
- update description
|
||||
- update tsconfig (adjustments to TypeScript config)
|
||||
- update npmextra.json: githost (fixes to githost entries)
|
||||
|
||||
## 2022-07-28 - 3.0.0 - fix(core)
|
||||
Minor core fixes and release of 3.0.0.
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2022-07-28 - 2.0.10 - BREAKING (core)
|
||||
Breaking change: module format switched to ESM.
|
||||
|
||||
- BREAKING CHANGE(core): switch to esm
|
||||
- misc maintenance and fixes leading up to this release
|
||||
|
||||
## 2017-07-31 - 2.0.1..2.0.9 - maintenance
|
||||
Series of patch releases with small fixes and upkeep across the 2.0.x line.
|
||||
|
||||
- Multiple patch releases (2.0.1 → 2.0.9) containing repeated core fixes
|
||||
- Updates to README and repository metadata
|
||||
- update yarn lock (notably in 2.0.1)
|
||||
|
||||
## 2017-07-31 - 1.0.0..1.0.18 - initial development & improvements
|
||||
Initial development, feature additions and documentation improvements across 1.0.x.
|
||||
|
||||
- initial releases and basic module structure; first working version
|
||||
- add npm as default module loader (1.0.6)
|
||||
- improve path resolution and add keywords (1.0.4–1.0.5)
|
||||
- add docs, improve README and tests across multiple 1.0.x releases
|
||||
- CI updates and general streamlining of the project
|
||||
@@ -6,12 +6,26 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartsystem",
|
||||
"description": "interact with the system you are running on",
|
||||
"npmPackagename": "@pushrocks/smartsystem",
|
||||
"license": "MIT"
|
||||
}
|
||||
"description": "A TypeScript library for interacting with the system it's running on, including environment, network, and hardware information.",
|
||||
"npmPackagename": "@push.rocks/smartsystem",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
"system information",
|
||||
"environment variables",
|
||||
"network",
|
||||
"hardware info",
|
||||
"OS interaction",
|
||||
"module loading",
|
||||
"async",
|
||||
"cross-platform"
|
||||
]
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
1312
package-lock.json
generated
1312
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
39
package.json
39
package.json
@@ -1,41 +1,47 @@
|
||||
{
|
||||
"name": "@pushrocks/smartsystem",
|
||||
"version": "3.0.1",
|
||||
"description": "interact with the system you are running on",
|
||||
"name": "@push.rocks/smartsystem",
|
||||
"version": "3.0.2",
|
||||
"description": "A TypeScript library for interacting with the system it's running on, including environment, network, and hardware information.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"test": "(tstest test/ --verbose --logfile --timeout 60)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+ssh://git@gitlab.com/pushrocks/smartsystem.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartsystem.git"
|
||||
},
|
||||
"keywords": [
|
||||
"TypeScript",
|
||||
"lazy",
|
||||
"module loader"
|
||||
"system information",
|
||||
"environment variables",
|
||||
"network",
|
||||
"hardware info",
|
||||
"OS interaction",
|
||||
"module loading",
|
||||
"async",
|
||||
"cross-platform"
|
||||
],
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/smartsystem/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/smartsystem#README",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartsystem",
|
||||
"dependencies": {
|
||||
"@pushrocks/lik": "^6.0.0",
|
||||
"@pushrocks/smartenv": "^5.0.2",
|
||||
"@pushrocks/smartnetwork": "^3.0.0",
|
||||
"@pushrocks/smartpromise": "^3.1.7",
|
||||
"@push.rocks/lik": "^6.0.0",
|
||||
"@push.rocks/smartenv": "^5.0.2",
|
||||
"@push.rocks/smartnetwork": "^3.0.0",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"systeminformation": "^5.12.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.63",
|
||||
"@gitzone/tstest": "^1.0.72",
|
||||
"@pushrocks/tapbundle": "^5.0.4",
|
||||
"@git.zone/tsbuild": "^2.1.63",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^1.0.72",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
@@ -54,5 +60,6 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
||||
}
|
||||
|
||||
8474
pnpm-lock.yaml
generated
Normal file
8474
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
2
pnpm-workspace.yaml
Normal file
2
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,2 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
|
||||
164
readme.md
164
readme.md
@@ -1,39 +1,147 @@
|
||||
# @pushrocks/smartsystem
|
||||
interact with the system you are running on
|
||||
# @push.rocks/smartsystem
|
||||
Interact with the system your Node.js app runs on.
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartsystem)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartsystem)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartsystem)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartsystem/)
|
||||
## Features
|
||||
|
||||
## Status for master
|
||||
- Simple class: expose system info through a single `Smartsystem` instance
|
||||
- Env access: read and manage env vars via `@push.rocks/smartenv`
|
||||
- CPU info: get `os.cpus()` without importing `os`
|
||||
- Network utilities: high-level helpers from `@push.rocks/smartnetwork`
|
||||
- Deep stats: tap into `systeminformation` for OS, hardware, and load data
|
||||
- TypeScript-first: typed API, works great from TS and JS
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
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)
|
||||
## Install
|
||||
|
||||
To incorporate @push.rocks/smartsystem into your project, you'll need to install the package via npm. You can do this by running the following command in your project's root directory:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartsystem --save
|
||||
```
|
||||
|
||||
This command will download @push.rocks/smartsystem and add it to your project's `package.json` file as a dependency.
|
||||
|
||||
## Usage
|
||||
|
||||
We recommend the use of TypeScript for best Intellisense
|
||||
The `@push.rocks/smartsystem` module offers a convenient way to interact with the system your application is running on. Below are detailed examples that demonstrate how to utilize its full potential. These examples are written in TypeScript and showcase different cases and features of the module.
|
||||
|
||||
## 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 that you are importing the module correctly in your TypeScript file:
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
```typescript
|
||||
import { Smartsystem } from '@push.rocks/smartsystem';
|
||||
```
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
### Creating an Instance of Smartsystem
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
To use the functionalities provided by `@push.rocks/smartsystem`, you need to create a new instance of the `Smartsystem` class.
|
||||
|
||||
```typescript
|
||||
const mySystem = new Smartsystem();
|
||||
```
|
||||
|
||||
## API Overview
|
||||
|
||||
- `Smartsystem.env`: instance of `Smartenv` from `@push.rocks/smartenv`
|
||||
Useful for reading and validating environment variables.
|
||||
- `Smartsystem.cpus`: result of `os.cpus()`
|
||||
Array of CPU core descriptions from Node’s built‑in `os` module.
|
||||
- `Smartsystem.network`: instance of `SmartNetwork` from `@push.rocks/smartnetwork`
|
||||
Inspect interfaces, addresses, and network details.
|
||||
- `Smartsystem.information`: re-export of `systeminformation`
|
||||
Call any method, e.g. `osInfo()`, `system()`, `currentLoad()`, `networkStats()`.
|
||||
|
||||
### Accessing Environment Variables
|
||||
|
||||
`@push.rocks/smartsystem` integrates with `@push.rocks/smartenv` to provide an easy way to handle environment variables.
|
||||
|
||||
```typescript
|
||||
console.log(mySystem.env.getEnvVars());
|
||||
```
|
||||
|
||||
### Getting CPU Information
|
||||
|
||||
You can retrieve information about the CPUs of the system:
|
||||
|
||||
```typescript
|
||||
console.log(mySystem.cpus[0]); // Logs details about the first CPU
|
||||
```
|
||||
|
||||
### Working with Network Interfaces
|
||||
|
||||
The module allows you to work with network interfaces, making use of `@push.rocks/smartnetwork`:
|
||||
|
||||
```typescript
|
||||
(async () => {
|
||||
console.log(await mySystem.network.getNetworkInfo());
|
||||
})();
|
||||
```
|
||||
|
||||
### System Information
|
||||
|
||||
For more detailed system information such as hardware specs or software versions, `@push.rocks/smartsystem` relies on the `systeminformation` library:
|
||||
|
||||
```typescript
|
||||
(async () => {
|
||||
console.log(await mySystem.information.system());
|
||||
// Output detailed information about the system like manufacturer, model, etc.
|
||||
|
||||
console.log(await mySystem.information.osInfo());
|
||||
// Output detailed information about the operating system
|
||||
})();
|
||||
```
|
||||
|
||||
### Real-World Scenarios
|
||||
|
||||
Now that we've covered the basics let's dive into some real-world applications:
|
||||
|
||||
#### Monitoring System Load
|
||||
|
||||
You can monitor the current load on the system to make decisions or trigger actions when the system is under heavy use:
|
||||
|
||||
```typescript
|
||||
(async () => {
|
||||
const systemLoad = await mySystem.information.currentLoad();
|
||||
if (systemLoad.currentLoad > 80) {
|
||||
console.log("High system load detected. Consider scaling or optimizing your applications.");
|
||||
}
|
||||
})();
|
||||
```
|
||||
|
||||
#### Network Monitoring
|
||||
|
||||
It's often useful to keep an eye on network interfaces, especially when diagnosing connectivity issues or monitoring network traffic:
|
||||
|
||||
```typescript
|
||||
(async () => {
|
||||
const defaultInterface = await mySystem.information.networkInterfaceDefault();
|
||||
const interfaceStats = await mySystem.information.networkStats(defaultInterface);
|
||||
console.log(interfaceStats);
|
||||
// Use this information to alert on unusual traffic patterns or drops in speed.
|
||||
})();
|
||||
```
|
||||
|
||||
### Conclusion
|
||||
|
||||
`@push.rocks/smartsystem` offers a comprehensive toolkit for interacting with the underlying system your Node.js application runs on. From retrieving environment variables and CPU information to monitoring network interfaces and system load, this module provides everything you need to ensure your application can intelligently respond to its operating environment.
|
||||
|
||||
Remember, the examples above only scratch the surface of what's possible with `@push.rocks/smartsystem`. For more detailed documentation on all available methods and their capabilities, refer to the [official documentation](https://pushrocks.gitlab.io/smartsystem/).
|
||||
|
||||
## 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,4 +1,4 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartsystem from '../ts/index.js';
|
||||
import { systeminformation } from '../ts/smartsystem.plugins.js';
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/smartsystem',
|
||||
version: '3.0.1',
|
||||
description: 'interact with the system you are running on'
|
||||
name: '@push.rocks/smartsystem',
|
||||
version: '3.0.2',
|
||||
description: 'A TypeScript library for interacting with the system it's running on, including environment, network, and hardware information.'
|
||||
}
|
||||
|
||||
@@ -3,10 +3,10 @@ import os from 'os';
|
||||
|
||||
export { os };
|
||||
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smartenv from '@pushrocks/smartenv';
|
||||
import * as smartnetwork from '@pushrocks/smartnetwork';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as smartenv from '@push.rocks/smartenv';
|
||||
import * as smartnetwork from '@push.rocks/smartnetwork';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
|
||||
export { lik, smartenv, smartnetwork, smartpromise };
|
||||
|
||||
|
||||
@@ -3,8 +3,12 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user