@node-cli/parser 2.0.0 → 2.2.0

package/README.md

@@ -6,7 +6,7 @@
 
 # API
 
-**parser(options) ⇒ { flags, parameters }**
+**parser(options) ⇒ { flags, parameters, showHelp }**
 
 ## Arguments
 
@@ -17,6 +17,7 @@
 | options.examples          | Array of Object   |
 | options.flags             | Object            |
 | options.parameters        | Object            |
+| options.restrictions      | Array of Object   |
 | options.usage             | String or Boolean |
 | options.defaultFlags      | Object            |
 | options.defaultParameters | Object            |
@@ -25,7 +26,8 @@
 
 ```js
 import { parser } from "@node-cli/parser";
-const { flags, parameters } = parser({
+
+const { flags, parameters, showHelp } = parser({
 	meta: import.meta, // this is required for --version to work correctly
 	examples: [
 		{
@@ -34,6 +36,16 @@ const { flags, parameters } = parser({
 		},
 	],
 	flags: {
+		encrypt: {
+			shortFlag: "e",
+			description: "Encrypt the file",
+			type: "boolean",
+		},
+		decrypt: {
+			shortFlag: "d",
+			description: "Decrypt the file",
+			type: "boolean",
+		},
 		verbose: {
 			shortFlag: "V",
 			description: "Enable extra logging",
@@ -64,14 +76,30 @@ const { flags, parameters } = parser({
 			description: "the destination",
 		},
 	},
+	restrictions: [
+		{
+			exit: 1,
+			message: () =>
+				log.error("Error: --encrypt or --decrypt option must be provided."),
+			test: (x) => x.encrypt === false && x.decrypt === false,
+		},
+	],
 	// use usage:true is equivalent to the following line
 	usage: "my-cli [options] [src] [dest]",
 	defaultFlags: {
 		verbose: false,
 	},
 });
+
+// `flags` will be an object with what the user provided
+// `parameters` will be an object with what the user provided
+// `showHelp` is a method that can be invoked to display help instructions
 ```
 
 ## Note
 
 If options `--version` or `--help` are used, they will automatically print version or help, respectively, and exit with 0 (`process.exit(0)`).
+
+## License
+
+MIT © Arno Versini

package/dist/parser.d.ts

@@ -12,6 +12,11 @@ type Parameters = {
         description: string;
     };
 };
+type Restriction = {
+    exit: number;
+    message: string | (() => void);
+    test: (value: any) => boolean;
+};
 export type ParserConfiguration = {
     meta: any;
     flags?: Flags;
@@ -24,8 +29,10 @@ export type ParserConfiguration = {
     }[];
     defaultFlags?: any;
     defaultParameters?: any;
+    restrictions?: Restriction[];
 };
 export declare const parser: (configuration: ParserConfiguration) => {
+    showHelp: (exitCode?: number) => never;
     flags: object;
     parameters: object;
 };

package/dist/parser.js

