add option to include location data

fgnass · fgnass · commit 9a452212d65d · 2013-05-18T23:24:54.000+02:00
diff --git a/index.js b/index.js
@@ -1,5 +1,9 @@
 
-module.exports = function(css){
+module.exports = function(css, opts){
+
+  var line = 1
+    , column = 1
+    , location = opts && opts.loc;
 
   /**
    * Parse stylesheet.
@@ -48,10 +52,30 @@ module.exports = function(css){
   function match(re) {
     var m = re.exec(css);
     if (!m) return;
+
     css = css.slice(m[0].length);
+    updateLocation(m[0]);
     return m;
   }
 
+  /**
+   * Update line and column number based on the passed `str`.
+   */
+
+  function updateLocation(str) {
+    if (!location) return;
+    var re = /\n/g
+      , i = 0
+      , newline;
+
+    while((newline = re.exec(str))) {
+      line++;
+      column = 0;
+      i = newline.index;
+    }
+    column += str.length-i;
+  }
+
   /**
    * Parse whitespace.
    */
@@ -81,6 +105,7 @@ module.exports = function(css){
       while ('*' != css[i] || '/' != css[i + 1]) ++i;
       i += 2;
       var comment = css.slice(2, i - 2);
+      updateLocation(comment);
       css = css.slice(i);
       whitespace();
       return { comment: comment };
@@ -334,10 +359,14 @@ module.exports = function(css){
    */
 
   function rule() {
-    var sel = selector();
+    var loc = location && { line: line, column: column }
+      , sel = selector();
+
     if (!sel) return;
     comments();
-    return { selectors: sel, declarations: declarations() };
+    var ret = { selectors: sel, declarations: declarations() };
+    if (loc) ret.loc = loc;
+    return ret;
   }
 
   return stylesheet();
diff --git a/test/cases/comment.json b/test/cases/comment.json
@@ -19,7 +19,11 @@
             "property": "bar",
             "value": "baz"
           }
-        ]
+        ],
+        "loc": {
+          "line": 12,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/comment.url.json b/test/cases/comment.url.json
@@ -13,7 +13,11 @@
             "property": "bar",
             "value": "baz"
           }
-        ]
+        ],
+        "loc": {
+          "line": 3,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/media.json b/test/cases/media.json
@@ -17,7 +17,11 @@
                 "property": "color",
                 "value": "#300"
               }
-            ]
+            ],
+            "loc": {
+              "line": 2,
+              "column": 3
+            }
           },
           {
             "selectors": [
@@ -32,7 +36,11 @@
                 "property": "margin",
                 "value": "0 auto"
               }
-            ]
+            ],
+            "loc": {
+              "line": 6,
+              "column": 3
+            }
           }
         ]
       },
@@ -52,7 +60,11 @@
                 "property": "color",
                 "value": "#000"
               }
-            ]
+            ],
+            "loc": {
+              "line": 13,
+              "column": 3
+            }
           },
           {
             "selectors": [
@@ -67,7 +79,11 @@
                 "property": "border",
                 "value": "0.5pt solid #666"
               }
-            ]
+            ],
+            "loc": {
+              "line": 17,
+              "column": 3
+            }
           }
         ]
       }
diff --git a/test/cases/media.messed.json b/test/cases/media.messed.json
@@ -17,7 +17,11 @@
                 "property": "color",
                 "value": "#300"
               }
-            ]
+            ],
+            "loc": {
+              "line": 1,
+              "column": 28
+            }
           },
           {
             "selectors": [
@@ -32,7 +36,11 @@
                 "property": "margin",
                 "value": "0 auto"
               }
-            ]
+            ],
+            "loc": {
+              "line": 7,
+              "column": 3
+            }
           }
         ]
       },
@@ -52,7 +60,11 @@
                 "property": "color",
                 "value": "#000"
               }
-            ]
+            ],
+            "loc": {
+              "line": 19,
+              "column": 15
+            }
           },
           {
             "selectors": [
@@ -67,7 +79,11 @@
                 "property": "border",
                 "value": "0.5pt solid #666"
               }
-            ]
+            ],
+            "loc": {
+              "line": 23,
+              "column": 15
+            }
           }
         ]
       }
