command-line-config 2.0.0 → 2.1.0

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { readFileSync } from 'node:fs';
+export type ReadFileOptions = Parameters<typeof readFileSync>[1];
+export declare function load(path?: string, readFileOptions?: ReadFileOptions): unknown | undefined;
+export declare function save(obj: unknown, path?: string): boolean;

package/dist/index.js

@@ -0,0 +1,46 @@
+import { existsSync, writeFileSync } from 'node:fs';
+import { resolve } from 'path';
+import { readFileSync } from 'node:fs';
+let safePath = null;
+function resolvePath(path) {
+    return resolve(process.cwd(), path);
+}
+// Returns a resolved path based on the string passed in,
+// or returns a path based on the first argument passed in that resolves to a real file
+function getPathToUse(path) {
+    if (typeof path !== 'string') {
+        if (!safePath) {
+            safePath = process.argv.slice(2).map(resolvePath).filter(existsSync).shift() || null;
+        }
+        return safePath;
+    }
+    else {
+        return resolvePath(path);
+    }
+}
+export function load(path, readFileOptions) {
+    const finalPath = getPathToUse(path);
+    if (finalPath && existsSync(finalPath)) {
+        try {
+            // Can return a string or a NonSharedBuffer
+            const buffer = readFileSync(finalPath, readFileOptions);
+            return JSON.parse(buffer.toString());
+        }
+        catch (e) {
+            console.error(e.message);
+        }
+    }
+    // Used to return false, but caller expects an object, so something falsy that still fits the bill makes sense.  Its either that or letting the error bubble up
+    return undefined;
+}
+export function save(obj, path) {
+    const resolvedPath = getPathToUse(path);
+    if (resolvedPath) {
+        // Maybe we should try/catch here and return false if it fails?
+        // Load swallows errors, but save doesn't, which is a little weird
+        writeFileSync(resolvedPath, JSON.stringify(obj, null, '\t'));
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,21 @@
 {
 	"name": "command-line-config",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"main": "./index.js",
-	"type": "module"
-}
+	"type": "module",
+	"devDependencies": {
+		"@isoftdata/prettier-config-base": "^1.0.3",
+		"@tsconfig/node24": "^24.0.4",
+		"@types/node": "^25.2.3",
+		"typescript": "^5.9.3"
+	},
+	"files": [
+		"dist/**/*.js",
+		"dist/**/*.d.ts"
+	],
+	"scripts": {
+		"build": "tsc",
+		"build-watch": "tsc -w"
+	},
+	"prettier": "@isoftdata/prettier-config-base"
+}

package/readme.md

@@ -1,12 +1,14 @@
 # Command Line Config
 
 ## Install
+
 `npm i command-line-config`
 > Breaking change in version 2: ESM style exports
 
 ## Usage
 
 Quick and dirty loading/saving of JSON files.
+
 ```js
 import * as settings_access from 'command-line-config'
 //or...
@@ -16,6 +18,7 @@ let settings = settings_access.load('./some_file.json')
 settings.dumb = false
 settings_access.save(settings, './some_file.json')
 ```
+
 All paths are interpreted relative to the current working directory.
 
 If you don't specify a path to load, the module assumes the file was passed in via the command-line, like so: `node your-script.js config-file.json`
@@ -31,5 +34,3 @@ Which command-line argument will be interpreted as a file to be opened?  The fir
 All file-system interactions are done synchronously, which means you most likely only want to be interacting with it when your app launches/terminates (which is the most likely use case anyway).
 
 Written for ISoft Data Systems, licensed [WTFPL](http://wtfpl2.com).
-
-Moved to GitHub at [SVN revision 27057](http://svn.isoftdata.com/Web/javascript-trunk/command-line-config/?p=27057).

package/example.js

@@ -1,18 +0,0 @@
-// Test this by running: node example.js
-
-import * as commandLineConfig from './index.js'
-import { inspect } from 'node:util'
-
-let obj = commandLineConfig.load('example.json')
-
-console.log(inspect(obj))
-
-if (obj) {
-	obj.wat = !obj.wat
-
-	commandLineConfig.save(obj)
-}
-
-console.log(commandLineConfig.load('package.json'))
-commandLineConfig.save(obj, 'new_file.json')
-console.log(commandLineConfig.load('new_file.json'))

package/example.json

@@ -1,4 +0,0 @@
-{
-	"because I can": "butts",
-	"because I say so": "why not?"
-}

package/index.js

@@ -1,40 +0,0 @@
-import { existsSync, writeFileSync } from 'node:fs'
-import { resolve } from 'path'
-import { readFileSync } from 'node:fs'
-
-let safePath = null
-
-function resolvePath(path) {
-	return resolve(process.cwd(), path)
-}
-
-// Returns a resolved path based on the string passed in,
-// or returns a path based on the first argument passed in that resolves to a real file
-function getPathToUse(path) {
-	if (typeof path !== 'string') {
-		if (!safePath) {
-			safePath = process.argv.slice(2).map(resolvePath).filter(existsSync).shift() || null
-		}
-
-		return safePath
-	} else {
-		return resolvePath(path)
-	}
-}
-
-export function load(path, readFileOptions) {
-	path = getPathToUse(path)
-	if (existsSync(path)) {
-		try {
-			return JSON.parse(readFileSync(path, readFileOptions))
-		} catch (e) {
-			console.error(e.message)
-		}
-	}
-	return false
-}
-
-export function save(obj, path) {
-	path = getPathToUse(path)
-	return path ? writeFileSync(path, JSON.stringify(obj, null, '\t')) : false
-}

package/new_file.json

@@ -1,5 +0,0 @@
-{
-	"because I can": "butts",
-	"because I say so": "why not?",
-	"wat": true
-}