fix(core): update

This commit is contained in:
Philipp Kunz 2023-08-24 10:39:47 +02:00
parent 2e95824ff4
commit 102422c9c7
10 changed files with 1149 additions and 187 deletions

View File

@ -21,18 +21,19 @@
},
"homepage": "https://gitlab.com/pushrocks/npmextra#README",
"dependencies": {
"@push.rocks/smartfile": "^10.0.26",
"@push.rocks/smartfile": "^10.0.30",
"@push.rocks/smartjson": "^5.0.8",
"@push.rocks/smartlog": "^3.0.2",
"@push.rocks/smartpath": "^5.0.11",
"@push.rocks/smartpromise": "^4.0.2",
"@push.rocks/taskbuffer": "^3.0.10"
"@push.rocks/taskbuffer": "^3.1.6"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.1.66",
"@gitzone/tsrun": "^1.2.44",
"@gitzone/tstest": "^1.0.77",
"@push.rocks/tapbundle": "^5.0.8",
"@types/node": "^20.4.6"
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.5.3"
},
"files": [
"ts/**/*",

File diff suppressed because it is too large Load Diff

1
test/somekv.json Normal file
View File

@ -0,0 +1 @@
{"myKey":"myValue"}

View File

@ -5,7 +5,7 @@ import * as npmextra from '../ts/index.js';
let myKeyValueStore: npmextra.KeyValueStore;
tap.test('should create a keyValueStore', async () => {
myKeyValueStore = new npmextra.KeyValueStore('custom', 'test');
myKeyValueStore = new npmextra.KeyValueStore('custom', 'test', 'test/somekv.json');
expect(myKeyValueStore).toBeInstanceOf(npmextra.KeyValueStore);
});

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/npmextra',
version: '3.0.11',
version: '3.0.12',
description: 'do more with npm'
}

View File

@ -1,4 +1,3 @@
import * as plugins from './npmextra.plugins.js';
export * from './npmextra.classes.npmextra.js';
export * from './npmextra.classes.appdata.js';
export * from './npmextra.classes.keyvaluestore.js';
export * from './npmextra.classes.npmextra.js';

View File

@ -0,0 +1,37 @@
import * as plugins from './npmextra.plugins.js';
import * as paths from './npmextra.paths.js';
import { KeyValueStore } from './npmextra.classes.keyvaluestore.js';
export class AppData {
public readyDeferred = plugins.smartpromise.defer();
public dirPathArg: string;
private kvStore: KeyValueStore;
constructor(pathArg?: string) {
this.init(pathArg);
}
private async init(pathArg?: string) {
if (pathArg) {
this.dirPathArg = pathArg;
} else {
const appDataDir = '/app/data';
const dataDir = '/data';
const appDataExists = plugins.smartfile.fs.isDirectory(appDataDir);
const dataExists = plugins.smartfile.fs.isDirectory(dataDir);
if (appDataExists) {
this.dirPathArg = appDataDir;
this.dirPathArg = dataDir;
}
}
this.kvStore = new KeyValueStore('custom', 'appkv', this.dirPathArg);
this.readyDeferred.resolve();
}
/**
* returns a kvtore that resides in appdata
*/
public async getKvStore() {
await this.readyDeferred.promise;
return this.kvStore;
}
}

View File

@ -3,10 +3,10 @@ import * as paths from './npmextra.paths.js';
import { Task } from '@push.rocks/taskbuffer';
export type TKeyValueStore = 'path' | 'gitProject' | 'custom';
export type TKeyValueStore = 'custom' | 'userHomeDir';
/**
* kvStore is a simple key vlaue store to store data about projects between runs
* kvStore is a simple key value store to store data about projects between runs
*/
export class KeyValueStore {
private dataObject: any = {};
@ -25,42 +25,57 @@ export class KeyValueStore {
delete this.dataObject[key];
}
this.deletedObject = {};
await plugins.smartfile.memory.toFs(JSON.stringify(this.dataObject), this.filePath);
await plugins.smartfile.memory.toFs(plugins.smartjson.stringify(this.dataObject), this.filePath);
},
});
/**
* computes the identity
* computes the identity and filePath
*/
private initFilePath = () => {
// determine the right base directory
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;
}
let baseDir: string;
if (this.type === 'custom') {
baseDir = paths.kvCustomDir;
} else if (this.type === 'gitProject') {
baseDir = paths.kvGitDir;
} else if (this.type === 'path') {
baseDir = paths.kvPathDir;
if (this.type === 'userHomeDir') {
baseDir = paths.kvUserHomeDirBase;
} else {
throw new Error('kv type not supported');
}
this.filePath = plugins.path.join(baseDir, this.identity + '.json');
plugins.smartfile.fs.ensureDirSync(paths.kvCustomDir);
plugins.smartfile.fs.ensureDirSync(paths.kvGitDir);
plugins.smartfile.fs.ensureDirSync(paths.kvPathDir);
plugins.smartfile.fs.ensureDirSync(baseDir);
plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
};
public type: TKeyValueStore; // the type of the kvStore
public identity: string; // the identity of the kvStore
public filePath: string; // the filePath of the kvStore
// 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
/**
* the constructor of keyvalue store
* @param typeArg
* @param customStringArg
* @param identityArg
* @param customPath Optional custom path for the keyValue store
*/
constructor(typeArg: TKeyValueStore, customStringArg: string) {
// set kvStoreType
constructor(typeArg: TKeyValueStore, identityArg: string, customPath?: string) {
if (customPath && typeArg !== 'custom') {
throw new Error('customPath can only be provided if typeArg is custom');
}
if (typeArg === 'custom' && !customPath) {
throw new Error('customPath must be provided if typeArg is custom');
}
this.type = typeArg;
this.identity = customStringArg;
this.identity = identityArg;
this.customPath = customPath; // Store custom path if provided
this.initFilePath();
}
@ -97,7 +112,7 @@ export class KeyValueStore {
/**
* writes all keyValue pairs in the object argument
*/
public async writeAll(keyValueObject) {
public async writeAll(keyValueObject: { [key: string]: any }) {
this.dataObject = { ...this.dataObject, ...keyValueObject };
await this.syncTask.trigger();
}

View File

@ -16,22 +16,7 @@ export let home = plugins.smartpath.get.home();
/**
* keyValue base path
*/
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');
export let kvUserHomeDirBase = plugins.path.join(home, '.npmextra/kv');
// files
export let configFile = plugins.path.join(cwd, 'npmextra.json');

View File

@ -1,8 +1,9 @@
import * as smartlog from '@push.rocks/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 taskbuffer from '@push.rocks/taskbuffer';
export { smartlog, path, smartfile, smartpath, smartpromise, taskbuffer };
export { smartlog, path, smartfile, smartjson, smartpath, smartpromise, taskbuffer };