diff --git a/test/cases/messed-up.json b/test/cases/messed-up.json
@@ -10,7 +10,11 @@
             "property": "foo\n  ",
             "value": "'bar'"
           }
-        ]
+        ],
+        "loc": {
+          "line": 1,
+          "column": 1
+        }
       },
       {
         "selectors": [
@@ -25,7 +29,11 @@
             "property": "bar",
             "value": "baz"
           }
-        ]
+        ],
+        "loc": {
+          "line": 5,
+          "column": 4
+        }
       },
       {
         "selectors": [
@@ -40,7 +48,11 @@
             "property": "bar\n     ",
             "value": "baz"
           }
-        ]
+        ],
+        "loc": {
+          "line": 6,
+          "column": 4
+        }
       }
     ]
   }
diff --git a/test/cases/no-semi.json b/test/cases/no-semi.json
@@ -14,7 +14,11 @@
             "property": "the-species",
             "value": "called \"ferrets\""
           }
-        ]
+        ],
+        "loc": {
+          "line": 2,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/props.json b/test/cases/props.json
@@ -18,7 +18,11 @@
             "property": "*even",
             "value": "'ie crap'"
           }
-        ]
+        ],
+        "loc": {
+          "line": 2,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/quoted.json b/test/cases/quoted.json
@@ -10,7 +10,11 @@
             "property": "background",
             "value": "url('some;stuff;here') 50% 50% no-repeat"
           }
-        ]
+        ],
+        "loc": {
+          "line": 1,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/rule.json b/test/cases/rule.json
@@ -10,7 +10,11 @@
             "property": "bar",
             "value": "'baz'"
           }
-        ]
+        ],
+        "loc": {
+          "line": 1,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/rules.json b/test/cases/rules.json
@@ -10,7 +10,11 @@
             "property": "name",
             "value": "'tobi'"
           }
-        ]
+        ],
+        "loc": {
+          "line": 1,
+          "column": 1
+        }
       },
       {
         "selectors": [
@@ -21,7 +25,11 @@
             "property": "name",
             "value": "'loki'"
           }
-        ]
+        ],
+        "loc": {
+          "line": 4,
+          "column": 1
+        }
       }
     ]
   }
diff --git a/test/cases/supports.json b/test/cases/supports.json
@@ -17,7 +17,11 @@
                 "property": "display",
                 "value": "flex"
               }
-            ]
+            ],
+            "loc": {
+              "line": 2,
+              "column": 3
+            }
           }
         ]
       }
diff --git a/test/css-parse.js b/test/css-parse.js
@@ -16,7 +16,7 @@ describe('parse(str)', function(){
     it('should parse ' + file, function(){
       var css = read(path.join('test', 'cases', file + '.css'), 'utf8');
       var json = read(path.join('test', 'cases', file + '.json'), 'utf8');
-      var ret = parse(css);
+      var ret = parse(css, { loc: true });
       ret = JSON.stringify(ret, null, 2);
       ret.should.equal(json);
     })

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,11 @@`
`19`	`19`	`"property": "bar",`
`20`	`20`	`"value": "baz"`
`21`	`21`	`}`
`22`		`- ]`
	`22`	`+ ],`
	`23`	`+ "loc": {`
	`24`	`+ "line": 12,`
	`25`	`+ "column": 1`
	`26`	`+ }`
`23`	`27`	`}`
`24`	`28`	`]`
`25`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,11 @@`
`13`	`13`	`"property": "bar",`
`14`	`14`	`"value": "baz"`
`15`	`15`	`}`
`16`		`- ]`
	`16`	`+ ],`
	`17`	`+ "loc": {`
	`18`	`+ "line": 3,`
	`19`	`+ "column": 1`
	`20`	`+ }`
