Compare commits
No commits in common. "master" and "v3.0.9" 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
|
||||
137
.gitlab-ci.yml
Normal file
137
.gitlab-ci.yml
Normal file
@ -0,0 +1,137 @@
|
||||
# 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
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
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
|
||||
|
||||
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 tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
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:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
4
.snyk
Normal file
4
.snyk
Normal file
@ -0,0 +1,4 @@
|
||||
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
|
||||
version: v1.12.0
|
||||
ignore: {}
|
||||
patch: {}
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,10 +2,28 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"type": "node-terminal"
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
57
changelog.md
57
changelog.md
@ -1,57 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
## 2024-11-06 - 5.1.2 - fix(appdata)
|
||||
Fix iteration over overwriteObject in AppData class
|
||||
|
||||
- Corrected the for loop from in to of inside the AppData class for iterating over overwriteObject keys.
|
||||
|
||||
## 2024-11-05 - 5.1.1 - fix(AppData)
|
||||
Fix issue with overwrite object handling in AppData class
|
||||
|
||||
- Corrected logic to handle cases when overwriteObject is undefined.
|
||||
|
||||
## 2024-11-05 - 5.1.0 - feat(appdata)
|
||||
Add support for overwriting keys using the overwriteObject option in AppData
|
||||
|
||||
- Introduced the overwriteObject option in IAppDataOptions to allow overwriting specific keys in the AppData class.
|
||||
|
||||
## 2024-06-19 - 5.0.17 - 5.0.23 - Core Updates
|
||||
Routine maintenance and updates to the core components.
|
||||
|
||||
- Multiple core updates and fixes improving stability
|
||||
|
||||
## 2024-06-12 - 5.0.13 - 5.0.16 - Core Updates
|
||||
Maintenance focus on core systems with enhancements and problem resolutions.
|
||||
|
||||
- Enhancements and updates in the core functionality
|
||||
|
||||
## 2024-05-29 - 5.0.13 - Documentation Update
|
||||
Descriptive improvements aligned with current features.
|
||||
|
||||
- Updated core description for better clarity in documentation
|
||||
|
||||
## 2024-04-01 - 5.0.10 - Configuration Update
|
||||
Improved configuration management for build processes.
|
||||
|
||||
- Updated `npmextra.json` to reflect changes in git repository management
|
||||
|
||||
## 2024-02-12 - 5.0.0 - 5.0.9 - Major Core Enhancements
|
||||
A series of critical updates with resolved issues in the core components.
|
||||
|
||||
- Introduction of new core features
|
||||
- Several core system updates
|
||||
|
||||
## 2024-02-12 - 4.0.16 - Major Version Transition
|
||||
Migration to the new major version with impactful changes.
|
||||
|
||||
- BREAKING CHANGE: Significant updates requiring attention for smooth transition
|
||||
|
||||
## 2023-08-24 - 3.0.9 - 4.0.16 - Organization Updates
|
||||
Formatted updates with attention to organizational standards and practice.
|
||||
|
||||
- SWITCH to a new organizational scheme
|
||||
|
||||
## 2023-07-11 - 3.0.9 - Organizational Enhancement
|
||||
Shifts aligning with contemporary structuring and logistics.
|
||||
|
||||
- Strategic realignment with organizational principles
|
||||
@ -11,32 +11,12 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "npmextra",
|
||||
"description": "A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.",
|
||||
"npmPackagename": "@push.rocks/npmextra",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"npm",
|
||||
"configuration management",
|
||||
"tool management",
|
||||
"key-value store",
|
||||
"project setup",
|
||||
"typescript",
|
||||
"environment setup",
|
||||
"dependencies management",
|
||||
"npm package enhancement",
|
||||
"automation",
|
||||
"async operations",
|
||||
"app configuration",
|
||||
"smart file handling",
|
||||
"workflow improvement",
|
||||
"persistent storage"
|
||||
]
|
||||
"shortDescription": "do more with npm",
|
||||
"npmPackagename": "@pushrocks/npmextra",
|
||||
"license": "MIT"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
11075
package-lock.json
generated
Normal file
11075
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
57
package.json
57
package.json
@ -1,42 +1,39 @@
|
||||
{
|
||||
"name": "@push.rocks/npmextra",
|
||||
"version": "5.1.2",
|
||||
"name": "@pushrocks/npmextra",
|
||||
"version": "3.0.9",
|
||||
"private": false,
|
||||
"description": "A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.",
|
||||
"description": "do more with npm",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"build": "(tsbuild --web --allowimplicitany)",
|
||||
"buildDocs": "tsdoc"
|
||||
"build": "(tsbuild --web)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/npmextra.git"
|
||||
"url": "git+ssh://git@gitlab.com/pushrocks/npmextra.git"
|
||||
},
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/npmextra/issues"
|
||||
},
|
||||
"homepage": "https://code.foss.global/push.rocks/npmextra",
|
||||
"homepage": "https://gitlab.com/pushrocks/npmextra#README",
|
||||
"dependencies": {
|
||||
"@push.rocks/qenv": "^6.0.5",
|
||||
"@push.rocks/smartfile": "^11.0.20",
|
||||
"@push.rocks/smartjson": "^5.0.20",
|
||||
"@push.rocks/smartlog": "^3.0.7",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@push.rocks/taskbuffer": "^3.1.7",
|
||||
"@tsclass/tsclass": "^4.0.59"
|
||||
"@pushrocks/smartfile": "^8.0.8",
|
||||
"@pushrocks/smartlog": "^2.0.39",
|
||||
"@pushrocks/smartpath": "^4.0.3",
|
||||
"@pushrocks/smartpromise": "^3.1.3",
|
||||
"@pushrocks/taskbuffer": "^2.1.13"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.80",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.90",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.14.5"
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsrun": "^1.2.12",
|
||||
"@gitzone/tstest": "^1.0.52",
|
||||
"@pushrocks/tapbundle": "^3.2.10",
|
||||
"@types/node": "^14.14.22",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -52,23 +49,5 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
],
|
||||
"type": "module",
|
||||
"keywords": [
|
||||
"npm",
|
||||
"configuration management",
|
||||
"tool management",
|
||||
"key-value store",
|
||||
"project setup",
|
||||
"typescript",
|
||||
"environment setup",
|
||||
"dependencies management",
|
||||
"npm package enhancement",
|
||||
"automation",
|
||||
"async operations",
|
||||
"app configuration",
|
||||
"smart file handling",
|
||||
"workflow improvement",
|
||||
"persistent storage"
|
||||
]
|
||||
}
|
||||
|
||||
6757
pnpm-lock.yaml
generated
6757
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
326
readme.md
326
readme.md
@ -1,311 +1,73 @@
|
||||
# @push.rocks/npmextra
|
||||
A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.
|
||||
# @pushrocks/npmextra
|
||||
do more with npm
|
||||
|
||||
## Install
|
||||
To install `@push.rocks/npmextra`, use the following npm command:
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/npmextra)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/npmextra)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/npmextra)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/npmextra/)
|
||||
|
||||
```bash
|
||||
npm install @push.rocks/npmextra --save
|
||||
```
|
||||
## Status for master
|
||||
|
||||
This package is available on [npm](https://www.npmjs.com/package/@push.rocks/npmextra) and can be installed into your project as a dependency to enhance npm with additional configuration and tool management capabilities.
|
||||
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)
|
||||
|
||||
## Usage
|
||||
`@push.rocks/npmextra` is designed to supplement npm functionalities with enhanced configuration and tool management. It facilitates the management of project configurations and tool setups in a consolidated manner, enabling a smoother workflow and maintenance process. Below are detailed use cases and examples implemented with ESM syntax and TypeScript.
|
||||
|
||||
### Initial Setup and Configuration
|
||||
To start using `npmextra` in your project, first include it with an import statement:
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
```typescript
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
```
|
||||
## Using npmextra for managing toolconfigs
|
||||
|
||||
Instantiate the `Npmextra` class optionally with a custom path to your project's working directory. If no path is provided, the current working directory (`process.cwd()`) is used.
|
||||
The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.
|
||||
|
||||
```typescript
|
||||
const npmExtraInstance = new Npmextra('/path/to/your/project');
|
||||
```
|
||||
|
||||
### Managing Tool Configurations with `npmextra.json`
|
||||
`@push.rocks/npmextra` excels in unifying tool configurations through a single `npmextra.json` file. Instead of scattering configurations across multiple files, `npmextra` enables you to define tool-specific settings within this centralized configuration file, which can then be accessed programmatically.
|
||||
|
||||
#### Creating and Utilizing `npmextra.json`
|
||||
|
||||
Create a `npmextra.json` in your project root with the following structure:
|
||||
npmextra.json
|
||||
|
||||
```json
|
||||
{
|
||||
"toolname": {
|
||||
"setting1": "value1",
|
||||
"setting2": "value2"
|
||||
"sometool": {
|
||||
"defaultKey1": "awesomeValueFromConfig"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For example, to configure a hypothetical tool named `toolname`, define its settings as shown above.
|
||||
|
||||
#### Accessing Configuration in Your Project
|
||||
|
||||
With the configuration defined, you can easily access these settings in your TypeScript code as follows:
|
||||
|
||||
```typescript
|
||||
// Import the npmextra module
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
import { Npmextra } from 'npmextra';
|
||||
|
||||
// Create an instance pointing at the current directory
|
||||
const npmExtraInstance = new Npmextra();
|
||||
|
||||
// Retrieve the configuration for 'toolname', merging defaults with any found in npmextra.json
|
||||
const toolConfig = npmExtraInstance.dataFor<{ setting1: string, setting2: string }>('toolname', {
|
||||
setting1: 'defaultValue1',
|
||||
setting2: 'defaultValue2'
|
||||
});
|
||||
|
||||
// toolConfig now contains the merged settings from npmextra.json and provided defaults
|
||||
console.log(toolConfig);
|
||||
```
|
||||
|
||||
### Key-Value Store Management
|
||||
`@push.rocks/npmextra` also includes a Key-Value Store (KeyValueStore) functionality enabling persistent storage of key-value pairs between script executions.
|
||||
|
||||
#### Setting Up KeyValueStore
|
||||
|
||||
To utilize the KeyValueStore, create an instance specifying its scope (e.g., 'userHomeDir') and a unique identity for your application or tool:
|
||||
|
||||
```typescript
|
||||
import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
|
||||
const kvStore = new KeyValueStore<'userHomeDir'>({
|
||||
typeArg: 'userHomeDir',
|
||||
identityArg: 'myUniqueAppName'
|
||||
let myNpmExtra = new Npmextra('my/path/to/cwd'); // cwd argument is optional
|
||||
mergedData = myNpmExtra.dataFor('sometool', {
|
||||
// gets merged with whatever is in the configfile
|
||||
defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
|
||||
defaultKey2: 'defaultValue2', // this one will pass through unaltered
|
||||
});
|
||||
```
|
||||
|
||||
You can then use the `writeKey`, `readKey`, `writeAll`, and `readAll` methods to manage your store respectively.
|
||||
### Tools that already use the config feature of npmextra
|
||||
|
||||
#### Example: Storing and Retrieving Data
|
||||
- [npmts](https://www.npmjs.com/package/npmts)
|
||||
- [npmci](https://www.npmjs.com/package/npmci)
|
||||
- [npmdocker](https://www.npmjs.com/package/npmdocker)
|
||||
|
||||
```typescript
|
||||
// Write a single key-value pair
|
||||
await kvStore.writeKey('username', 'johnDoe');
|
||||
## Using the KeyValueStore
|
||||
|
||||
// Read a single key
|
||||
const username = await kvStore.readKey('username');
|
||||
console.log(username); // Outputs: johnDoe
|
||||
|
||||
// Write multiple key-value pairs
|
||||
await kvStore.writeAll({
|
||||
email: 'john@example.com',
|
||||
isAdmin: true
|
||||
});
|
||||
## Contribution
|
||||
|
||||
// Read all key-value pairs
|
||||
const allData = await kvStore.readAll();
|
||||
console.log(allData); // Outputs the entire store's contents
|
||||
```
|
||||
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). :)
|
||||
|
||||
### Advanced Key-Value Store Management
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
In addition to basic read/write operations, `npmextra`’s `KeyValueStore` supports advanced scenarios like mandatory keys and custom file paths.
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
#### Example: Mandatory Keys and Custom Paths
|
||||
|
||||
Consider a scenario where your application requires specific keys to be present in the KeyValueStore. You can define mandatory keys and use a custom path for your store like this:
|
||||
|
||||
```typescript
|
||||
import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
|
||||
interface CustomData {
|
||||
key1: string;
|
||||
key2: number;
|
||||
key3?: boolean;
|
||||
}
|
||||
|
||||
const kvStore = new KeyValueStore<CustomData>({
|
||||
typeArg: 'custom',
|
||||
identityArg: 'customApp',
|
||||
customPath: '/custom/path/to/store.json',
|
||||
mandatoryKeys: ['key1', 'key2']
|
||||
});
|
||||
|
||||
// Ensure all mandatory keys are present
|
||||
const missingKeys = await kvStore.getMissingMandatoryKeys();
|
||||
if (missingKeys.length) {
|
||||
console.log(`Missing mandatory keys: ${missingKeys.join(', ')}`);
|
||||
}
|
||||
|
||||
// Use the KeyValueStore
|
||||
await kvStore.writeKey('key1', 'value1');
|
||||
await kvStore.writeKey('key2', 123);
|
||||
|
||||
const key1Value = await kvStore.readKey('key1');
|
||||
const allData = await kvStore.readAll();
|
||||
|
||||
console.log(key1Value); // Outputs: value1
|
||||
console.log(allData); // Outputs: { key1: 'value1', key2: 123 }
|
||||
```
|
||||
|
||||
### Combining AppData and KeyValueStore
|
||||
|
||||
The `AppData` class extends the functionality of `KeyValueStore` by integrating environmental variables, specifying additional configurations, and providing a more structured approach to data management.
|
||||
|
||||
#### Example: AppData Usage
|
||||
|
||||
```typescript
|
||||
import { AppData } from '@push.rocks/npmextra';
|
||||
|
||||
interface AppSettings {
|
||||
settingA: string;
|
||||
settingB: number;
|
||||
nestedSetting: {
|
||||
innerSetting: boolean;
|
||||
}
|
||||
}
|
||||
|
||||
const appDataInstance = await AppData.createAndInit<AppSettings>({
|
||||
dirPath: '/custom/path/to/appdata',
|
||||
requiredKeys: ['settingA', 'settingB'],
|
||||
envMapping: {
|
||||
settingA: 'MY_ENV_A',
|
||||
settingB: 'hard:42',
|
||||
nestedSetting: {
|
||||
innerSetting: 'MY_ENV_INNER'
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const appDataKvStore = await appDataInstance.getKvStore();
|
||||
|
||||
// Writing values
|
||||
await appDataKvStore.writeKey('settingA', 'exampleValue');
|
||||
await appDataKvStore.writeKey('settingB', 100);
|
||||
await appDataKvStore.writeKey('nestedSetting', { innerSetting: true });
|
||||
|
||||
// Reading values
|
||||
const settingA = await appDataKvStore.readKey('settingA');
|
||||
const allSettings = await appDataKvStore.readAll();
|
||||
|
||||
console.log(settingA); // Outputs: 'exampleValue'
|
||||
console.log(allSettings); // Outputs: { settingA: 'exampleValue', settingB: 100, nestedSetting: { innerSetting: true } }
|
||||
```
|
||||
|
||||
### Error Handling and Debugging
|
||||
|
||||
Proper error handling ensures your integrations with `npmextra` are robust and stable. Below are some strategies for error handling and debugging potential issues.
|
||||
|
||||
#### Example: Error Handling in KeyValueStore
|
||||
|
||||
```typescript
|
||||
import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
|
||||
const kvStore = new KeyValueStore('userHomeDir', 'errorHandlingApp');
|
||||
|
||||
try {
|
||||
await kvStore.writeKey('importantKey', 'importantValue');
|
||||
const value = await kvStore.readKey('importantKey');
|
||||
console.log(value); // Outputs: importantValue
|
||||
} catch (error) {
|
||||
console.error('Error managing key-value store:', error);
|
||||
}
|
||||
```
|
||||
|
||||
#### Debugging Configuration Issues in `npmextra.json`
|
||||
|
||||
To debug configuration issues, you can utilize conditional logging and checks:
|
||||
|
||||
```typescript
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
|
||||
const npmExtraInstance = new Npmextra();
|
||||
const toolConfig = npmExtraInstance.dataFor('toolname', {
|
||||
configKey1: 'defaultValue1',
|
||||
configKey2: 'defaultValue2'
|
||||
});
|
||||
|
||||
if (!toolConfig.configKey1) {
|
||||
console.error('configKey1 is missing in npmextra.json');
|
||||
}
|
||||
|
||||
console.log(toolConfig);
|
||||
```
|
||||
|
||||
### Integration Tests
|
||||
|
||||
Writing tests ensures that your integration with `npmextra` works as expected. Below are examples of integration tests for both `Npmextra` and `KeyValueStore`.
|
||||
|
||||
#### Example: Testing `Npmextra` Class
|
||||
|
||||
```typescript
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
|
||||
let npmExtraInstance: Npmextra;
|
||||
|
||||
tap.test('should create an instance of Npmextra', async () => {
|
||||
npmExtraInstance = new Npmextra();
|
||||
expect(npmExtraInstance).toBeInstanceOf(Npmextra);
|
||||
});
|
||||
|
||||
tap.test('should load configuration from npmextra.json', async () => {
|
||||
const config = npmExtraInstance.dataFor('toolname', {
|
||||
defaultKey1: 'defaultValue1',
|
||||
});
|
||||
expect(config).toHaveProperty('defaultKey1');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
```
|
||||
|
||||
#### Example: Testing `KeyValueStore` Class
|
||||
|
||||
```typescript
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
|
||||
let kvStore: KeyValueStore<{ key1: string, key2: number }>;
|
||||
|
||||
tap.test('should create a KeyValueStore instance', async () => {
|
||||
kvStore = new KeyValueStore({
|
||||
typeArg: 'userHomeDir',
|
||||
identityArg: 'testApp'
|
||||
});
|
||||
expect(kvStore).toBeInstanceOf(KeyValueStore);
|
||||
});
|
||||
|
||||
tap.test('should write and read back a value', async () => {
|
||||
await kvStore.writeKey('key1', 'value1');
|
||||
const result = await kvStore.readKey('key1');
|
||||
expect(result).toEqual('value1');
|
||||
});
|
||||
|
||||
tap.test('should write and read back multiple values', async () => {
|
||||
await kvStore.writeAll({ key1: 'updatedValue1', key2: 2 });
|
||||
const result = await kvStore.readAll();
|
||||
expect(result).toEqual({ key1: 'updatedValue1', key2: 2 });
|
||||
});
|
||||
|
||||
tap.start();
|
||||
```
|
||||
|
||||
### Summary
|
||||
|
||||
By centralizing configuration management and offering a versatile key-value store, `@push.rocks/npmextra` significantly simplifies the setup and management of tools and settings in modern JavaScript and TypeScript projects. Whether you're managing project-wide configurations or need persistent storage for key-value pairs, `npmextra` provides an efficient and streamlined solution. Leveraging these robust features will ensure your project is well-configured and maintainable.
|
||||
|
||||
## 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.
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
{
|
||||
"myKey": "myValue"
|
||||
}
|
||||
@ -1,27 +0,0 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import path = require('path');
|
||||
|
||||
// module to test
|
||||
import * as npmextra from '../ts/index.js';
|
||||
|
||||
interface ITestOptions {
|
||||
hi: string;
|
||||
deep: {
|
||||
deep1: string;
|
||||
deep2: string;
|
||||
};
|
||||
}
|
||||
|
||||
let testAppdata: npmextra.AppData<ITestOptions>;
|
||||
|
||||
tap.test('should create a valid AppData', async () => {
|
||||
testAppdata = new npmextra.AppData<ITestOptions>({
|
||||
envMapping: {
|
||||
deep: {
|
||||
deep1: '',
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@ -1,32 +1,25 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
import * as npmextra from '../ts/index.js';
|
||||
import * as npmextra from '../ts/index';
|
||||
|
||||
let myKeyValueStore: npmextra.KeyValueStore<any>;
|
||||
let myKeyValueStore: npmextra.KeyValueStore;
|
||||
|
||||
tap.test('should create a keyValueStore', async () => {
|
||||
myKeyValueStore = new npmextra.KeyValueStore<any>({
|
||||
typeArg: 'custom',
|
||||
identityArg: 'test',
|
||||
customPath: 'test/somekv.json',
|
||||
});
|
||||
expect(myKeyValueStore).toBeInstanceOf(npmextra.KeyValueStore);
|
||||
});
|
||||
|
||||
tap.test('should reset the keyValueStore', async () => {
|
||||
await myKeyValueStore.reset();
|
||||
myKeyValueStore = new npmextra.KeyValueStore('custom', 'test');
|
||||
expect(myKeyValueStore).to.be.instanceof(npmextra.KeyValueStore);
|
||||
});
|
||||
|
||||
tap.test('expect result to be empty', async () => {
|
||||
let result = await myKeyValueStore.readAll();
|
||||
expect(JSON.stringify(result)).toEqual('{}');
|
||||
let result = myKeyValueStore.readAll();
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(result).to.be.empty;
|
||||
});
|
||||
|
||||
tap.test('expect to add an object to the kv Store', async () => {
|
||||
await myKeyValueStore.writeAll({
|
||||
myKey: 'myValue',
|
||||
});
|
||||
await expect(await myKeyValueStore.readKey('myKey')).toEqual('myValue');
|
||||
await expect(myKeyValueStore.readKey('myKey')).to.eventually.equal('myValue');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
18
test/test.ts
18
test/test.ts
@ -1,33 +1,33 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import path = require('path');
|
||||
|
||||
// module to test
|
||||
import * as npmextra from '../ts/index.js';
|
||||
import npmExtra = require('../ts/index');
|
||||
|
||||
let testNpmextra: npmextra.Npmextra;
|
||||
let testNpmextra: npmExtra.Npmextra;
|
||||
|
||||
tap.test('should create a new Npmtextra instance', async () => {
|
||||
testNpmextra = new npmextra.Npmextra('./test/');
|
||||
expect(testNpmextra).toBeInstanceOf(npmextra.Npmextra);
|
||||
testNpmextra = new npmExtra.Npmextra('./test/');
|
||||
expect(testNpmextra).be.instanceof(npmExtra.Npmextra);
|
||||
});
|
||||
|
||||
tap.test('should state wether a npmextra.json exists', async () => {
|
||||
// tslint:disable-next-line:no-unused-expression
|
||||
expect(testNpmextra.npmextraJsonExists).toBeTrue();
|
||||
expect(testNpmextra.npmextraJsonExists).be.true;
|
||||
});
|
||||
|
||||
tap.test('should pass through default value, if not overriden by config from file', async () => {
|
||||
let testData = testNpmextra.dataFor('testTool', { someKey2: 'someValue2' });
|
||||
console.log(testData);
|
||||
expect(testData).toHaveProperty('someKey2');
|
||||
expect(testData).have.ownProperty('someKey2');
|
||||
});
|
||||
|
||||
tap.test('should read a config file', async () => {
|
||||
let testData = testNpmextra.dataFor<any>('testTool', {
|
||||
someKey2: 'someValue2',
|
||||
});
|
||||
expect(testData).toHaveProperty('someKey2');
|
||||
expect(testData.testValue).toEqual(2);
|
||||
expect(testData).have.ownProperty('someKey2');
|
||||
expect(testData.testValue).equal(2);
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/npmextra',
|
||||
version: '5.1.2',
|
||||
description: 'A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.'
|
||||
}
|
||||
@ -1,3 +1,4 @@
|
||||
export * from './npmextra.classes.appdata.js';
|
||||
export * from './npmextra.classes.keyvaluestore.js';
|
||||
export * from './npmextra.classes.npmextra.js';
|
||||
import * as plugins from './npmextra.plugins';
|
||||
|
||||
export * from './npmextra.classes.npmextra';
|
||||
export * from './npmextra.classes.keyvaluestore';
|
||||
|
||||
@ -1,219 +0,0 @@
|
||||
import * as plugins from './npmextra.plugins.js';
|
||||
import * as paths from './npmextra.paths.js';
|
||||
import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
|
||||
|
||||
export interface IAppDataOptions<T = any> {
|
||||
dirPath?: string;
|
||||
requiredKeys?: Array<keyof T>;
|
||||
|
||||
/**
|
||||
* wether keys should be persisted on disk or not
|
||||
*/
|
||||
ephermal?: boolean;
|
||||
|
||||
/**
|
||||
* kvStoreKey: 'MY_ENV_VAR'
|
||||
*/
|
||||
envMapping?: plugins.tsclass.typeFest.PartialDeep<T>;
|
||||
overwriteObject?: plugins.tsclass.typeFest.PartialDeep<T>;
|
||||
}
|
||||
|
||||
export class AppData<T = any> {
|
||||
/**
|
||||
* creates appdata. If no pathArg is given, data will be stored here:
|
||||
* ${PWD}/.nogit/appdata
|
||||
* @param pathArg
|
||||
* @returns
|
||||
*/
|
||||
public static async createAndInit<T = any>(
|
||||
optionsArg: IAppDataOptions<T> = {}
|
||||
): Promise<AppData<T>> {
|
||||
const appData = new AppData<T>(optionsArg);
|
||||
await appData.readyDeferred.promise;
|
||||
return appData;
|
||||
}
|
||||
|
||||
// instance
|
||||
public readyDeferred = plugins.smartpromise.defer<void>();
|
||||
public options: IAppDataOptions<T>;
|
||||
private kvStore: KeyValueStore<T>;
|
||||
|
||||
constructor(optionsArg: IAppDataOptions<T> = {}) {
|
||||
this.options = optionsArg;
|
||||
this.init();
|
||||
}
|
||||
|
||||
/**
|
||||
* inits app data
|
||||
* @param pathArg
|
||||
*/
|
||||
private async init(pathArg?: string) {
|
||||
if (this.options.dirPath || this.options.ephermal) {
|
||||
// ok, nothing to do here;
|
||||
} else {
|
||||
const appDataDir = '/app/data';
|
||||
const dataDir = '/data';
|
||||
const nogitAppData = '.nogit/appdata';
|
||||
const appDataExists = plugins.smartfile.fs.isDirectory(appDataDir);
|
||||
const dataExists = plugins.smartfile.fs.isDirectory(dataDir);
|
||||
if (appDataExists) {
|
||||
this.options.dirPath = appDataDir;
|
||||
} else if (dataExists) {
|
||||
this.options.dirPath = dataDir;
|
||||
} else {
|
||||
await plugins.smartfile.fs.ensureDir(nogitAppData);
|
||||
this.options.dirPath = nogitAppData;
|
||||
}
|
||||
}
|
||||
|
||||
this.kvStore = new KeyValueStore<T>({
|
||||
typeArg: this.options.ephermal ? 'ephemeral' : 'custom',
|
||||
identityArg: 'appkv',
|
||||
customPath: this.options.dirPath,
|
||||
mandatoryKeys: this.options.requiredKeys as Array<keyof T>,
|
||||
});
|
||||
|
||||
if (this.options.envMapping) {
|
||||
const qenvInstance = new plugins.qenv.Qenv(
|
||||
process.cwd(),
|
||||
plugins.path.join(process.cwd(), '.nogit')
|
||||
);
|
||||
|
||||
// Recursive function to handle nested objects, now includes key parameter
|
||||
const processEnvMapping = async (
|
||||
key: keyof T,
|
||||
mappingValue: any,
|
||||
parentKey: keyof T | '' = ''
|
||||
): Promise<any> => {
|
||||
if (typeof mappingValue === 'string') {
|
||||
let envValue: string | boolean | T[keyof T];
|
||||
let convert: 'none' | 'json' | 'base64' | 'boolean' = 'none';
|
||||
switch (true) {
|
||||
case mappingValue.startsWith('hard:'):
|
||||
envValue = mappingValue.replace('hard:', '') as T[keyof T];
|
||||
break;
|
||||
case mappingValue.startsWith('hard_boolean:'):
|
||||
envValue = mappingValue.replace('hard_boolean:', '') === 'true';
|
||||
convert = 'boolean';
|
||||
break;
|
||||
case mappingValue.startsWith('hard_json:'):
|
||||
envValue = JSON.parse(mappingValue.replace('hard_json:', '')) as T[keyof T];
|
||||
convert = 'json';
|
||||
break;
|
||||
case mappingValue.startsWith('hard_base64:'):
|
||||
envValue = Buffer.from(
|
||||
mappingValue.replace('hard_base64:', ''),
|
||||
'base64'
|
||||
).toString() as T[keyof T];
|
||||
convert = 'base64';
|
||||
break;
|
||||
case mappingValue.startsWith('boolean:'):
|
||||
envValue = (await qenvInstance.getEnvVarOnDemand(
|
||||
mappingValue.replace('boolean:', '')
|
||||
)) as T[keyof T];
|
||||
convert = 'boolean';
|
||||
break;
|
||||
case mappingValue.startsWith('json:'):
|
||||
envValue = (await qenvInstance.getEnvVarOnDemand(
|
||||
mappingValue.replace('json:', '')
|
||||
)) as T[keyof T];
|
||||
convert = 'json';
|
||||
break;
|
||||
case mappingValue.startsWith('base64:'):
|
||||
envValue = (await qenvInstance.getEnvVarOnDemand(
|
||||
mappingValue.replace('base64:', '')
|
||||
)) as T[keyof T];
|
||||
convert = 'base64';
|
||||
break;
|
||||
default:
|
||||
envValue = (await qenvInstance.getEnvVarOnDemand(mappingValue)) as T[keyof T];
|
||||
break;
|
||||
}
|
||||
|
||||
// lets format the env value
|
||||
if (envValue) {
|
||||
if (typeof envValue === 'string' && convert === 'boolean') {
|
||||
envValue = envValue === 'true';
|
||||
}
|
||||
if (
|
||||
typeof envValue === 'string' &&
|
||||
(mappingValue.endsWith('_JSON') || convert === 'json')
|
||||
) {
|
||||
envValue = JSON.parse(envValue as string) as T[keyof T];
|
||||
}
|
||||
if (
|
||||
typeof envValue === 'string' &&
|
||||
(mappingValue.endsWith('_BASE64') || convert === 'base64')
|
||||
) {
|
||||
envValue = Buffer.from(envValue as string, 'base64').toString();
|
||||
}
|
||||
if (!parentKey) {
|
||||
await this.kvStore.writeKey(key, envValue as any);
|
||||
} else {
|
||||
return envValue;
|
||||
}
|
||||
} else {
|
||||
return undefined;
|
||||
}
|
||||
} else if (typeof mappingValue === 'object' && mappingValue !== null) {
|
||||
const resultObject: Partial<T> = {};
|
||||
for (const innerKey in mappingValue) {
|
||||
const nestedValue = mappingValue[innerKey];
|
||||
// For nested objects, call recursively but do not immediately write to kvStore
|
||||
const nestedResult = await processEnvMapping(innerKey as keyof T, nestedValue, key);
|
||||
resultObject[innerKey as keyof T] = nestedResult;
|
||||
}
|
||||
if (parentKey === '') {
|
||||
// Only write to kvStore if at the top level
|
||||
await this.kvStore.writeKey(key, resultObject as T[keyof T]);
|
||||
} else {
|
||||
// For nested objects, return the constructed object instead of writing to kvStore
|
||||
return resultObject;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
for (const key in this.options.envMapping) {
|
||||
await processEnvMapping(key as keyof T, this.options.envMapping[key]);
|
||||
}
|
||||
|
||||
if (this.options.overwriteObject) {
|
||||
for (const key of Object.keys(this.options.overwriteObject)) {
|
||||
console.log(`-> heads up: overwriting key ${key} from options.overwriteObject`);
|
||||
await this.kvStore.writeKey(key as keyof T, this.options.overwriteObject[key]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
this.readyDeferred.resolve();
|
||||
}
|
||||
|
||||
/**
|
||||
* returns a kvstore that resides in appdata
|
||||
*/
|
||||
public async getKvStore(): Promise<KeyValueStore<T>> {
|
||||
await this.readyDeferred.promise;
|
||||
return this.kvStore;
|
||||
}
|
||||
|
||||
public async logMissingKeys(): Promise<Array<keyof T>> {
|
||||
const kvStore = await this.getKvStore();
|
||||
const missingMandatoryKeys = await kvStore.getMissingMandatoryKeys();
|
||||
if (missingMandatoryKeys.length > 0) {
|
||||
console.log(
|
||||
`The following mandatory keys are missing in the appdata:\n -> ${missingMandatoryKeys.join(
|
||||
',\n -> '
|
||||
)}`
|
||||
);
|
||||
} else {
|
||||
console.log('All mandatory keys are present in the appdata');
|
||||
}
|
||||
return missingMandatoryKeys;
|
||||
}
|
||||
|
||||
public async waitForAndGetKey<K extends keyof T>(keyArg: K): Promise<T[K] | undefined> {
|
||||
await this.readyDeferred.promise;
|
||||
await this.kvStore.waitForKeysPresent([keyArg]);
|
||||
return this.kvStore.readKey(keyArg);
|
||||
}
|
||||
}
|
||||
@ -1,119 +1,73 @@
|
||||
import * as plugins from './npmextra.plugins.js';
|
||||
import * as paths from './npmextra.paths.js';
|
||||
import * as plugins from './npmextra.plugins';
|
||||
import * as paths from './npmextra.paths';
|
||||
|
||||
import { Task } from '@push.rocks/taskbuffer';
|
||||
import { Task } from '@pushrocks/taskbuffer';
|
||||
|
||||
export type TKeyValueStore = 'custom' | 'userHomeDir' | 'ephemeral';
|
||||
|
||||
export interface IKvStoreConstructorOptions<T> {
|
||||
typeArg: TKeyValueStore;
|
||||
identityArg: string;
|
||||
customPath?: string;
|
||||
mandatoryKeys?: Array<keyof T>;
|
||||
}
|
||||
export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
|
||||
|
||||
/**
|
||||
* kvStore is a simple key value store to store data about projects between runs
|
||||
* kvStore is a simple key vlaue store to store data about projects between runs
|
||||
*/
|
||||
export class KeyValueStore<T = any> {
|
||||
private dataObject: Partial<T> = {};
|
||||
private deletedObject: Partial<T> = {};
|
||||
private mandatoryKeys: Set<keyof T> = new Set();
|
||||
public changeSubject = new plugins.smartrx.rxjs.Subject<Partial<T>>();
|
||||
|
||||
private storedStateString: string = '';
|
||||
export class KeyValueStore {
|
||||
private dataObject: any = {};
|
||||
private deletedObject: any = {};
|
||||
public syncTask = new Task({
|
||||
name: 'syncTask',
|
||||
buffered: true,
|
||||
bufferMax: 1,
|
||||
execDelay: 0,
|
||||
taskFunction: async () => {
|
||||
if (this.type !== 'ephemeral') {
|
||||
this.dataObject = {
|
||||
...plugins.smartfile.fs.toObjectSync(this.filePath),
|
||||
...this.dataObject,
|
||||
};
|
||||
for (const key of Object.keys(this.deletedObject) as Array<keyof T>) {
|
||||
delete this.dataObject[key];
|
||||
}
|
||||
this.deletedObject = {};
|
||||
await plugins.smartfile.memory.toFs(
|
||||
plugins.smartjson.stringifyPretty(this.dataObject),
|
||||
this.filePath
|
||||
);
|
||||
}
|
||||
const newStateString = plugins.smartjson.stringify(this.dataObject);
|
||||
|
||||
// change detection
|
||||
if (newStateString !== this.storedStateString) {
|
||||
this.storedStateString = newStateString;
|
||||
this.changeSubject.next(this.dataObject);
|
||||
this.dataObject = {
|
||||
...plugins.smartfile.fs.toObjectSync(this.filePath),
|
||||
...this.dataObject,
|
||||
};
|
||||
for (const key of Object.keys(this.deletedObject)) {
|
||||
delete this.dataObject[key];
|
||||
}
|
||||
this.deletedObject = {};
|
||||
await plugins.smartfile.memory.toFs(JSON.stringify(this.dataObject), this.filePath);
|
||||
},
|
||||
});
|
||||
|
||||
/**
|
||||
* computes the identity and filePath
|
||||
* computes the identity
|
||||
*/
|
||||
private initFilePath = () => {
|
||||
if (this.type === 'ephemeral') {
|
||||
// No file path is needed for ephemeral type
|
||||
return;
|
||||
}
|
||||
if (this.customPath) {
|
||||
// Use custom path if provided
|
||||
const absolutePath = plugins.smartpath.transform.makeAbsolute(this.customPath, paths.cwd);
|
||||
this.filePath = absolutePath;
|
||||
if (plugins.smartfile.fs.isDirectorySync(this.filePath)) {
|
||||
this.filePath = plugins.path.join(this.filePath, this.identity + '.json');
|
||||
}
|
||||
plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
|
||||
return;
|
||||
}
|
||||
|
||||
// determine the right base directory
|
||||
let baseDir: string;
|
||||
if (this.type === 'userHomeDir') {
|
||||
baseDir = paths.kvUserHomeDirBase;
|
||||
} else {
|
||||
throw new Error('kv type not supported');
|
||||
if (this.type === 'custom') {
|
||||
baseDir = paths.kvCustomDir;
|
||||
} else if (this.type === 'gitProject') {
|
||||
baseDir = paths.kvGitDir;
|
||||
} else if (this.type === 'path') {
|
||||
baseDir = paths.kvPathDir;
|
||||
}
|
||||
this.filePath = plugins.path.join(baseDir, this.identity + '.json');
|
||||
plugins.smartfile.fs.ensureDirSync(baseDir);
|
||||
plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
|
||||
plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
|
||||
plugins.smartfile.fs.ensureDirSync(paths.kvPathDir);
|
||||
plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
|
||||
};
|
||||
|
||||
// if no custom path is provided, try to store at home directory
|
||||
public type: TKeyValueStore;
|
||||
public identity: string;
|
||||
public filePath?: string;
|
||||
private customPath?: string; // Optionally allow custom path
|
||||
public type: TKeyValueStore; // the type of the kvStore
|
||||
public identity: string; // the identity of the kvStore
|
||||
public filePath: string; // the filePath of the kvStore
|
||||
|
||||
/**
|
||||
* the constructor of keyvalue store
|
||||
* @param typeArg
|
||||
* @param identityArg
|
||||
* @param customPath Optional custom path for the keyValue store
|
||||
* @param customStringArg
|
||||
*/
|
||||
constructor(optionsArg: IKvStoreConstructorOptions<T>) {
|
||||
if (optionsArg.customPath && optionsArg.typeArg !== 'custom') {
|
||||
throw new Error('customPath can only be provided if typeArg is custom');
|
||||
}
|
||||
if (optionsArg.typeArg === 'custom' && !optionsArg.customPath) {
|
||||
throw new Error('customPath must be provided if typeArg is custom');
|
||||
}
|
||||
this.type = optionsArg.typeArg;
|
||||
this.identity = optionsArg.identityArg;
|
||||
this.customPath = optionsArg.customPath; // Store custom path if provided
|
||||
constructor(typeArg: TKeyValueStore, customStringArg: string) {
|
||||
// set kvStoreType
|
||||
this.type = typeArg;
|
||||
this.identity = customStringArg;
|
||||
this.initFilePath();
|
||||
if (optionsArg.mandatoryKeys) {
|
||||
this.setMandatoryKeys(optionsArg.mandatoryKeys);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* reads all keyValue pairs at once and returns them
|
||||
*/
|
||||
public async readAll(): Promise<Partial<T>> {
|
||||
public async readAll() {
|
||||
await this.syncTask.trigger();
|
||||
return this.dataObject;
|
||||
}
|
||||
@ -121,21 +75,21 @@ export class KeyValueStore<T = any> {
|
||||
/**
|
||||
* reads a keyValueFile from disk
|
||||
*/
|
||||
public async readKey<K extends keyof T>(keyArg: K): Promise<T[K]> {
|
||||
public async readKey(keyArg: string) {
|
||||
await this.syncTask.trigger();
|
||||
return this.dataObject[keyArg] as T[K];
|
||||
return this.dataObject[keyArg];
|
||||
}
|
||||
|
||||
/**
|
||||
* writes a specific key to the keyValueStore
|
||||
*/
|
||||
public async writeKey<K extends keyof T>(keyArg: K, valueArg: T[K]): Promise<void> {
|
||||
public async writeKey(keyArg: string, valueArg: any) {
|
||||
await this.writeAll({
|
||||
[keyArg]: valueArg,
|
||||
} as unknown as Partial<T>);
|
||||
});
|
||||
}
|
||||
|
||||
public async deleteKey<K extends keyof T>(keyArg: K): Promise<void> {
|
||||
public async deleteKey(keyArg: string) {
|
||||
this.deletedObject[keyArg] = this.dataObject[keyArg];
|
||||
await this.syncTask.trigger();
|
||||
}
|
||||
@ -143,7 +97,7 @@ export class KeyValueStore<T = any> {
|
||||
/**
|
||||
* writes all keyValue pairs in the object argument
|
||||
*/
|
||||
public async writeAll(keyValueObject: Partial<T>): Promise<void> {
|
||||
public async writeAll(keyValueObject) {
|
||||
this.dataObject = { ...this.dataObject, ...keyValueObject };
|
||||
await this.syncTask.trigger();
|
||||
}
|
||||
@ -151,55 +105,8 @@ export class KeyValueStore<T = any> {
|
||||
/**
|
||||
* wipes a key value store from disk
|
||||
*/
|
||||
public async wipe(): Promise<void> {
|
||||
public async wipe() {
|
||||
this.dataObject = {};
|
||||
if (this.type !== 'ephemeral') {
|
||||
await plugins.smartfile.fs.remove(this.filePath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* resets the KeyValueStore to the initial state by syncing first, deleting all keys, and then triggering a sync again
|
||||
*/
|
||||
public async reset(): Promise<void> {
|
||||
await this.syncTask.trigger(); // Sync to get the latest state
|
||||
|
||||
// Delete all keys from the dataObject and add them to deletedObject
|
||||
for (const key of Object.keys(this.dataObject) as Array<keyof T>) {
|
||||
this.deletedObject[key] = this.dataObject[key];
|
||||
delete this.dataObject[key];
|
||||
}
|
||||
|
||||
await this.syncTask.trigger(); // Sync again to reflect the deletion
|
||||
}
|
||||
|
||||
private setMandatoryKeys(keys: Array<keyof T>) {
|
||||
keys.forEach(key => this.mandatoryKeys.add(key));
|
||||
}
|
||||
|
||||
public async getMissingMandatoryKeys(): Promise<Array<keyof T>> {
|
||||
await this.readAll();
|
||||
return Array.from(this.mandatoryKeys).filter(key => !(key in this.dataObject));
|
||||
}
|
||||
|
||||
public async waitForKeysPresent<K extends keyof T>(keysArg: K[]): Promise<void> {
|
||||
const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
|
||||
if (missingKeys.length === 0) {
|
||||
return;
|
||||
}
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
const subscription = this.changeSubject.subscribe(() => {
|
||||
const missingKeys = keysArg.filter(keyArg => !this.dataObject[keyArg]);
|
||||
if (missingKeys.length === 0) {
|
||||
subscription.unsubscribe();
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
public async waitForAndGetKey<K extends keyof T>(keyArg: K): Promise<T[K] | undefined> {
|
||||
await this.waitForKeysPresent([keyArg]);
|
||||
return this.readKey(keyArg);
|
||||
await plugins.smartfile.fs.remove(this.filePath);
|
||||
}
|
||||
}
|
||||
@ -1,5 +1,5 @@
|
||||
import * as plugins from './npmextra.plugins.js';
|
||||
import * as paths from './npmextra.paths.js';
|
||||
import * as plugins from './npmextra.plugins';
|
||||
import * as paths from './npmextra.paths';
|
||||
|
||||
/**
|
||||
* Npmextra class allows easy configuration of tools
|
||||
|
||||
@ -1,11 +1,8 @@
|
||||
import * as plugins from './npmextra.plugins.js';
|
||||
import * as plugins from './npmextra.plugins';
|
||||
|
||||
// directories
|
||||
export let cwd = process.cwd();
|
||||
export let packageDir = plugins.path.join(
|
||||
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
|
||||
'../'
|
||||
);
|
||||
export let packageDir = plugins.path.join(__dirname, '../');
|
||||
|
||||
// ----------------------
|
||||
// keyValueStore specific
|
||||
@ -16,7 +13,22 @@ export let home = plugins.smartpath.get.home();
|
||||
/**
|
||||
* keyValue base path
|
||||
*/
|
||||
export let kvUserHomeDirBase = plugins.path.join(home, '.npmextra/kv');
|
||||
export let kvBase = plugins.path.join(home, '.npmextra/kv');
|
||||
|
||||
/**
|
||||
* the base directory for custom string based key value store
|
||||
*/
|
||||
export let kvCustomDir = plugins.path.join(kvBase, 'custom');
|
||||
|
||||
/**
|
||||
* the subdir for git based keyValue
|
||||
*/
|
||||
export let kvGitDir = plugins.path.join(kvBase, 'git');
|
||||
|
||||
/**
|
||||
* keyValue for path based keyValue store
|
||||
*/
|
||||
export let kvPathDir = plugins.path.join(kvBase, 'path');
|
||||
|
||||
// files
|
||||
export let configFile = plugins.path.join(cwd, 'npmextra.json');
|
||||
|
||||
@ -1,17 +1,8 @@
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export {
|
||||
tsclass
|
||||
}
|
||||
|
||||
import * as qenv from '@push.rocks/qenv';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as beautylog from '@pushrocks/smartlog';
|
||||
import * as path from 'path';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartjson from '@push.rocks/smartjson';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartrx from '@push.rocks/smartrx';
|
||||
import * as taskbuffer from '@push.rocks/taskbuffer';
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartpath from '@pushrocks/smartpath';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as taskbuffer from '@pushrocks/taskbuffer';
|
||||
|
||||
export { qenv, smartlog, path, smartfile, smartjson, smartpath, smartpromise, smartrx, taskbuffer };
|
||||
export { beautylog, path, smartfile, smartpath, smartpromise, taskbuffer };
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"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