Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 250e3612ee | |||
| 4966edd60b | |||
| ce1ef50831 | |||
| e74c4d0189 | |||
| db7934abf9 | |||
| 8161bcb242 | |||
| 67f63745c0 | |||
| 7040586b85 | |||
| f42b584599 |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
dist_*/
|
||||
|
||||
# custom
|
||||
112
.gitlab-ci.yml
112
.gitlab-ci.yml
@ -1,16 +1,16 @@
|
||||
# gitzone standard
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
@ -18,102 +18,104 @@ stages:
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
snyk:
|
||||
audit:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install -g snyk
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testLTS:
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testSTABLE:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- 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]
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- docker
|
||||
- priv
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
- tags
|
||||
tags:
|
||||
- docker
|
||||
- notpriv
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
@ -121,5 +123,5 @@ pages:
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
- public
|
||||
allow_failure: true
|
||||
|
||||
29
.vscode/launch.json
vendored
Normal file
29
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
}
|
||||
]
|
||||
}
|
||||
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -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"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -1,17 +1,31 @@
|
||||
{
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartlog-source-ora",
|
||||
"shortDescription": "a smartlog source wrapping ora for local display",
|
||||
"npmPackagename": "@pushrocks/smartlog-source-ora",
|
||||
"npmPackagename": "@push.rocks/smartlog-source-ora",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"description": "A project that integrates smartlog logging capabilities with the ora spinner for visually appealing CLI output.",
|
||||
"keywords": [
|
||||
"logging",
|
||||
"smartlog",
|
||||
"ora spinner",
|
||||
"CLI",
|
||||
"typescript",
|
||||
"node.js",
|
||||
"developer tools"
|
||||
]
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
4744
package-lock.json
generated
4744
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
54
package.json
54
package.json
@ -1,27 +1,53 @@
|
||||
{
|
||||
"name": "@pushrocks/smartlog-source-ora",
|
||||
"version": "1.0.8",
|
||||
"name": "@push.rocks/smartlog-source-ora",
|
||||
"version": "1.0.9",
|
||||
"private": false,
|
||||
"description": "a smartlog source wrapping ora for local display",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"description": "A project that integrates smartlog logging capabilities with the ora spinner for visually appealing CLI output.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"build": "(tsbuild --web)",
|
||||
"format": "(gitzone format)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.0.22",
|
||||
"@gitzone/tstest": "^1.0.24",
|
||||
"@pushrocks/tapbundle": "^3.0.7",
|
||||
"@types/node": "^12.0.2",
|
||||
"tslint": "^5.11.0",
|
||||
"@gitzone/tsbuild": "^2.1.24",
|
||||
"@gitzone/tstest": "^1.0.33",
|
||||
"@pushrocks/tapbundle": "^3.2.1",
|
||||
"@types/node": "^14.0.11",
|
||||
"tslint": "^6.1.2",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/smartlog-interfaces": "^2.0.5",
|
||||
"ora": "^3.4.0"
|
||||
"@pushrocks/smartlog-interfaces": "^2.0.15",
|
||||
"ora": "^4.0.4"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_*/**/*",
|
||||
"dist_ts/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"keywords": [
|
||||
"logging",
|
||||
"smartlog",
|
||||
"ora spinner",
|
||||
"CLI",
|
||||
"typescript",
|
||||
"node.js",
|
||||
"developer tools"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/smartlog-source-ora",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/smartlog-source-ora.git"
|
||||
}
|
||||
}
|
||||
}
|
||||
3470
pnpm-lock.yaml
generated
Normal file
3470
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
142
readme.md
142
readme.md
@ -1,26 +1,132 @@
|
||||
# @pushrocks/smartlog-source-ora
|
||||
# @push.rocks/smartlog-source-ora
|
||||
a smartlog source wrapping ora for local display
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartlog-source-ora)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartlog-source-ora)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartlog-source-ora)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartlog-source-ora/)
|
||||
## Install
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartlog-source-ora/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartlog-source-ora/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartlog-source-ora)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartlog-source-ora)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
To use `@push.rocks/smartlog-source-ora` in your project, you need to include it via npm. Run the following command to install it:
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/smartlog-source-ora --save
|
||||
```
|
||||
|
||||
This will add `@push.rocks/smartlog-source-ora` to your project's dependencies.
|
||||
|
||||
## Usage
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
This library provides a convenient way to use the `ora` spinner in combination with the `smartlog` logging solution. It is great for CLI applications or any other Node.js project where you need to indicate progress or loading states in a visually appealing way. Below are examples demonstrating how to integrate and use `@push.rocks/smartlog-source-ora` in your projects.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
### Importing and Initialization
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
To start using `@push.rocks/smartlog-source-ora`, you first need to import the library and initialize an instance of `SmartlogSourceOra`.
|
||||
|
||||
```typescript
|
||||
import { SmartlogSourceOra } from '@push.rocks/smartlog-source-ora';
|
||||
|
||||
const smartlogOra = new SmartlogSourceOra();
|
||||
```
|
||||
|
||||
### Displaying Text with the Spinner
|
||||
|
||||
Once you have your `SmartlogSourceOra` instance, you can start displaying messages with an accompanying spinner. This is particularly useful when you want to inform the user about the current status of operations.
|
||||
|
||||
```typescript
|
||||
smartlogOra.text('Loading resources...');
|
||||
```
|
||||
|
||||
### Manipulating the Spinner State
|
||||
|
||||
`@push.rocks/smartlog-source-ora` allows you to control the spinner state by stopping it, marking it as successful, or indicating failure. Each method allows for an optional text message to be displayed.
|
||||
|
||||
#### Stopping the Spinner
|
||||
|
||||
```typescript
|
||||
smartlogOra.stop();
|
||||
```
|
||||
|
||||
#### Indicating Success
|
||||
|
||||
To indicate that the operation was successful, you can use the `finishSuccess()` method. Optionally, you can pass a message to be displayed alongside the success indication.
|
||||
|
||||
```typescript
|
||||
smartlogOra.finishSuccess('Resources loaded successfully.');
|
||||
```
|
||||
|
||||
#### Indicating Failure
|
||||
|
||||
Similarly, if an operation fails, you can use the `finishFail()` method to display a failure message.
|
||||
|
||||
```typescript
|
||||
smartlogOra.finishFail('Failed to load resources.');
|
||||
```
|
||||
|
||||
### Success/Failure and Moving to the Next Operation
|
||||
|
||||
`@push.rocks/smartlog-source-ora` also provides convenient methods to indicate the success or failure of an operation and immediately moves on to the text of the next operation.
|
||||
|
||||
```typescript
|
||||
// Indicating success and moving on
|
||||
smartlogOra.successAndNext('Resources loaded. Initializing...');
|
||||
|
||||
// Indicating failure and moving on
|
||||
smartlogOra.failAndNext('Failed to load resources. Retrying...');
|
||||
```
|
||||
|
||||
### Integrating with `smartlogInterfaces`
|
||||
|
||||
This module is designed to integrate seamlessly with `smartlogInterfaces`, allowing for a unified logging solution across your project.
|
||||
|
||||
To achieve comprehensive logging and progress indication, consider extending `SmartlogSourceOra` with functionality to integrate logging levels and message types according to `smartlogInterfaces`. This ensures a coherent user experience where log messages and progress indicators work hand in hand.
|
||||
|
||||
### Complete Example
|
||||
|
||||
Below is a concise example that brings together all the above elements, demonstrating how `@push.rocks/smartlog-source-ora` can be used in a real-world scenario:
|
||||
|
||||
```typescript
|
||||
import { SmartlogSourceOra } from '@push.rocks/smartlog-source-ora';
|
||||
|
||||
async function performOperations() {
|
||||
const smartlogOra = new SmartlogSourceOra();
|
||||
|
||||
try {
|
||||
smartlogOra.text('Starting operation 1...');
|
||||
// simulate operation
|
||||
await new Promise(resolve => setTimeout(resolve, 2000));
|
||||
smartlogOra.finishSuccess('Operation 1 completed.');
|
||||
|
||||
smartlogOra.text('Starting operation 2...');
|
||||
// simulate operation
|
||||
await new Promise((resolve, reject) => setTimeout(reject, 2000));
|
||||
} catch (error) {
|
||||
smartlogOra.finishFail('Operation 2 failed. Check logs for details.');
|
||||
}
|
||||
}
|
||||
|
||||
performOperations();
|
||||
```
|
||||
|
||||
In this example, `performOperations()` makes use of the `@push.rocks/smartlog-source-ora` module to provide real-time feedback to the user about the operations being performed. It demonstrates how to indicate the beginning of an operation, success completion, and handling failures, offering a comprehensive user experience.
|
||||
|
||||
### Conclusion
|
||||
|
||||
The integration of `@push.rocks/smartlog-source-ora` into your application not only improves the visual feedback during operations but also contributes to a better user experience by clearly communicating the state of operations in real time. Whether you're building CLI tools or applications that require status updates, `@push.rocks/smartlog-source-ora` provides a straightforward and elegant solution.
|
||||
|
||||
For any further assistance or more advanced use cases, you may delve into the source code and explore additional features that may suit your specific needs. Happy coding!
|
||||
|
||||
## 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.
|
||||
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
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"
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user