`17`	`21`	`}`
`18`	`22`	`]`
`19`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,11 @@`
`17`	`17`	`"property": "color",`
`18`	`18`	`"value": "#300"`
`19`	`19`	`}`
`20`		`- ]`
	`20`	`+ ],`
	`21`	`+ "loc": {`
	`22`	`+ "line": 2,`
	`23`	`+ "column": 3`
	`24`	`+ }`
`21`	`25`	`},`
`22`	`26`	`{`
`23`	`27`	`"selectors": [`
`@@ -32,7 +36,11 @@`
`32`	`36`	`"property": "margin",`
`33`	`37`	`"value": "0 auto"`
`34`	`38`	`}`
`35`		`- ]`
	`39`	`+ ],`
	`40`	`+ "loc": {`
	`41`	`+ "line": 6,`
	`42`	`+ "column": 3`
	`43`	`+ }`
`36`	`44`	`}`
`37`	`45`	`]`
`38`	`46`	`},`
`@@ -52,7 +60,11 @@`
`52`	`60`	`"property": "color",`
`53`	`61`	`"value": "#000"`
`54`	`62`	`}`
`55`		`- ]`
	`63`	`+ ],`
	`64`	`+ "loc": {`
	`65`	`+ "line": 13,`
	`66`	`+ "column": 3`
	`67`	`+ }`
`56`	`68`	`},`
`57`	`69`	`{`
`58`	`70`	`"selectors": [`
`@@ -67,7 +79,11 @@`
`67`	`79`	`"property": "border",`
`68`	`80`	`"value": "0.5pt solid #666"`
`69`	`81`	`}`
`70`		`- ]`
	`82`	`+ ],`
	`83`	`+ "loc": {`
	`84`	`+ "line": 17,`
	`85`	`+ "column": 3`
	`86`	`+ }`
`71`	`87`	`}`
`72`	`88`	`]`
`73`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,11 @@`
`10`	`10`	`"property": "foo\n ",`
`11`	`11`	`"value": "'bar'"`
`12`	`12`	`}`
`13`		`- ]`
	`13`	`+ ],`
	`14`	`+ "loc": {`
	`15`	`+ "line": 1,`
	`16`	`+ "column": 1`
	`17`	`+ }`
`14`	`18`	`},`
`15`	`19`	`{`
`16`	`20`	`"selectors": [`
`@@ -25,7 +29,11 @@`
`25`	`29`	`"property": "bar",`
`26`	`30`	`"value": "baz"`
`27`	`31`	`}`
`28`		`- ]`
	`32`	`+ ],`
	`33`	`+ "loc": {`
	`34`	`+ "line": 5,`
	`35`	`+ "column": 4`
	`36`	`+ }`
`29`	`37`	`},`
`30`	`38`	`{`
`31`	`39`	`"selectors": [`
`@@ -40,7 +48,11 @@`
`40`	`48`	`"property": "bar\n ",`
`41`	`49`	`"value": "baz"`
`42`	`50`	`}`
`43`		`- ]`
	`51`	`+ ],`
	`52`	`+ "loc": {`
	`53`	`+ "line": 6,`
	`54`	`+ "column": 4`
	`55`	`+ }`
`44`	`56`	`}`
`45`	`57`	`]`
`46`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,11 @@`
`14`	`14`	`"property": "the-species",`
`15`	`15`	`"value": "called \"ferrets\""`
`16`	`16`	`}`
`17`		`- ]`
	`17`	`+ ],`
	`18`	`+ "loc": {`
	`19`	`+ "line": 2,`
	`20`	`+ "column": 1`
	`21`	`+ }`
`18`	`22`	`}`
`19`	`23`	`]`
`20`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,11 @@`
`18`	`18`	`"property": "*even",`
`19`	`19`	`"value": "'ie crap'"`
`20`	`20`	`}`
`21`		`- ]`
	`21`	`+ ],`
	`22`	`+ "loc": {`
	`23`	`+ "line": 2,`
	`24`	`+ "column": 1`
	`25`	`+ }`
`22`	`26`	`}`
`23`	`27`	`]`
`24`	`28`	`}`