webext-schema - npm Package Compare versions

Comparing version 1.2.14 to 1.2.15

modules/common.js

@@ -11,3 +11,4 @@ /**
  * throw error
- * @param {!Object} e - Error
+ *
+ * @param {!object} e - Error
  * @throws - Error
@@ -21,3 +22,4 @@ */
  * log error
- * @param {!Object} e - Error
+ *
+ * @param {!object} e - Error
  * @returns {boolean} - false
@@ -32,2 +34,3 @@ */
  * log warn
+ *
  * @param {*} msg - message
@@ -43,2 +46,3 @@ * @returns {boolean} - false
  * log message
+ *
  * @param {*} msg - message
@@ -54,2 +58,3 @@ * @returns {*} - message
  * get type
+ *
  * @param {*} o - object to check
@@ -63,2 +68,3 @@ * @returns {string} - type of object
  * is object, and not an empty object
+ *
  * @param {*} o - object to check;
@@ -74,2 +80,3 @@ * @returns {boolean} - result
  * is string
+ *
  * @param {*} o - object to check
@@ -82,2 +89,3 @@ * @returns {boolean} - result
  * stringify positive integer
+ *
  * @param {number} i - integer
@@ -92,2 +100,3 @@ * @param {boolean} [zero] - treat 0 as a positive integer
  * escape matching char
+ *
  * @param {string} str - argument
@@ -103,2 +112,3 @@ * @param {RegExp} re - RegExp
  * strip HTML tags and decode HTML entities
+ *
  * @param {string} v - value
@@ -105,0 +115,0 @@ * @returns {string} - converted value

modules/file-util.js

@@ -21,2 +21,3 @@ /**
  * convert URI to native file path
+ *
  * @param {string} uri - URI
@@ -39,2 +40,3 @@ * @returns {?string} - file path
  * get absolute path
+ *
  * @param {string} file - file path
@@ -53,4 +55,5 @@ * @returns {?string} - absolute file path
  * get stat
+ *
  * @param {string} file - file path
- * @returns {Object} - file stat
+ * @returns {object} - file stat
  */
@@ -62,2 +65,3 @@ const getStat = file =>
  * the directory is a directory
+ *
  * @param {string} dir - directory path
@@ -73,2 +77,3 @@ * @returns {boolean} - result
  * the directory is a subdirectory of a certain directory
+ *
  * @param {string} dir - directory path
@@ -83,2 +88,3 @@ * @param {string} baseDir - base directory path
  * the file is a file
+ *
  * @param {string} file - file path
@@ -96,2 +102,3 @@ * @returns {boolean} - result
  * files like `.exe`, which is 100666 in octal.
+ *
  * @param {string} file - file path
@@ -110,2 +117,3 @@ * @param {number} [mask] - mask bit
  * get file timestamp
+ *
  * @param {string} file - file path
@@ -121,2 +129,3 @@ * @returns {number} - timestamp
  * get file name from native file path
+ *
  * @param {string} file - file path
@@ -136,2 +145,3 @@ * @param {string} [subst] - substitute file name
  * remove the directory and it's files
+ *
  * @param {string} dir - directory path
@@ -161,2 +171,3 @@ * @param {string} baseDir - base directory path
  * remove the directory and it's files
+ *
  * @param {string} dir - directory path
@@ -172,2 +183,3 @@ * @param {string} baseDir - base directory path
  * create a directory
+ *
  * @param {string} dir - directory path to create
@@ -195,5 +207,6 @@ * @param {number} [mode] - permission
  * create a file
+ *
  * @param {string} file - file path to create
  * @param {string|Buffer|Uint8Array} value - value to write
- * @param {Object} [opt] - options
+ * @param {object} [opt] - options
  * @param {string} [opt.encoding] - encoding
@@ -223,4 +236,5 @@ * @param {string} [opt.flag] - flag
  * read a file
+ *
  * @param {string} file - file path
- * @param {Object} [opt] - options
+ * @param {object} [opt] - options
  * @param {string} [opt.encoding] - encoding
@@ -227,0 +241,0 @@ * @param {string} [opt.flag] - flag

modules/schema.js

@@ -19,7 +19,8 @@ /**
    * construct
-   * @param {...(string|Object)} [args] - optional arguments
+   *
+   * @param {...(string|object)} [args] - optional arguments
    *                                      {string} - release channel.
    *                                                 one of "beta", "central",
    *                                                 "release", "esr", "mail".
-   *                                      {Object} - sinon config
+   *                                      {object} - sinon config
    */
