Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6a70af9b6f | |||
| 2ad3da85a9 | |||
| 09e8b8b94c | |||
| 265f4df8b3 | |||
| 5461ec0636 | |||
| 937252f99e | |||
| 6f19c3cc71 | |||
| 4be54f6dcc | |||
| 5c6702b898 | |||
| f1ecda411a |
@ -14,7 +14,7 @@
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "npmextra",
|
||||
"description": "Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.",
|
||||
"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": [
|
||||
@ -26,7 +26,13 @@
|
||||
"typescript",
|
||||
"environment setup",
|
||||
"dependencies management",
|
||||
"npm package enhancement"
|
||||
"npm package enhancement",
|
||||
"automation",
|
||||
"async operations",
|
||||
"app configuration",
|
||||
"smart file handling",
|
||||
"workflow improvement",
|
||||
"persistent storage"
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
17
package.json
17
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@push.rocks/npmextra",
|
||||
"version": "5.0.15",
|
||||
"version": "5.0.20",
|
||||
"private": false,
|
||||
"description": "Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.",
|
||||
"description": "A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"scripts": {
|
||||
@ -28,14 +28,15 @@
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@push.rocks/taskbuffer": "^3.1.7"
|
||||
"@push.rocks/taskbuffer": "^3.1.7",
|
||||
"@tsclass/tsclass": "^4.0.59"
|
||||
},
|
||||
"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.2"
|
||||
"@types/node": "^20.14.5"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -62,6 +63,12 @@
|
||||
"typescript",
|
||||
"environment setup",
|
||||
"dependencies management",
|
||||
"npm package enhancement"
|
||||
"npm package enhancement",
|
||||
"automation",
|
||||
"async operations",
|
||||
"app configuration",
|
||||
"smart file handling",
|
||||
"workflow improvement",
|
||||
"persistent storage"
|
||||
]
|
||||
}
|
||||
|
||||
85
pnpm-lock.yaml
generated
85
pnpm-lock.yaml
generated
@ -32,22 +32,25 @@ importers:
|
||||
'@push.rocks/taskbuffer':
|
||||
specifier: ^3.1.7
|
||||
version: 3.1.7
|
||||
'@tsclass/tsclass':
|
||||
specifier: ^4.0.59
|
||||
version: 4.0.59
|
||||
devDependencies:
|
||||
'@git.zone/tsbuild':
|
||||
specifier: ^2.1.80
|
||||
version: 2.1.80
|
||||
'@git.zone/tsrun':
|
||||
specifier: ^1.2.44
|
||||
version: 1.2.46(@types/node@20.14.2)
|
||||
version: 1.2.46(@types/node@20.14.5)
|
||||
'@git.zone/tstest':
|
||||
specifier: ^1.0.90
|
||||
version: 1.0.90(@types/node@20.14.2)
|
||||
version: 1.0.90(@types/node@20.14.5)
|
||||
'@push.rocks/tapbundle':
|
||||
specifier: ^5.0.23
|
||||
version: 5.0.23
|
||||
'@types/node':
|
||||
specifier: ^20.14.2
|
||||
version: 20.14.2
|
||||
specifier: ^20.14.5
|
||||
version: 20.14.5
|
||||
|
||||
packages:
|
||||
|
||||
@ -625,8 +628,8 @@ packages:
|
||||
'@tsclass/tsclass@3.0.48':
|
||||
resolution: {integrity: sha512-hC65UvDlp9qvsl6OcIZXz0JNiWZ0gyzsTzbXpg215sGxopgbkOLCr6E0s4qCTnweYm95gt2AdY95uP7M7kExaQ==}
|
||||
|
||||
'@tsclass/tsclass@4.0.55':
|
||||
resolution: {integrity: sha512-zg774JF90/3/rJ7xk4LyGgxcUzxdKIQcwtBVxez4LhvegESxvHiFmX42WL105iBpE53ISJ8sctLWlwG1JQZdlA==}
|
||||
'@tsclass/tsclass@4.0.59':
|
||||
resolution: {integrity: sha512-zSdNX/qzuekfCFG81k4e1X2tj1S+rbs2tM4CFAzT+aLiu2/AqdS1iPYwH/sYpY8vm+vBfllks9rlsuRSA2xTeg==}
|
||||
|
||||
'@tsconfig/node10@1.0.11':
|
||||
resolution: {integrity: sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==}
|
||||
@ -766,8 +769,8 @@ packages:
|
||||
'@types/ms@0.7.34':
|
||||
resolution: {integrity: sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==}
|
||||
|
||||
'@types/node@20.14.2':
|
||||
resolution: {integrity: sha512-xyu6WAMVwv6AKFLB+e/7ySZVr/0zLCzOa7rSpq6jNwpqOrUbcACDWC+53d4n2QHOnDou0fbIsg8wZu/sxrnI4Q==}
|
||||
'@types/node@20.14.5':
|
||||
resolution: {integrity: sha512-aoRR+fJkZT2l0aGOJhuA8frnCSoNX6W7U2mpNq63+BxBIj5BQFt8rHy627kijCmm63ijdSdwvGgpUsU6MBsZZA==}
|
||||
|
||||
'@types/parse5@6.0.3':
|
||||
resolution: {integrity: sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==}
|
||||
@ -3060,7 +3063,7 @@ snapshots:
|
||||
'@push.rocks/taskbuffer': 3.1.7
|
||||
'@push.rocks/webrequest': 3.0.37
|
||||
'@push.rocks/webstore': 2.0.20
|
||||
'@tsclass/tsclass': 4.0.55
|
||||
'@tsclass/tsclass': 4.0.59
|
||||
'@types/express': 4.17.21
|
||||
body-parser: 1.20.2
|
||||
cors: 2.8.5
|
||||
@ -3257,22 +3260,22 @@ snapshots:
|
||||
transitivePeerDependencies:
|
||||
- supports-color
|
||||
|
||||
'@git.zone/tsrun@1.2.46(@types/node@20.14.2)':
|
||||
'@git.zone/tsrun@1.2.46(@types/node@20.14.5)':
|
||||
dependencies:
|
||||
'@push.rocks/smartfile': 10.0.41
|
||||
'@push.rocks/smartshell': 3.0.5
|
||||
ts-node: 10.9.2(@types/node@20.14.2)(typescript@5.1.6)
|
||||
ts-node: 10.9.2(@types/node@20.14.5)(typescript@5.1.6)
|
||||
typescript: 5.1.6
|
||||
transitivePeerDependencies:
|
||||
- '@swc/core'
|
||||
- '@swc/wasm'
|
||||
- '@types/node'
|
||||
|
||||
'@git.zone/tstest@1.0.90(@types/node@20.14.2)':
|
||||
'@git.zone/tstest@1.0.90(@types/node@20.14.5)':
|
||||
dependencies:
|
||||
'@api.global/typedserver': 3.0.50
|
||||
'@git.zone/tsbundle': 2.0.15
|
||||
'@git.zone/tsrun': 1.2.46(@types/node@20.14.2)
|
||||
'@git.zone/tsrun': 1.2.46(@types/node@20.14.5)
|
||||
'@push.rocks/consolecolor': 2.0.2
|
||||
'@push.rocks/smartbrowser': 2.0.6
|
||||
'@push.rocks/smartdelay': 3.0.5
|
||||
@ -3565,7 +3568,7 @@ snapshots:
|
||||
'@push.rocks/smartlog-interfaces@3.0.2':
|
||||
dependencies:
|
||||
'@api.global/typedrequest-interfaces': 2.0.2
|
||||
'@tsclass/tsclass': 4.0.55
|
||||
'@tsclass/tsclass': 4.0.59
|
||||
|
||||
'@push.rocks/smartlog@3.0.7':
|
||||
dependencies:
|
||||
@ -3645,7 +3648,7 @@ snapshots:
|
||||
'@push.rocks/smartpromise': 4.0.3
|
||||
'@push.rocks/smartpuppeteer': 2.0.2
|
||||
'@push.rocks/smartunique': 3.0.9
|
||||
'@tsclass/tsclass': 4.0.55
|
||||
'@tsclass/tsclass': 4.0.59
|
||||
'@types/express': 4.17.21
|
||||
express: 4.19.2
|
||||
pdf-lib: 1.17.1
|
||||
@ -3703,7 +3706,7 @@ snapshots:
|
||||
'@push.rocks/smartxml': 1.0.8
|
||||
'@push.rocks/smartyaml': 2.0.5
|
||||
'@push.rocks/webrequest': 3.0.37
|
||||
'@tsclass/tsclass': 4.0.55
|
||||
'@tsclass/tsclass': 4.0.59
|
||||
|
||||
'@push.rocks/smartsocket@2.0.27':
|
||||
dependencies:
|
||||
@ -3837,7 +3840,7 @@ snapshots:
|
||||
dependencies:
|
||||
'@pushrocks/smartdelay': 3.0.1
|
||||
'@pushrocks/smartpromise': 4.0.2
|
||||
'@tsclass/tsclass': 4.0.55
|
||||
'@tsclass/tsclass': 4.0.59
|
||||
|
||||
'@push.rocks/webstore@2.0.20':
|
||||
dependencies:
|
||||
@ -4013,7 +4016,7 @@ snapshots:
|
||||
dependencies:
|
||||
type-fest: 2.19.0
|
||||
|
||||
'@tsclass/tsclass@4.0.55':
|
||||
'@tsclass/tsclass@4.0.59':
|
||||
dependencies:
|
||||
type-fest: 4.20.0
|
||||
|
||||
@ -4027,14 +4030,14 @@ snapshots:
|
||||
|
||||
'@types/accepts@1.3.7':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/babel__code-frame@7.0.6': {}
|
||||
|
||||
'@types/body-parser@1.19.5':
|
||||
dependencies:
|
||||
'@types/connect': 3.4.38
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/buffer-json@2.0.3': {}
|
||||
|
||||
@ -4046,17 +4049,17 @@ snapshots:
|
||||
|
||||
'@types/clean-css@4.2.11':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
source-map: 0.6.1
|
||||
|
||||
'@types/co-body@6.1.3':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
'@types/qs': 6.9.15
|
||||
|
||||
'@types/connect@3.4.38':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/content-disposition@0.5.8': {}
|
||||
|
||||
@ -4069,11 +4072,11 @@ snapshots:
|
||||
'@types/connect': 3.4.38
|
||||
'@types/express': 4.17.21
|
||||
'@types/keygrip': 1.0.6
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/cors@2.8.17':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/debounce@1.2.4': {}
|
||||
|
||||
@ -4085,7 +4088,7 @@ snapshots:
|
||||
|
||||
'@types/express-serve-static-core@4.19.3':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
'@types/qs': 6.9.15
|
||||
'@types/range-parser': 1.2.7
|
||||
'@types/send': 0.17.4
|
||||
@ -4099,17 +4102,17 @@ snapshots:
|
||||
|
||||
'@types/from2@2.3.5':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/fs-extra@11.0.4':
|
||||
dependencies:
|
||||
'@types/jsonfile': 6.1.4
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/glob@8.1.0':
|
||||
dependencies:
|
||||
'@types/minimatch': 5.1.2
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/hast@3.0.4':
|
||||
dependencies:
|
||||
@ -4143,7 +4146,7 @@ snapshots:
|
||||
|
||||
'@types/jsonfile@6.1.4':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/keygrip@1.0.6': {}
|
||||
|
||||
@ -4160,7 +4163,7 @@ snapshots:
|
||||
'@types/http-errors': 2.0.4
|
||||
'@types/keygrip': 1.0.6
|
||||
'@types/koa-compose': 3.2.8
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/mdast@4.0.4':
|
||||
dependencies:
|
||||
@ -4176,7 +4179,7 @@ snapshots:
|
||||
|
||||
'@types/ms@0.7.34': {}
|
||||
|
||||
'@types/node@20.14.2':
|
||||
'@types/node@20.14.5':
|
||||
dependencies:
|
||||
undici-types: 5.26.5
|
||||
|
||||
@ -4195,12 +4198,12 @@ snapshots:
|
||||
'@types/send@0.17.4':
|
||||
dependencies:
|
||||
'@types/mime': 1.3.5
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/serve-static@1.15.7':
|
||||
dependencies:
|
||||
'@types/http-errors': 2.0.4
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
'@types/send': 0.17.4
|
||||
|
||||
'@types/sinon-chai@3.2.12':
|
||||
@ -4218,7 +4221,7 @@ snapshots:
|
||||
|
||||
'@types/through2@2.0.41':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/trusted-types@2.0.7': {}
|
||||
|
||||
@ -4238,15 +4241,15 @@ snapshots:
|
||||
|
||||
'@types/ws@7.4.7':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/ws@8.5.10':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
|
||||
'@types/yauzl@2.10.3':
|
||||
dependencies:
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
optional: true
|
||||
|
||||
'@ungap/structured-clone@1.2.0': {}
|
||||
@ -4754,7 +4757,7 @@ snapshots:
|
||||
dependencies:
|
||||
'@types/cookie': 0.4.1
|
||||
'@types/cors': 2.8.17
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
accepts: 1.3.8
|
||||
base64id: 2.0.0
|
||||
cookie: 0.4.2
|
||||
@ -6520,14 +6523,14 @@ snapshots:
|
||||
|
||||
trough@2.2.0: {}
|
||||
|
||||
ts-node@10.9.2(@types/node@20.14.2)(typescript@5.1.6):
|
||||
ts-node@10.9.2(@types/node@20.14.5)(typescript@5.1.6):
|
||||
dependencies:
|
||||
'@cspotcode/source-map-support': 0.8.1
|
||||
'@tsconfig/node10': 1.0.11
|
||||
'@tsconfig/node12': 1.0.11
|
||||
'@tsconfig/node14': 1.0.3
|
||||
'@tsconfig/node16': 1.0.4
|
||||
'@types/node': 20.14.2
|
||||
'@types/node': 20.14.5
|
||||
acorn: 8.11.3
|
||||
acorn-walk: 8.3.2
|
||||
arg: 4.1.3
|
||||
|
||||
83
readme.md
83
readme.md
@ -1,5 +1,5 @@
|
||||
# @push.rocks/npmextra
|
||||
Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.
|
||||
A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.
|
||||
|
||||
## Install
|
||||
To install `@push.rocks/npmextra`, use the following npm command:
|
||||
@ -14,7 +14,7 @@ This package is available on [npm](https://www.npmjs.com/package/@push.rocks/npm
|
||||
`@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 in your project with an import statement:
|
||||
To start using `npmextra` in your project, first include it with an import statement:
|
||||
|
||||
```typescript
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
@ -27,7 +27,7 @@ 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, `@push.rocks/npmextra` enables you to define tool-specific settings within this centralized configuration file, which can then be accessed programmatically.
|
||||
`@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`
|
||||
|
||||
@ -56,9 +56,9 @@ import { Npmextra } from '@push.rocks/npmextra';
|
||||
const npmExtraInstance = new Npmextra();
|
||||
|
||||
// Retrieve the configuration for 'toolname', merging defaults with any found in npmextra.json
|
||||
const toolConfig = npmExtraInstance.dataFor('toolname', {
|
||||
defaultKey1: 'defaultValue1',
|
||||
defaultKey2: 'defaultValue2'
|
||||
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
|
||||
@ -75,7 +75,10 @@ To utilize the KeyValueStore, create an instance specifying its scope (e.g., 'us
|
||||
```typescript
|
||||
import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
|
||||
const kvStore = new KeyValueStore<'userHomeDir'>('userHomeDir', 'myUniqueAppName');
|
||||
const kvStore = new KeyValueStore<'userHomeDir'>({
|
||||
typeArg: 'userHomeDir',
|
||||
identityArg: 'myUniqueAppName'
|
||||
});
|
||||
```
|
||||
|
||||
You can then use the `writeKey`, `readKey`, `writeAll`, and `readAll` methods to manage your store respectively.
|
||||
@ -101,57 +104,14 @@ const allData = await kvStore.readAll();
|
||||
console.log(allData); // Outputs the entire store's contents
|
||||
```
|
||||
|
||||
### Integrating with Tools
|
||||
`@push.rocks/npmextra` seamlessly integrates with numerous tools, enabling them to leverage `npmextra.json` for configuration purposes. Tools such as `npmts`, `npmci`, and `npmdocker` are already utilizing this feature for enhanced configuration management. Below is an example of integrating a fictional tool named `toolname` with `npmextra`.
|
||||
### Advanced Key-Value Store Management
|
||||
|
||||
#### Example: Tool Integration
|
||||
|
||||
Imagine you have a custom tool called `toolname` that requires specific configurations. Here's how you might configure and use it with `npmextra`:
|
||||
|
||||
1. Define the configuration in `npmextra.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"toolname": {
|
||||
"configKey1": "configValue1",
|
||||
"configKey2": "configValue2",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Access the configuration within your tool:
|
||||
|
||||
```typescript
|
||||
// Import npmextra
|
||||
import { Npmextra } from '@push.rocks/npmextra';
|
||||
|
||||
class ToolName {
|
||||
config: any;
|
||||
|
||||
constructor() {
|
||||
const npmExtraInstance = new Npmextra();
|
||||
this.config = npmExtraInstance.dataFor('toolname', {
|
||||
configKey1: 'defaultValue1',
|
||||
configKey2: 'defaultValue2'
|
||||
});
|
||||
}
|
||||
|
||||
run() {
|
||||
// Utilize the configuration
|
||||
console.log(this.config.configKey1); // Outputs: configValue1
|
||||
console.log(this.config.configKey2); // Outputs: configValue2
|
||||
}
|
||||
}
|
||||
|
||||
const toolInstance = new ToolName();
|
||||
toolInstance.run();
|
||||
```
|
||||
|
||||
### Advanced Key-Value Store Usage
|
||||
In addition to basic read/write operations, `@push.rocks/npmextra`’s `KeyValueStore` supports advanced usage scenarios, such as mandatory keys and custom file paths.
|
||||
In addition to basic read/write operations, `npmextra`’s `KeyValueStore` supports advanced scenarios like mandatory keys and custom file paths.
|
||||
|
||||
#### 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';
|
||||
|
||||
@ -186,7 +146,8 @@ console.log(allData); // Outputs: { key1: 'value1', key2: 123 }
|
||||
```
|
||||
|
||||
### Combining AppData and KeyValueStore
|
||||
The `AppData` class extends the functionality of `KeyValueStore` by integrating environmental variables and specifying additional configurations.
|
||||
|
||||
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
|
||||
|
||||
@ -229,7 +190,8 @@ console.log(allSettings); // Outputs: { settingA: 'exampleValue', settingB: 100,
|
||||
```
|
||||
|
||||
### Error Handling and Debugging
|
||||
Proper error handling ensures that your integrations with `npmextra` are robust and stable. Below are some strategies for error handling and debugging potential issues.
|
||||
|
||||
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
|
||||
|
||||
@ -268,6 +230,7 @@ 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
|
||||
@ -302,7 +265,10 @@ import { KeyValueStore } from '@push.rocks/npmextra';
|
||||
let kvStore: KeyValueStore<{ key1: string, key2: number }>;
|
||||
|
||||
tap.test('should create a KeyValueStore instance', async () => {
|
||||
kvStore = new KeyValueStore('userHomeDir', 'testApp');
|
||||
kvStore = new KeyValueStore({
|
||||
typeArg: 'userHomeDir',
|
||||
identityArg: 'testApp'
|
||||
});
|
||||
expect(kvStore).toBeInstanceOf(KeyValueStore);
|
||||
});
|
||||
|
||||
@ -322,7 +288,8 @@ 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, `@push.rocks/npmextra` provides an efficient and streamlined solution. Leveraging these robust features will ensure your project is well-configured and maintainable.
|
||||
|
||||
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
|
||||
|
||||
|
||||
27
test/test.appdata.ts
Normal file
27
test/test.appdata.ts
Normal file
@ -0,0 +1,27 @@
|
||||
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();
|
||||
@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/npmextra',
|
||||
version: '5.0.15',
|
||||
description: 'Enhances npm with additional configuration and tool management capabilities, including a key-value store for project setups.'
|
||||
version: '5.0.20',
|
||||
description: 'A utility to enhance npm with additional configuration, tool management capabilities, and a key-value store for project setups.'
|
||||
}
|
||||
|
||||
@ -1,18 +1,21 @@
|
||||
import * as plugins from './npmextra.plugins.js';
|
||||
import * as paths from './npmextra.paths.js';
|
||||
import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
|
||||
import { env } from 'process';
|
||||
|
||||
|
||||
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?: {
|
||||
[key in keyof T]?: string | object;
|
||||
};
|
||||
envMapping?: plugins.tsclass.typeFest.PartialDeep<T>
|
||||
}
|
||||
|
||||
export class AppData<T = any> {
|
||||
@ -43,7 +46,7 @@ export class AppData<T = any> {
|
||||
* @param pathArg
|
||||
*/
|
||||
private async init(pathArg?: string) {
|
||||
if (this.options.dirPath) {
|
||||
if (this.options.dirPath || this.options.ephermal) {
|
||||
// ok, nothing to do here;
|
||||
} else {
|
||||
const appDataDir = '/app/data';
|
||||
@ -62,7 +65,7 @@ export class AppData<T = any> {
|
||||
}
|
||||
|
||||
this.kvStore = new KeyValueStore<T>({
|
||||
typeArg: 'custom',
|
||||
typeArg: this.options.ephermal ? 'ephemeral' : 'custom',
|
||||
identityArg: 'appkv',
|
||||
customPath: this.options.dirPath,
|
||||
mandatoryKeys: this.options.requiredKeys as Array<keyof T>
|
||||
|
||||
@ -3,7 +3,7 @@ import * as paths from './npmextra.paths.js';
|
||||
|
||||
import { Task } from '@push.rocks/taskbuffer';
|
||||
|
||||
export type TKeyValueStore = 'custom' | 'userHomeDir';
|
||||
export type TKeyValueStore = 'custom' | 'userHomeDir' | 'ephemeral';
|
||||
|
||||
export interface IKvStoreConstructorOptions<T> {
|
||||
typeArg: TKeyValueStore;
|
||||
@ -20,7 +20,7 @@ export class KeyValueStore<T = any> {
|
||||
private deletedObject: Partial<T> = {};
|
||||
private mandatoryKeys: Set<keyof T> = new Set();
|
||||
public changeSubject = new plugins.smartrx.rxjs.Subject<Partial<T>>();
|
||||
|
||||
|
||||
private storedStateString: string = '';
|
||||
public syncTask = new Task({
|
||||
name: 'syncTask',
|
||||
@ -28,18 +28,20 @@ export class KeyValueStore<T = any> {
|
||||
bufferMax: 1,
|
||||
execDelay: 0,
|
||||
taskFunction: async () => {
|
||||
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];
|
||||
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
|
||||
);
|
||||
}
|
||||
this.deletedObject = {};
|
||||
await plugins.smartfile.memory.toFs(
|
||||
plugins.smartjson.stringifyPretty(this.dataObject),
|
||||
this.filePath
|
||||
);
|
||||
const newStateString = plugins.smartjson.stringify(this.dataObject);
|
||||
|
||||
// change detection
|
||||
@ -54,6 +56,10 @@ export class KeyValueStore<T = any> {
|
||||
* computes the identity and filePath
|
||||
*/
|
||||
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);
|
||||
@ -79,7 +85,7 @@ export class KeyValueStore<T = any> {
|
||||
// if no custom path is provided, try to store at home directory
|
||||
public type: TKeyValueStore;
|
||||
public identity: string;
|
||||
public filePath: string;
|
||||
public filePath?: string;
|
||||
private customPath?: string; // Optionally allow custom path
|
||||
|
||||
/**
|
||||
@ -147,7 +153,9 @@ export class KeyValueStore<T = any> {
|
||||
*/
|
||||
public async wipe(): Promise<void> {
|
||||
this.dataObject = {};
|
||||
await plugins.smartfile.fs.remove(this.filePath);
|
||||
if (this.type !== 'ephemeral') {
|
||||
await plugins.smartfile.fs.remove(this.filePath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@ -1,3 +1,9 @@
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export {
|
||||
tsclass
|
||||
}
|
||||
|
||||
import * as qenv from '@push.rocks/qenv';
|
||||
import * as smartlog from '@push.rocks/smartlog';
|
||||
import * as path from 'path';
|
||||
|
||||
Reference in New Issue
Block a user