@benev/argv - npm Package Compare versions

Comparing version 0.0.0-dev.0 to 0.0.0-dev.1

package.json

 {
 	"name": "@benev/argv",
-	"version": "0.0.0-dev.0",
+	"version": "0.0.0-dev.1",
 	"description": "command line argument parser",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

 
-# 🎛️ `@benev/argv` *command line argument parser*
+# 🎛️ `@benev/argv`
 
+***command line argument parser***
+
 🤖 for making node cli programs  
@@ -5,0 +7,0 @@ 🕵️‍♂️ designed for proper typescript typings

s/internals/machine.ts

@@ -8,3 +8,3 @@
 
-export function parsingStateMachine<A extends Argspec, P extends Paramspec>(
+export function parsingMachine<A extends Argspec, P extends Paramspec>(
 		spec: Spec<A, P>
@@ -14,3 +14,3 @@ ) {
 	let paramIndex = 0
-	let assignNextValueToField: undefined | keyof P = undefined // TODO rename param
+	let scheduledParamAssignment: undefined | keyof P = undefined
 
@@ -28,12 +28,12 @@ const getArgType = (name: keyof A) => spec.args[name]
 		isScheduledAsParamValue: () => {
-			return !!assignNextValueToField
+			return !!scheduledParamAssignment
 		},
 
 		scheduleNextItemAsParamValue: (item: string) => {
-			assignNextValueToField = item
+			scheduledParamAssignment = item
 		},
 
 		saveParam: (item: string) => {
-			const name = assignNextValueToField!
-			assignNextValueToField = undefined
+			const name = scheduledParamAssignment!
+			scheduledParamAssignment = undefined
 			params[name] = parseValue(getParamType(name), item)
@@ -40,0 +40,0 @@ },

s/parse.ts

@@ -6,3 +6,3 @@
 import {Paramspec} from "./types/paramspec.js"
-import {parsingStateMachine} from "./internals/machine.js"
+import {parsingMachine} from "./internals/machine.js"
 
@@ -25,3 +25,3 @@ export function parse<A extends Argspec, P extends Paramspec>(
 		scheduleNextItemAsParamValue,
-	} = parsingStateMachine(spec)
+	} = parsingMachine(spec)
 
@@ -28,0 +28,0 @@ for (const item of items) {

x/internals/machine.d.ts

 import { Spec } from "../types/spec.js";
 import { Argspec } from "../types/argspec.js";
 import { Paramspec } from "../types/paramspec.js";
-export declare function parsingStateMachine<A extends Argspec, P extends Paramspec>(spec: Spec<A, P>): {
+export declare function parsingMachine<A extends Argspec, P extends Paramspec>(spec: Spec<A, P>): {
     args: { [X in keyof A]?: import("../index.js").Primitive<A[X]> | undefined; };
@@ -6,0 +6,0 @@ params: { [X_1 in keyof P]?: import("../index.js").Primitive<P[X_1]> | undefined; };

x/internals/machine.js

 import { parseValue } from "./parse-value.js";
-export function parsingStateMachine(spec) {
+export function parsingMachine(spec) {
     let paramIndex = 0;
-    let assignNextValueToField = undefined; // TODO rename param
+    let scheduledParamAssignment = undefined;
     const getArgType = (name) => spec.args[name];
@@ -13,10 +13,10 @@ const getParamType = (name) => spec.params[name];
         isScheduledAsParamValue: () => {
-            return !!assignNextValueToField;
+            return !!scheduledParamAssignment;
         },
         scheduleNextItemAsParamValue: (item) => {
-            assignNextValueToField = item;
+            scheduledParamAssignment = item;
         },
         saveParam: (item) => {
-            const name = assignNextValueToField;
-            assignNextValueToField = undefined;
+            const name = scheduledParamAssignment;
+            scheduledParamAssignment = undefined;
             params[name] = parseValue(getParamType(name), item);
@@ -23,0 +23,0 @@ },

x/parse.js

@@ -1,2 +0,2 @@
-import { parsingStateMachine } from "./internals/machine.js";
+import { parsingMachine } from "./internals/machine.js";
 export function parse(spec) {
@@ -6,3 +6,3 @@ if (spec.argorder.length !== Object.keys(spec.args).length)
     const [executable, module, ...items] = spec.argv;
-    const { args, params, isScheduledAsParamValue, saveArg, saveParam, scheduleNextItemAsParamValue, } = parsingStateMachine(spec);
+    const { args, params, isScheduledAsParamValue, saveArg, saveParam, scheduleNextItemAsParamValue, } = parsingMachine(spec);
     for (const item of items) {
@@ -9,0 +9,0 @@ if (isScheduledAsParamValue())

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

73

increased by2.82%

Worsened metrics

Total package byte prevSize

17316

decreased by-0.4%

No dependency changes