push.rocks/smartconfig
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(storage): migrate filesystem operations to smartfs and tighten TypeScript initialization checks

Browse Source
This commit is contained in:
Jürgen Kunz
2026-04-30 10:12:32 +00:00
parent 1c4ba7a7d0
commit 6084ffb0ce
9 changed files with 2827 additions and 3656 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelog.md
+8
View File
@@ -1,5 +1,13 @@
# Changelog
## 2026-04-30 - 6.1.1 - fix(storage)
migrate filesystem operations to smartfs and tighten TypeScript initialization checks
- replace @push.rocks/smartfile usage with smartfs and native node:fs across app data, key value store, and smartconfig handling
- improve JSON file read/write and deletion logic for persistent key value storage
- enable noImplicitAny in TypeScript config and add explicit initialization/type assertions where required
- update build tooling and runtime dependencies to match the new filesystem implementation
## 2026-03-24 - 6.1.0 - feat(docs)
refresh project documentation and migrate smartconfig tool configuration keys
package.json
+13 -14
View File
@@ -7,7 +7,7 @@
"typings": "dist_ts/index.d.ts",
"scripts": {
"test": "(tstest test/ --verbose --logfile --timeout 20)",
"build": "(tsbuild --web --allowimplicitany)",
"build": "(tsbuild --web)",
"buildDocs": "tsdoc"
},
"repository": {
@@ -22,20 +22,21 @@
"homepage": "https://code.foss.global/push.rocks/smartconfig#readme",
"dependencies": {
"@push.rocks/qenv": "^6.1.3",
"@push.rocks/smartfile": "^11.2.5",
"@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartlog": "^3.1.8",
"@push.rocks/smartfs": "^1.5.1",
"@push.rocks/smartjson": "^6.0.1",
"@push.rocks/smartlog": "^3.2.2",
"@push.rocks/smartpath": "^6.0.0",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrx": "^3.0.10",
"@push.rocks/taskbuffer": "^3.1.7",
"@tsclass/tsclass": "^9.2.0"
"@push.rocks/taskbuffer": "^8.0.2",
"@tsclass/tsclass": "^9.5.1"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.6.4",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^2.3.2",
"@types/node": "^22"
"@git.zone/tsbuild": "^4.4.0",
"@git.zone/tsrun": "^2.0.2",
"@git.zone/tstest": "^3.6.3",
"@types/lodash.clonedeep": "^4.5.9",
"@types/node": "^25.6.0"
},
"files": [
"ts/**/*",
@@ -47,6 +48,7 @@
"assets/**/*",
"cli.js",
".smartconfig.json",
"license",
"readme.md"
],
"browserslist": [
@@ -70,8 +72,5 @@
"workflow improvement",
"persistent storage"
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977",
"pnpm": {
"overrides": {}
}
"packageManager": "pnpm@10.28.2"
}
pnpm-lock.yaml
Generated
+2767 -3611
View File
File diff suppressed because it is too large Load Diff
ts/00_commitinfo_data.ts
+1 -1
View File
@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/smartconfig',
version: '6.1.0',
version: '6.1.1',
description: 'A comprehensive configuration management library providing key-value storage, environment variable mapping, and tool configuration.'
}
ts/classes.appdata.ts
+8 -7
View File
@@ -403,7 +403,7 @@ export class AppData<T = any> {
// instance
public readyDeferred = plugins.smartpromise.defer<void>();
public options: IAppDataOptions<T>;
private kvStore: KeyValueStore<T>;
private kvStore!: KeyValueStore<T>;
constructor(optionsArg: IAppDataOptions<T> = {}) {
this.options = optionsArg;
@@ -430,8 +430,8 @@ export class AppData<T = any> {
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);
const appDataExists = plugins.nodeFs.existsSync(appDataDir) && plugins.nodeFs.statSync(appDataDir).isDirectory();
const dataExists = plugins.nodeFs.existsSync(dataDir) && plugins.nodeFs.statSync(dataDir).isDirectory();
if (appDataExists) {
this.options.dirPath = appDataDir;
console.log(` 📁 Auto-selected container directory: ${appDataDir}`);
@@ -439,7 +439,7 @@ export class AppData<T = any> {
this.options.dirPath = dataDir;
console.log(` 📁 Auto-selected data directory: ${dataDir}`);
} else {
await plugins.smartfile.fs.ensureDir(nogitAppData);
await plugins.smartFs.directory(nogitAppData).create();
this.options.dirPath = nogitAppData;
console.log(` 📁 Auto-selected local directory: ${nogitAppData}`);
}
@@ -494,17 +494,18 @@ export class AppData<T = any> {
// Apply overwrite object after env mapping
if (this.options.overwriteObject) {
const overwriteKeys = Object.keys(this.options.overwriteObject);
const overwriteObject = this.options.overwriteObject as Record<string, unknown>;
const overwriteKeys = Object.keys(overwriteObject);
console.log(`🔄 Applying overwriteObject with ${overwriteKeys.length} key(s)...`);
for (const key of overwriteKeys) {
const value = this.options.overwriteObject[key];
const value = overwriteObject[key];
const valueType = Array.isArray(value) ? 'array' : typeof value;
console.log(` 🔧 Overwriting key "${key}" with ${valueType} value`);
await this.kvStore.writeKey(
key as keyof T,
value,
value as T[keyof T],
);
}
ts/classes.keyvaluestore.ts
+17 -12
View File
@@ -26,21 +26,18 @@ export class KeyValueStore<T = any> {
name: 'syncTask',
buffered: true,
bufferMax: 1,
execDelay: 0,
taskFunction: async () => {
if (this.type !== 'ephemeral') {
const storedJson = await plugins.smartFs.file(this.filePath!).encoding('utf8').read() as string;
this.dataObject = {
...plugins.smartfile.fs.toObjectSync(this.filePath),
...plugins.smartjson.parse(storedJson || '{}'),
...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,
);
await plugins.smartFs.file(this.filePath!).encoding('utf8').write(plugins.smartjson.stringifyPretty(this.dataObject));
}
const newStateString = plugins.smartjson.stringify(this.dataObject);
@@ -67,13 +64,16 @@ export class KeyValueStore<T = any> {
paths.cwd,
);
this.filePath = absolutePath;
if (plugins.smartfile.fs.isDirectorySync(this.filePath)) {
if (plugins.nodeFs.existsSync(this.filePath) && plugins.nodeFs.statSync(this.filePath).isDirectory()) {
this.filePath = plugins.path.join(
this.filePath,
this.identity + '.json',
);
}
plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
plugins.nodeFs.mkdirSync(plugins.path.dirname(this.filePath), { recursive: true });
if (!plugins.nodeFs.existsSync(this.filePath)) {
plugins.nodeFs.writeFileSync(this.filePath, '{}');
}
return;
}
@@ -84,8 +84,10 @@ export class KeyValueStore<T = any> {
throw new Error('kv type not supported');
}
this.filePath = plugins.path.join(baseDir, this.identity + '.json');
plugins.smartfile.fs.ensureDirSync(baseDir);
plugins.smartfile.fs.ensureFileSync(this.filePath, '{}');
plugins.nodeFs.mkdirSync(baseDir, { recursive: true });
if (!plugins.nodeFs.existsSync(this.filePath)) {
plugins.nodeFs.writeFileSync(this.filePath, '{}');
}
};
// if no custom path is provided, try to store at home directory
@@ -162,8 +164,11 @@ export class KeyValueStore<T = any> {
*/
public async wipe(): Promise<void> {
this.dataObject = {};
if (this.type !== 'ephemeral') {
await plugins.smartfile.fs.remove(this.filePath);
if (this.type !== 'ephemeral' && this.filePath) {
const file = plugins.smartFs.file(this.filePath);
if (await file.exists()) {
await file.delete();
}
}
}
ts/classes.smartconfig.ts
+5 -7
View File
@@ -6,8 +6,8 @@ import * as paths from './paths.js';
*/
export class Smartconfig {
cwd: string;
lookupPath: string;
smartconfigJsonExists: boolean;
lookupPath!: string;
smartconfigJsonExists = false;
smartconfigJsonData: any;
/**
@@ -48,9 +48,7 @@ export class Smartconfig {
* checks if the JSON exists
*/
private checkSmartconfigJsonExists() {
this.smartconfigJsonExists = plugins.smartfile.fs.fileExistsSync(
this.lookupPath,
);
this.smartconfigJsonExists = plugins.nodeFs.existsSync(this.lookupPath);
}
/**
@@ -69,8 +67,8 @@ export class Smartconfig {
*/
private checkSmartconfigJsonData() {
if (this.smartconfigJsonExists) {
this.smartconfigJsonData = plugins.smartfile.fs.toObjectSync(
this.lookupPath,
this.smartconfigJsonData = plugins.smartjson.parse(
plugins.nodeFs.readFileSync(this.lookupPath, 'utf8'),
);
} else {
this.smartconfigJsonData = {};
ts/plugins.ts
+6 -2
View File
@@ -4,19 +4,23 @@ export { tsclass };
import * as qenv from '@push.rocks/qenv';
import * as smartlog from '@push.rocks/smartlog';
import * as nodeFs from 'node:fs';
import * as path from 'path';
import * as smartfile from '@push.rocks/smartfile';
import * as smartfs from '@push.rocks/smartfs';
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';
export const smartFs = new smartfs.SmartFs(new smartfs.SmartFsProviderNode());
export {
qenv,
smartlog,
nodeFs,
path,
smartfile,
smartfs,
smartjson,
smartpath,
smartpromise,
tsconfig.json
+2 -2
View File
@@ -6,10 +6,10 @@
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"noImplicitAny": true,
"esModuleInterop": true,
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
"types": ["node"]
},
"exclude": ["dist_*/**/*.d.ts"]
}