@node-cli/parser 1.0.2 → 2.1.0

package/README.md

@@ -6,13 +6,14 @@
 
 # API
 
-**parser(options) ⇒ { flags, parameters }**
+**parser(options) ⇒ { flags, parameters, showHelp }**
 
 ## Arguments
 
 | Argument                  | Type              |
 | ------------------------- | ----------------- |
 | options                   | Object            |
+| options.meta              | import.meta       |
 | options.examples          | Array of Object   |
 | options.flags             | Object            |
 | options.parameters        | Object            |
@@ -24,7 +25,9 @@
 
 ```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: [
 		{
 			command: 'my-cli --verbose --command "chmod +x" bin',
@@ -68,8 +71,16 @@ const { flags, parameters } = parser({
 		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

@@ -13,6 +13,7 @@ type Parameters = {
     };
 };
 export type ParserConfiguration = {
+    meta: any;
     flags?: Flags;
     parameters?: Parameters;
     usage?: boolean | string;
@@ -25,6 +26,7 @@ export type ParserConfiguration = {
     defaultParameters?: any;
 };
 export declare const parser: (configuration: ParserConfiguration) => {
+    showHelp: (exitCode?: number) => never;
     flags: object;
     parameters: object;
 };

package/dist/parser.js

@@ -1,16 +1,17 @@
 import { meowOptionsHelper, meowParserHelper, shallowMerge } from "./utilities.js";
 import meow from "meow";
 export const parser = (configuration)=>{
-    const { defaultFlags ={} , defaultParameters ={} , ...others } = configuration;
+    const { meta , defaultFlags ={} , defaultParameters ={} , ...others } = configuration;
     const { helpText , options  } = meowOptionsHelper(others);
     const cli = meow(helpText, {
         ...options,
-        importMeta: import.meta
+        importMeta: meta
     });
     meowParserHelper({
         cli
     });
     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\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\tdefaultFlags = {},\n\t\tdefaultParameters = {},\n\t\t...others\n\t} = configuration;\n\tconst { helpText, options } = meowOptionsHelper(others);\n\tconst cli = meow(helpText, { ...options, importMeta: import.meta });\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","defaultFlags","defaultParameters","others","helpText","options","cli","importMeta","flags","parameters","input"],"mappings":"AAAA,SACCA,iBAAiB,EACjBC,gBAAgB,EAChBC,YAAY,QACN,iBAAiB;AAExB,OAAOC,UAAU,OAAO;AA2BxB,OAAO,MAAMC,SAAS,CAACC;IACtB,MAAM,EACLC,cAAe,CAAC,EAAC,EACjBC,mBAAoB,CAAC,EAAC,EACtB,GAAGC,QACH,GAAGH;IACJ,MAAM,EAAEI,SAAQ,EAAEC,QAAO,EAAE,GAAGV,kBAAkBQ;IAChD,MAAMG,MAAMR,KAAKM,UAAU;QAAE,GAAGC,OAAO;QAAEE,YAAY;IAAY;IACjEX,iBAAiB;QAAEU;IAAI;IAEvB,OAAO;QACNE,OAAOX,aAAaI,cAAcK,IAAIE;QACtCC,YAAYZ,aAAaK,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};\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\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","others","helpText","options","cli","importMeta","showHelp","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,UAAUF,IAAIE;QACdC,OAAOb,aAAaK,cAAcK,IAAIG;QACtCC,YAAYd,aAAaM,mBAAmBI,IAAIK;IACjD;AACD,EAAE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@node-cli/parser",
-	"version": "1.0.2",
+	"version": "2.1.0",
 	"license": "MIT",
 	"author": "Arno Versini",
 	"description": "A simple CLI parser helper",
@@ -24,7 +24,7 @@
 		"build:js": "swc --source-maps --out-dir dist src",
 		"build:types": "tsc",
 		"clean": "rimraf dist types coverage",
-		"lint": "eslint \"src/*.ts\"",
+		"lint": "prettier --write \"src/*.ts\" && eslint --fix \"src/*.ts\"",
 		"test": "cross-env-shell NODE_OPTIONS=--experimental-vm-modules jest",
 		"test:coverage": "npm run test -- --coverage",
 		"watch": "swc --watch --out-dir dist src"
@@ -32,5 +32,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "d1d89854e385600edfd9c2aead7c9bc568bcc657"
+	"gitHead": "04fc495165a21ef51a94175dac632e733759eab4"
 }