feat(DocumentParser): sort headers + meta-tags (#45)

* feat(DocumentParser): sort headers + meta-tags

* chore(version): bump

Author: gorillamoe

README.md

@@ -130,30 +130,30 @@ So a perfect request would look like this:
 @variables1 = value1
 
 
+### REQUEST_NAME_ONE
+
 # This is a comment
 # This is another comment
 # @someother metatag
-# @name REQUEST_NAME_ONE
 GET http://localhost:8080/api/v1/health HTTP/1.1
 Content-Type: application/json
 
 {
   "key": "value"
 }
-
-###
 ```
 
 or this:
 
 ```http
-@variables1=value1
+@variables1 = value1
+
 
+### REQUEST_NAME_ONE
 
 # This is a comment
 # This is another comment
 # @someother metatag
-# @name REQUEST_NAME_ONE
 GET http://localhost:8080/api/v1/health HTTP/2
 content-type: application/json
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mistweaverco/kulala-fmt",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "type": "module",
   "scripts": {
     "build": "rollup -c",

src/lib/parser/DocumentParser.ts

@@ -279,6 +279,14 @@ const parse = (content: string): Document | null => {
       block.metadata.length > 0 ||
       block.comments.length > 0
     ) {
+      // sort headers by key
+      block.request?.headers.sort((a, b) => {
+        return a.key.localeCompare(b.key);
+      });
+      // sort metadata by key
+      block.metadata.sort((a, b) => {
+        return a.key.localeCompare(b.key);
+      });
       blocks.push(block);
     }
   });
@@ -308,6 +316,11 @@ const parse = (content: string): Document | null => {
     }
   });
 
+  // sort variables by key
+  variables.sort((a, b) => {
+    return a.key.localeCompare(b.key);
+  });
+
   return { blocks, variables };
 };