format-javascript-comment - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

lib/formatCommentLines.js

@@ -7,4 +7,16 @@ 'use babel';
 const JSDOC_TAGS = [
-  '@author', '@constructor', '@deprecated', '@exception', '@exports', '@param',
-  '@private', '@return', '@returns', '@see', '@this', '@throws', '@version'
+  '@author',
+  '@constructor',
+  '@deprecated',
+  '@exception',
+  '@exports',
+  '@param',
+  '@private',
+  '@property',
+  '@return',
+  '@returns',
+  '@see',
+  '@this',
+  '@throws',
+  '@version'
 ];
@@ -11,0 +23,0 @@

package.json

 {
   "name": "format-javascript-comment",
   "main": "./lib/index",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "author": "Jan Amann <[e-mail]>",
@@ -6,0 +6,0 @@ "description": "Format your JavaScript comments",

README.md

@@ -24,6 +24,5 @@ # Format JavaScript comment for Atom
  - Configurable line length
- - Retain blank lines
- - Ignore JSDoc first and last line
+ - Retain blank lines (already supported if the line is completely empty)
  - Ignore non-comment lines
  - Create a selection range across all modified lines at the end
  - Support multiple cursors

spec/format-comment-spec.js

@@ -98,15 +98,26 @@ /* eslint-disable max-len */
 
-    it('works for JSDoc', () => {
-      expect(formatCommentLines([
-        '  * Description',
-        '  * @param {string} test Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do.',
-        '  * @param {string} [test = 2] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
-      ])).toEqual([
-        '  * Description',
-        '  * @param {string} test Lorem ipsum dolor sit',
-        '  * amet, consectetur adipisicing elit, sed do.',
-        '  * @param {string} [test = 2] Lorem ipsum dolor sit',
-        '  * amet, consectetur adipisicing elit, sed do eiusmod',
-        '  * tempor incididunt ut labore et dolore magna aliqua.'
-      ]);
+    describe('JSDOC', () => {
+      it('supports @param', () => {
+        expect(formatCommentLines([
+          '  * Description',
+          '  * @param {string} test Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do.',
+          '  * @param {string} [test = 2] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.'
+        ])).toEqual([
+          '  * Description',
+          '  * @param {string} test Lorem ipsum dolor sit',
+          '  * amet, consectetur adipisicing elit, sed do.',
+          '  * @param {string} [test = 2] Lorem ipsum dolor sit',
+          '  * amet, consectetur adipisicing elit, sed do eiusmod',
+          '  * tempor incididunt ut labore et dolore magna aliqua.'
+        ]);
+      });
+      it('supports @property', () => {
+        expect(formatCommentLines([
+          '  * Description',
+          '  * @property {string} test Lorem ipsum'
+        ])).toEqual([
+          '  * Description',
+          '  * @property {string} test Lorem ipsum'
+        ]);
+      });
     });
@@ -113,0 +124,0 @@

No alert changes

Improved metrics

Total package byte prevSize

477834

increased by0.08%

Lines of code

322

increased by7.69%

Worsened metrics

Number of lines in readme file

28

decreased by-3.45%

No dependency changes