From 7303c83e2baa3df2fc37a2d4c8710975d13f16b0 Mon Sep 17 00:00:00 2001
From: ache <ache@ache.one>
Date: Tue, 24 Apr 2018 00:58:51 +0200
Subject: Update comments

---
 src/index.js | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

diff --git a/src/index.js b/src/index.js
index ac3c426..9992704 100644
--- a/src/index.js
+++ b/src/index.js
@@ -29,7 +29,8 @@ function parse(value, indexNext = 0) {
    * .azcv <- class
    * #poi <- id
    * dfgh=zert <- key
-   * lkj <- this is also a key but with a undefined value
+   * jkj <- this is also a key but with a undefined value
+   * jkj= <- this is also a key but with a empty value
    */
   let type;
   const forbidenCharacters = '\n\r{}';
@@ -61,7 +62,7 @@ function parse(value, indexNext = 0) {
 
     return shouldStop();
   };
-  const eatUntil = (chars, shouldSave) => {
+  const eatUntil = chars => {
     eaten = '';
 
     while (indexNext < value.length &&
@@ -73,19 +74,21 @@ function parse(value, indexNext = 0) {
     }
 
     // Ugly but keep the main loop readable
-    if (shouldSave) {
-      if (labelFirst) {
-        labelSecond = eaten;
-      } else {
-        labelFirst = eaten;
-      }
+    // Set the label it should set
+    if (labelFirst) {
+      labelSecond = eaten;
+    } else {
+      labelFirst = eaten;
     }
 
     return shouldStop();
   };
 
+  // In quote, every character is valid exept the unescaped quotes and CR or LF
+  // Same function for single and double quote
   const eatInQuote = quote => {
     eaten = '';
+    // First check so value[indexNext-1] will always be valid
     if (value[indexNext] === quote) {
       return;
     }
@@ -97,6 +100,8 @@ function parse(value, indexNext = 0) {
       eaten += value.charAt(indexNext);
       indexNext++;
     }
+    // If we encounter an EOL, there is an error
+    // We are waiting for a quote
     if (value[indexNext] === '\n' || value[indexNext] === '\r' || indexNext >= value.length) {
       errorDetected = true;
       return true;
@@ -114,8 +119,10 @@ function parse(value, indexNext = 0) {
 
   // It's realy commun to eat only one character so let's make it a function
   const eatOne = c => {
+    // Miam !
     letsEat += c;
     indexNext++;
+
     return shouldStop();
   };
 
@@ -181,7 +188,7 @@ function parse(value, indexNext = 0) {
     }
 
     // Extract name
-    if (eatUntil('=\t\b\v  ', true) || !labelFirst) {
+    if (eatUntil('=\t\b\v  ') || !labelFirst) {
       break;
     }
     if (value.charAt(indexNext) === '=' && type === 'key') { // Set labelSecond
@@ -220,7 +227,7 @@ function parse(value, indexNext = 0) {
         } else {
           return nothingHappend;
         }
-      } else if (eatUntil(' \t\n\r\v=}', true)) {
+      } else if (eatUntil(' \t\n\r\v=}')) {
         break;
       }
     }
-- 
cgit v1.2.3