@@ -53,4 +54,5 @@ constructor(...args) {
    * get target from namespace key
+   *
    * @param {string} key - namespace key
-   * @returns {Object} - target object
+   * @returns {object} - target object
    */
@@ -80,2 +82,3 @@ _getTargetFromNamespace(key) {
    * assign imported values
+   *
    * @returns {void}
@@ -108,2 +111,3 @@ */
    * assign referred values
+   *
    * @returns {void}
@@ -136,5 +140,6 @@ */
    * mock events
-   * @param {Object} target - target object
+   *
+   * @param {object} target - target object
    * @param {Array} events - events
-   * @returns {Object} - target object
+   * @returns {object} - target object
    */
@@ -162,5 +167,6 @@ _mockEvents(target, events) {
    * mock functions
-   * @param {Object} target - target object
+   *
+   * @param {object} target - target object
    * @param {Array} funcs - functions
-   * @returns {Object} - target object
+   * @returns {object} - target object
    */
@@ -185,6 +191,7 @@ _mockFunctions(target, funcs) {
    * mock properties
-   * @param {Object} target - target object
-   * @param {Object} props - properties
+   *
+   * @param {object} target - target object
+   * @param {object} props - properties
    * @param {string} namespace - namespace
-   * @returns {Object} - target object
+   * @returns {object} - target object
    */
@@ -226,6 +233,7 @@ _mockProperties(target, props, namespace) {
    * mock types
-   * @param {Object} target - target object
+   *
+   * @param {object} target - target object
    * @param {Array} types - types
    * @param {string} namespace - namespace
-   * @returns {Object} - target object
+   * @returns {object} - target object
    */
@@ -264,3 +272,4 @@ _mockTypes(target, types, namespace) {
    * parse schema content
-   * @returns {Object} - schema
+   *
+   * @returns {object} - schema
    */
@@ -283,2 +292,3 @@ _parseSchemaContent() {
    * get schema
+   *
    * @param {string} name - API name or file name
@@ -306,3 +316,4 @@ * @returns {Array} - schema
    * get all schemas
-   * @returns {Object} - schemas
+   *
+   * @returns {object} - schemas
    */
@@ -316,2 +327,3 @@ getAll() {
    * list schemas
+   *
    * @returns {Array} - file list
@@ -331,3 +343,4 @@ */
    * mock browser api
-   * @returns {Object} - stubbed browser api
+   *
+   * @returns {object} - stubbed browser api
    */
@@ -334,0 +347,0 @@ mock() {

modules/update.js

@@ -24,2 +24,3 @@ /**
  * fetch text
+ *
  * @param {string} url - URL
@@ -43,2 +44,3 @@ * @returns {string} - content text
  * get channel url
+ *
  * @param {string} channel - release channel
@@ -70,5 +72,6 @@ * @returns {string} - channel URL
  * get schema data
+ *
  * @param {string} file - file name
  * @param {string} baseUrl - base URL
- * @returns {Object} - schema data
+ * @returns {object} - schema data
  */
@@ -92,2 +95,3 @@ const getSchemaData = async (file, baseUrl) => {
  * get schema file list from jar manifest
+ *
  * @param {string} baseUrl - base URL
@@ -118,4 +122,5 @@ * @returns {Array} - schema file list
  * get all schema data
+ *
  * @param {string} baseUrl - base URL
- * @returns {Array} - schemas data in array
+ * @returns {Promise.<Array>} - schemas data in array
  */
@@ -136,5 +141,6 @@ const getAllSchemaData = async baseUrl => {
  * get listed schema data
+ *
  * @param {string} baseUrl - base URL
  * @param {Array} arr - array of schema file names
- * @returns {Array} - schema data in array
+ * @returns {Promise.<Array>} - schema data in array
  */
@@ -157,2 +163,3 @@ const getListedSchemaData = async (baseUrl, arr) => {
  * get MailExtensions schema data
+ *
  * @param {string} baseUrl - base URL
@@ -182,4 +189,5 @@ * @returns {Promise.<Array>} - results of each handler
  * create unified schema
+ *
  * @param {string} channel - release channel
- * @returns {Object} - schema
+ * @returns {object} - schema
  */
@@ -225,2 +233,3 @@ const createUnifiedSchema = async channel => {
  * save schema file
+ *
  * @param {string} channel - release channel
@@ -250,4 +259,5 @@ * @param {boolean} info - console info
  * update schemas files
- * @param {Object} cmdOpts - command options
- * @returns {Promise.<Array>} - Promise chain
+ *
+ * @param {object} cmdOpts - command options
+ * @returns {Promise.<Array|Error>} - promise chain
  */
@@ -273,2 +283,3 @@ const updateSchemas = (cmdOpts = {}) => {
  * parse command
+ *
  * @param {Array} args - process.argv
@@ -275,0 +286,0 @@ * @returns {void}

package.json

@@ -34,7 +34,8 @@ {
     "chai": "^4.2.0",
-    "eslint": "^6.8.0",
-    "mocha": "^7.1.2",
+    "eslint": "^7.1.0",
+    "eslint-plugin-jsdoc": "^25.4.2",
+    "mocha": "^7.2.0",
     "nyc": "^15.0.1"
   },
-  "version": "1.2.14"
+  "version": "1.2.15"
 }

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

Total package byte prevSize

3086687

increased by0.34%

Lines of code

87161

increased by0.43%

Worsened metrics

Dev dependency count

5

increased by25%

No dependency changes