feat: normalize comments

fengzilong · Jul 25, 2021 · 62a5568 · 62a5568
1 parent 6ec6f2a
commit 62a5568
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ yarn add @biu/jsonlint
 # API
 
 ```js
-const { lint } = require( '@biu/jsonlint' )
+const lint = require( '@biu/jsonlint' )
 
 lint( string, options )
 ```
@@ -42,6 +42,16 @@ Default: `'pretty'`
 
 Values: `'pretty' | 'json'`
 
+If you use `json` reporter, the return value looks like:
+
+```js
+{
+  source: '', // source code
+  errors: [], // with keys: `{ line, column, message, severity }`
+  comments: [], // with keys: `{ start: { line, column }, end: { line, column } }`
+}
+```
+
 ### options.silent
 
 Type: `Boolean`

diff --git a/lib/index.js b/lib/index.js
@@ -26,7 +26,7 @@ function lint( text = '', options = {} ) {
   const result = {
     source: text,
     errors: normalizeErrors( errors, allowComments ? [] : comments ),
-    comments: comments,
+    comments: normalizeComments( comments ),
   }
 
   if ( reporter === 'pretty' ) {
@@ -73,6 +73,21 @@ function normalizeErrors( errors = [], comments = [] ) {
   )
 }
 
+function normalizeComments( comments = [] ) {
+  return comments.map( comment => {
+    return {
+      start: {
+        line: comment.start.line + 1,
+        column: comment.start.character + 1,
+      },
+      end: {
+        line: comment.end.line + 1,
+        column: comment.end.character + 1,
+      },
+    }
+  } )
+}
+
 function prettyReport( text, { errors = [] } = {} ) {
   if ( errors.length === 0 ) {
     return ''

diff --git a/test.js b/test.js
@@ -48,6 +48,8 @@ test( 'lint - reporter json', () => {
     reporter: 'json',
     allowComments: true
   } )
+
+  console.log( result.comments )
 
   expect( typeof result ).toBe( 'object' )
   expect( result.source ).toBe( string )