command-line-config 1.4.1 → 2.0.0

package/example.js

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

package/index.js

@@ -1,7 +1,8 @@
-var fs = require('fs')
-var resolve = require('path').resolve
+import { existsSync, writeFileSync } from 'node:fs'
+import { resolve } from 'path'
+import { readFileSync } from 'node:fs'
 
-var safe_path = null
+let safePath = null
 
 function resolvePath(path) {
 	return resolve(process.cwd(), path)
@@ -11,31 +12,29 @@ function resolvePath(path) {
 // 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
+		if (!safePath) {
+			safePath = process.argv.slice(2).map(resolvePath).filter(existsSync).shift() || null
 		}
 
-		return safe_path
+		return safePath
 	} 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)
-			}
+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
-	},
-	save: function(obj, path) {
-		var path = getPathToUse(path)
-		return path ? fs.writeFileSync(path, JSON.stringify(obj, null, "\t")) : false
 	}
+	return false
 }
 
+export function save(obj, path) {
+	path = getPathToUse(path)
+	return path ? writeFileSync(path, JSON.stringify(obj, null, '\t')) : false
+}

package/new_file.json

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

package/package.json

@@ -1,5 +1,6 @@
 {
-  "name": "command-line-config",
-  "version": "1.4.1",
-  "main": "./index.js"
+	"name": "command-line-config",
+	"version": "2.0.0",
+	"main": "./index.js",
+	"type": "module"
 }

package/readme.md

@@ -1,23 +1,35 @@
-Quick and dirty loading/saving of JSON files.
-
+# Command Line Config
 
-	var settings_access = require('command-line-config')
+## Install
+`npm i command-line-config`
+> Breaking change in version 2: ESM style exports
 
-	var settings = settings_access.load('./some_file.json')
-	settings.dumb = false
-	settings_access.save(settings, './some_file.json')
+## Usage
 
+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'
+
+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!
 
 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).