command-line-config 1.4.1 → 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,5 +1,21 @@
 {
-  "name": "command-line-config",
-  "version": "1.4.1",
-  "main": "./index.js"
-}
+	"name": "command-line-config",
+	"version": "2.1.0",
+	"main": "./index.js",
+	"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,20 +1,33 @@
-Quick and dirty loading/saving of JSON files.
+# Command Line Config
+
+## Install
+
+`npm i command-line-config`
+> Breaking change in version 2: ESM style exports
 
+## Usage
 
-	var settings_access = require('command-line-config')
+Quick and dirty loading/saving of JSON files.
+
+```js
+import * as settings_access from 'command-line-config'
+//or...
+//import { load, save } from 'command-line-config'
 
-	var settings = settings_access.load('./some_file.json')
-	settings.dumb = false
-	settings_access.save(settings, './some_file.json')
+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`
 
-
-	var settings = settings_access.load()
-	settings.wat = "WHERE DID YOU COME FROM"
-	settings_access.save(settings)
+```js
+let settings = settings_access.load()
+settings.wat = "WHERE DID YOU COME FROM"
+settings_access.save(settings)
+```
 
 Which command-line argument will be interpreted as a file to be opened?  The first one to resolve to an actual file, of course!
 

package/example.js

@@ -1,16 +0,0 @@
-// Test this by running: node example.js config.json
-
-var config = require('./index.js')
-
-var obj = config.load()
-
-console.log(require('util').inspect(obj))
-
-if (obj) {
-	obj.wat = !obj.wat
-
-	config.save(obj)
-}
-
-console.log(config.load('package.json'))config.save(obj, 'new_file.json')
-console.log(config.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,41 +0,0 @@
-var fs = require('fs')
-var resolve = require('path').resolve
-
-var safe_path = 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 (!safe_path) {
-			safe_path = process.argv.slice(2).map(resolvePath).filter(fs.existsSync).shift() || null
-		}
-
-		return safe_path
-	} else {
-		return resolvePath(path)
-	}
-}
-
-module.exports = {
-	load: function(path) {
-		path = getPathToUse(path)
-		if (fs.existsSync(path)) {
-			try {
-				return require(path)
-			} catch (e) {
-				console.error(e.message)
-			}
-		}
-		return false
-	},
-	save: function(obj, path) {
-		var path = getPathToUse(path)
-		return path ? fs.writeFileSync(path, JSON.stringify(obj, null, "\t")) : false
-	}
-}
-