@@ -1,16 +1,18 @@
 import { meowOptionsHelper, meowParserHelper, shallowMerge } from "./utilities.js";
 import meow from "meow";
 export const parser = (configuration)=>{
-    const { meta , defaultFlags ={} , defaultParameters ={} , ...others } = configuration;
+    const { meta , defaultFlags ={} , defaultParameters ={} , restrictions , ...others } = configuration;
     const { helpText , options  } = meowOptionsHelper(others);
     const cli = meow(helpText, {
         ...options,
         importMeta: meta
     });
     meowParserHelper({
-        cli
+        cli,
+        restrictions
     });
     return {
+        showHelp: cli.showHelp,
         flags: shallowMerge(defaultFlags, cli.flags),
         parameters: shallowMerge(defaultParameters, cli.input)
     };

package/dist/parser.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/parser.ts"],"sourcesContent":["import {\n\tmeowOptionsHelper,\n\tmeowParserHelper,\n\tshallowMerge,\n} from \"./utilities.js\";\n\nimport meow from \"meow\";\n\ntype Flags = {\n\t[key: string]: {\n\t\tshortFlag?: string;\n\t\tdefault?: string | number | boolean;\n\t\tdescription: string;\n\t\ttype: string;\n\t};\n};\ntype Parameters = {\n\t[key: string]: {\n\t\tdefault?: string | number | boolean;\n\t\tdescription: string;\n\t};\n};\nexport type ParserConfiguration = {\n\tmeta: any;\n\tflags?: Flags;\n\tparameters?: Parameters;\n\tusage?: boolean | string;\n\texamples?:\n\t\t| string\n\t\t| { command?: string; description?: string; comment?: string }[];\n\tdefaultFlags?: any;\n\tdefaultParameters?: any;\n};\n\nexport const parser = (configuration: ParserConfiguration) => {\n\tconst {\n\t\tmeta,\n\t\tdefaultFlags = {},\n\t\tdefaultParameters = {},\n\t\t...others\n\t} = configuration;\n\tconst { helpText, options } = meowOptionsHelper(others);\n\tconst cli = meow(helpText, {\n\t\t...options,\n\t\timportMeta: meta,\n\t});\n\tmeowParserHelper({ cli });\n\n\treturn {\n\t\tflags: shallowMerge(defaultFlags, cli.flags),\n\t\tparameters: shallowMerge(defaultParameters, cli.input),\n\t};\n};\n"],"names":["meowOptionsHelper","meowParserHelper","shallowMerge","meow","parser","configuration","meta","defaultFlags","defaultParameters","others","helpText","options","cli","importMeta","flags","parameters","input"],"mappings":"AAAA,SACCA,iBAAiB,EACjBC,gBAAgB,EAChBC,YAAY,QACN,iBAAiB;AAExB,OAAOC,UAAU,OAAO;AA4BxB,OAAO,MAAMC,SAAS,CAACC;IACtB,MAAM,EACLC,KAAI,EACJC,cAAe,CAAC,EAAC,EACjBC,mBAAoB,CAAC,EAAC,EACtB,GAAGC,QACH,GAAGJ;IACJ,MAAM,EAAEK,SAAQ,EAAEC,QAAO,EAAE,GAAGX,kBAAkBS;IAChD,MAAMG,MAAMT,KAAKO,UAAU;QAC1B,GAAGC,OAAO;QACVE,YAAYP;IACb;IACAL,iBAAiB;QAAEW;IAAI;IAEvB,OAAO;QACNE,OAAOZ,aAAaK,cAAcK,IAAIE;QACtCC,YAAYb,aAAaM,mBAAmBI,IAAII;IACjD;AACD,EAAE"}
+{"version":3,"sources":["../src/parser.ts"],"sourcesContent":["import {\n\tmeowOptionsHelper,\n\tmeowParserHelper,\n\tshallowMerge,\n} from \"./utilities.js\";\n\nimport meow from \"meow\";\n\ntype Flags = {\n\t[key: string]: {\n\t\tshortFlag?: string;\n\t\tdefault?: string | number | boolean;\n\t\tdescription: string;\n\t\ttype: string;\n\t};\n};\ntype Parameters = {\n\t[key: string]: {\n\t\tdefault?: string | number | boolean;\n\t\tdescription: string;\n\t};\n};\ntype Restriction = {\n\texit: number;\n\tmessage: string | (() => void);\n\ttest: (value: any) => boolean;\n};\n\nexport type ParserConfiguration = {\n\tmeta: any;\n\tflags?: Flags;\n\tparameters?: Parameters;\n\tusage?: boolean | string;\n\texamples?:\n\t\t| string\n\t\t| { command?: string; description?: string; comment?: string }[];\n\tdefaultFlags?: any;\n\tdefaultParameters?: any;\n\trestrictions?: Restriction[];\n};\n\nexport const parser = (configuration: ParserConfiguration) => {\n\tconst {\n\t\tmeta,\n\t\tdefaultFlags = {},\n\t\tdefaultParameters = {},\n\t\trestrictions,\n\t\t...others\n\t} = configuration;\n\tconst { helpText, options } = meowOptionsHelper(others);\n\tconst cli = meow(helpText, {\n\t\t...options,\n\t\timportMeta: meta,\n\t});\n\tmeowParserHelper({ cli, restrictions });\n\n\treturn {\n\t\tshowHelp: cli.showHelp,\n\t\tflags: shallowMerge(defaultFlags, cli.flags),\n\t\tparameters: shallowMerge(defaultParameters, cli.input),\n\t};\n};\n"],"names":["meowOptionsHelper","meowParserHelper","shallowMerge","meow","parser","configuration","meta","defaultFlags","defaultParameters","restrictions","others","helpText","options","cli","importMeta","showHelp","flags","parameters","input"],"mappings":"AAAA,SACCA,iBAAiB,EACjBC,gBAAgB,EAChBC,YAAY,QACN,iBAAiB;AAExB,OAAOC,UAAU,OAAO;AAmCxB,OAAO,MAAMC,SAAS,CAACC;IACtB,MAAM,EACLC,KAAI,EACJC,cAAe,CAAC,EAAC,EACjBC,mBAAoB,CAAC,EAAC,EACtBC,aAAY,EACZ,GAAGC,QACH,GAAGL;IACJ,MAAM,EAAEM,SAAQ,EAAEC,QAAO,EAAE,GAAGZ,kBAAkBU;IAChD,MAAMG,MAAMV,KAAKQ,UAAU;QAC1B,GAAGC,OAAO;QACVE,YAAYR;IACb;IACAL,iBAAiB;QAAEY;QAAKJ;IAAa;IAErC,OAAO;QACNM,UAAUF,IAAIE;QACdC,OAAOd,aAAaK,cAAcM,IAAIG;QACtCC,YAAYf,aAAaM,mBAAmBK,IAAIK;IACjD;AACD,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/parser",
-	"version": "2.0.0",
+	"version": "2.2.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A simple CLI parser helper",
@@ -32,5 +32,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "5d4bd8b98b32bdd62be28061190fe766767ec7f7"
+	"gitHead": "9c4baafbf51504c8b9ec3c8434f06be73bd2b23f"
 }