arg - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

index.js

@@ -14,2 +14,6 @@ function arg(opts, {argv, permissive = false} = {}) {
 	for (const key of Object.keys(opts)) {
+		if (key[0] !== '-') {
+			throw new TypeError(`Argument key must start with '-' but found: '${key}'`);
+		}
+
 		if (typeof opts[key] === 'string') {
@@ -55,3 +59,5 @@ aliases[key] = opts[key];
 				} else {
-					throw new Error(`Unknown or unexpected option: ${originalArgName}`);
+					const err = new Error(`Unknown or unexpected option: ${originalArgName}`);
+					err.code = 'ARG_UNKNOWN_OPTION';
+					throw err;
 				}
@@ -58,0 +64,0 @@ }

package.json

 {
   "name": "arg",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Another simple argument parser",
   "main": "index.js",
+  "types": "index.d.ts",
   "repository": "zeit/arg",
@@ -10,3 +11,4 @@ "author": "Josh Junon <[e-mail]>",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
@@ -13,0 +15,0 @@ "scripts": {

README.md

@@ -161,4 +161,28 @@ # Arg
 
+#### Errors
+
+##### ARG_UNKNOWN_OPTION
+
+If an unknown option (not defined in the spec object) is passed, an error with code `ARG_UNKNOWN_OPTION` will be thrown:
+```js
+// cli.js
+try {
+  require('arg')({ '--hi': String });
+} catch (err) {
+  if (err.code === 'ARG_UNKNOWN_OPTION') {
+    console.log(err.message);
+  } else {
+    throw err;
+  }
+}
+```
+
+```shell
+node cli.js --extraneous true
+Unknown or unexpected option: --extraneous
+```
+
+
 # License
 
 Copyright © 2017-2018 by ZEIT, Inc. Released under the [MIT License](LICENSE.md).

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8928

increased by14.17%

Number of package files

5

increased by25%

Lines of code

99

increased by28.57%

Number of lines in readme file

188

increased by14.63%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes