argufy - npm Package Compare versions

Comparing version 1.3.2 to 1.3.3

build/index.js

@@ -42,3 +42,3 @@ /**
  * Parse the config and extract arguments from the `process.argv` array.
- * @param {Config} config The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
+ * @param {!ArgufyConfig} config The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
  *
@@ -72,4 +72,4 @@ * - __short__ Shorthand for this argument, usually one letter.
  *
- * @param {Array<string>} [args] Array with arguments to parse. `process.argv` is used by default. It is assumed that user arguments start from the 3rd position.
- * @returns {Object.<string, string|Array<string>|boolean|number>} An object with all found values for the configuration request.
+ * @param {!Array<string>} [args] Array with arguments to parse. `process.argv` is used by default. It is assumed that user arguments start from the 3rd position.
+ * @returns {Object<string, string|Array<string>|boolean|number>} An object with all found values for the configuration request.
  */
@@ -125,2 +125,7 @@ function argufy(config = {}, args = process.argv) {
 /**
+ * @suppress {nonStandardJsDocs}
+ * @typedef {Object<string, string|!Flag>} ArgufyConfig The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
+ */
+/**
+ * @suppress {nonStandardJsDocs}
  * @typedef {Object} Flag The flag passed to the program.
@@ -134,6 +139,3 @@ * @prop {string} [short] Shorthand for this argument, usually one letter.
 
-/**
- * @typedef {Object.<string, (string|Flag)>} Config
- */
 
 module.exports = argufy

CHANGELOG.md

@@ -0,1 +1,7 @@
+## 5 April 2019
+
+### [1.3.3](https://github.com/artdecocode/argufy/compare/v1.3.2...v1.3.3)
+
+- [package] Add externs and adjust types for _Google Closure Compiler_ via _Depack_.
+
 ## 14 January 2019
@@ -2,0 +8,0 @@

package.json

 {
   "name": "argufy",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "Parse command line arguments to Node.js CLI programs.",
@@ -16,3 +16,4 @@ "main": "build",
     "d": "NODE_DEBUG=doc doc src/index.js -g",
-    "e": "node example",
+    "externs": "NODE_DEBUG=doc doc externs.js -g --externs",
+    "e": "alanode",
     "example/": "yarn e example/example.js",
@@ -24,4 +25,6 @@ "build": "yarn-s d b doc",
     "build",
-    "src"
+    "src",
+    "externs.js"
   ],
+  "externs": "externs.js",
   "repository": {
@@ -41,7 +44,7 @@ "type": "git",
   "devDependencies": {
-    "alamode": "1.6.1",
-    "documentary": "1.20.1",
+    "alamode": "^1.9.2",
+    "documentary": "^1.23.4",
     "yarn-s": "1.1.0",
-    "zoroaster": "3.6.6"
+    "zoroaster": "^3.11.4"
   }
 }

README.md

@@ -57,6 +57,5 @@ # argufy
 ```sh
-node example.js --title Hello_World -w 10 -l -app Argufy
+node example.js --title "Hello World" -w 10 -l -app Argufy
 # or
-node example.js Hello_World -w 10 -l -app Argufy
-# no support "for arguments with space"
+node example.js HelloWorld -w 10 -l -app Argufy
 ```
@@ -67,3 +66,3 @@
   "_argv": [],
-  "title": "Hello_World",
+  "title": "HelloWorld",
   "list": true,
@@ -70,0 +69,0 @@ "app": "Argufy",

src/index.js

@@ -42,3 +42,3 @@ /**
  * Parse the config and extract arguments from the `process.argv` array.
- * @param {Config} config The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
+ * @param {!ArgufyConfig} config The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
  *
@@ -72,4 +72,4 @@ * - __short__ Shorthand for this argument, usually one letter.
  *
- * @param {Array<string>} [args] Array with arguments to parse. `process.argv` is used by default. It is assumed that user arguments start from the 3rd position.
- * @returns {Object.<string, string|Array<string>|boolean|number>} An object with all found values for the configuration request.
+ * @param {!Array<string>} [args] Array with arguments to parse. `process.argv` is used by default. It is assumed that user arguments start from the 3rd position.
+ * @returns {Object<string, string|Array<string>|boolean|number>} An object with all found values for the configuration request.
  */
@@ -125,2 +125,7 @@ export default function argufy(config = {}, args = process.argv) {
 /**
+ * @suppress {nonStandardJsDocs}
+ * @typedef {Object<string, string|!Flag>} ArgufyConfig The configuration for parsing, where each key is a flag and values are either strings, or objects with possible properties:
+ */
+/**
+ * @suppress {nonStandardJsDocs}
  * @typedef {Object} Flag The flag passed to the program.
@@ -133,5 +138,1 @@ * @prop {string} [short] Shorthand for this argument, usually one letter.
  */
-
-/**
- * @typedef {Object.<string, (string|Flag)>} Config
- */

No alert changes

Improved metrics

Total package byte prevSize

15752

increased by6.55%

Number of package files

7

increased by16.67%

Lines of code

267

increased by7.23%

Worsened metrics

Number of lines in readme file

93

decreased by-1.06%

No dependency changes