comment-parser - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

CHANGELOG.md

@@ -0,1 +1,5 @@
+# v0.5.2
+- added TypeScript definitions
+- removed `readable-stream` dependency
+
 # v0.5.1
@@ -2,0 +6,0 @@ - Support for tab as separator between tag components.

index.js

@@ -5,3 +5,3 @@
 var fs = require('fs')
-var stream = require('readable-stream')
+var stream = require('stream')
 var util = require('util')
@@ -8,0 +8,0 @@

package.json

 {
   "name": "comment-parser",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Generic JSDoc-like comment parser. ",
@@ -9,7 +9,5 @@ "main": "index.js",
   },
-  "dependencies": {
-    "readable-stream": "^2.0.4"
-  },
+  "dependencies": {},
   "devDependencies": {
-    "chai": "~1.9.0",
+    "chai": "^4.2.0",
     "eslint": "^4.7.1",
@@ -21,4 +19,4 @@ "eslint-config-standard": "^10.2.1",
     "eslint-plugin-standard": "^3.0.1",
-    "mocha": "^3.5.3",
-    "nodemon": "^1.2.1"
+    "mocha": "^5.2.0",
+    "nodemon": "^1.18.9"
   },
@@ -44,2 +42,3 @@ "scripts": {
     "Evgeny Reznichenko (https://github.com/zxcabs)",
+    "Javier \"Ciberma\" Mora (https://github.com/jhm-ciberman)",
     "Jordan Harband (https://github.com/ljharb)",
@@ -46,0 +45,0 @@ "tengattack (https://github.com/tengattack)"

tests/parse.spec.js

@@ -615,3 +615,3 @@ /* eslint no-unused-vars:off */
        */
-    }, {dotted_names: true})[0])
+    }, { dotted_names: true })[0])
       .to.eql({
@@ -892,2 +892,64 @@ line: 1,
   })
+
+  it('should parse same line closing section (issue #22)', function () {
+    expect(parse(function () {
+      /**
+       * Start here
+       * Here is more stuff */
+      var a
+    })[0])
+      .to.eql({
+        description: 'Start here\nHere is more stuff',
+        line: 1,
+        source: 'Start here\nHere is more stuff',
+        tags: []
+      })
+  })
+
+  it('should tolerate inconsistent formatting (issue #29)', function () {
+    expect(parse(function () {
+      /**
+         * @param {Object} options 配置
+         * @return {Any} obj 组件返回的对象
+         * @example
+         * var widget = XX.showWidget('searchlist', {
+         *    onComplete: function() {
+         *          todoSomething();
+         *     }
+         * });
+     */
+    }, {
+      join: 1,
+      trim: false
+    })[0]).to.eql({
+      description: '',
+      line: 1,
+      source: "\n@param {Object} options 配置\n@return {Any} obj 组件返回的对象\n@example\nvar widget = XX.showWidget('searchlist', {\n   onComplete: function() {\n         todoSomething();\n    }\n});\n",
+      tags: [{
+        description: '配置',
+        line: 2,
+        name: 'options',
+        optional: false,
+        source: '@param {Object} options 配置',
+        tag: 'param',
+        type: 'Object'
+      }, {
+        description: '组件返回的对象',
+        line: 3,
+        name: 'obj',
+        optional: false,
+        source: '@return {Any} obj 组件返回的对象',
+        tag: 'return',
+        type: 'Any'
+      }, {
+        description: "widget = XX.showWidget('searchlist', {\n   onComplete: function() {\n         todoSomething();\n    }\n});\n",
+        line: 4,
+        name: '\nvar',
+        optional: false,
+        source: "@example\nvar widget = XX.showWidget('searchlist', {\n   onComplete: function() {\n         todoSomething();\n    }\n});\n",
+        tag: 'example',
+        type: ''
+      }]
+    })
+  })
 })

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

48716

increased by5.61%

Dependency count

0

decreased by-100%

Number of package files

16

increased by6.67%

Lines of code

1506

increased by5.83%

Dependency changes

• - Removedreadable-stream@^2.0.4

• - Removedcore-util-is@1.0.3(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedisarray@1.0.0(transitive)

• - Removedprocess-nextick-args@2.0.1(transitive)

• - Removedreadable-stream@2.3.8(transitive)

• - Removedsafe-buffer@5.1.2(transitive)

• - Removedstring_decoder@1.1.1(transitive)

• - Removedutil-deprecate@1.0.2(transitive)