handle errors with a SyntaxError error

Author: ichiriac

docs/README.md

@@ -27,11 +27,30 @@ Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refere
 
 ## parseCode
 
-parse php code with '<?php $x = 1;'
+Function that parse a php code with open/close tags
+
+Sample code :
+
+```php
+<?php $x = 1;
+```
+
+Usage :
+
+```js
+var parser = require('php-parser');
+var phpParser = new parser({
+  // some options
+});
+var ast = phpParser.parseCode('...php code...', 'foo.php');
+```
 
 **Parameters**
 
--   `buffer`  
+-   `buffer` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The code to be parsed
+-   `filename` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Filename
+
+Returns **Program** 
 
 ## tokenGetAll
 
@@ -62,18 +81,36 @@ Evaluate the buffer
 
 ## parseCode
 
-parse php code with '&lt;?php $x = 1;'
+Static function that parse a php code with open/close tags
+
+Sample code :
+
+```php
+<?php $x = 1;
+```
+
+Usage :
+
+```js
+var parser = require('php-parser');
+var ast = parser.parseCode('...php code...', 'foo.php');
+```
 
 **Parameters**
 
--   `buffer`  
--   `options`  
+-   `buffer` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The code to be parsed
+-   `filename` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Filename
+-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Optional options
+
+Returns **Program** 
 
 ## tokenGetAll
 
-split the buffer into tokens
+Split the buffer into tokens
 
 **Parameters**
 
 -   `buffer`  
 -   `options`  
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** 

docs/parser.md

@@ -32,6 +32,7 @@ main entry point : converts a source code to AST
 **Parameters**
 
 -   `code`  
+-   `filename`  
 
 ## raiseError
 

src/index.js

@@ -78,28 +78,66 @@ engine.parseEval = function(buffer, options) {
 engine.prototype.parseEval = function(buffer) {
   this.lexer.mode_eval = true;
   this.lexer.all_tokens = false;
-  return this.parser.parse(buffer);
+  return this.parser.parse(buffer, 'eval');
 };
 
 /**
- * parse php code with '<?php $x = 1;'
+ * Static function that parse a php code with open/close tags
+ *
+ * Sample code :
+ * ```php
+ * <?php $x = 1;
+ * ```
+ *
+ * Usage :
+ * ```js
+ * var parser = require('php-parser');
+ * var ast = parser.parseCode('...php code...', 'foo.php');
+ * ```
+ * @param {String} buffer - The code to be parsed
+ * @param {String} filename - Filename
+ * @param {Object} options - Optional options
+ * @return {Program}
  */
-engine.parseCode = function(buffer, options) {
+engine.parseCode = function(buffer, filename, options) {
+  if (typeof filename === 'object') {
+    // retro-compatibility
+    options = filename;
+    filename = 'unknown';
+  }
   var self = new engine(options);
-  return self.parseCode(buffer);
+  return self.parseCode(buffer, filename);
 };
 
 /**
- * parse php code with '<?php $x = 1;'
+ * Function that parse a php code with open/close tags
+ *
+ * Sample code :
+ * ```php
+ * <?php $x = 1;
+ * ```
+ *
+ * Usage :
+ * ```js
+ * var parser = require('php-parser');
+ * var phpParser = new parser({
+ *   // some options
+ * });
+ * var ast = phpParser.parseCode('...php code...', 'foo.php');
+ * ```
+ * @param {String} buffer - The code to be parsed
+ * @param {String} filename - Filename
+ * @return {Program}
  */
-engine.prototype.parseCode = function(buffer) {
+engine.prototype.parseCode = function(buffer, filename) {
   this.lexer.mode_eval = false;
   this.lexer.all_tokens = false;
-  return this.parser.parse(buffer);
+  return this.parser.parse(buffer, filename);
 };
 
 /**
- * split the buffer into tokens
+ * Split the buffer into tokens
+ * @return {String[]}
  */
 engine.tokenGetAll = function(buffer, options) {
   var self = new engine(options);

src/parser.js

@@ -156,8 +156,9 @@ parser.prototype.getTokenName = function(token) {
 /**
  * main entry point : converts a source code to AST
  */
-parser.prototype.parse = function(code) {
+parser.prototype.parse = function(code, filename) {
   this._errors = [];
+  this.filename = filename || 'eval';
   this.currentNamespace = [''];
   this.lexer.setInput(code);
   this.lexer.comment_tokens = this.extractDoc;
@@ -185,7 +186,11 @@ parser.prototype.parse = function(code) {
 parser.prototype.raiseError = function(message, msgExpect, expect, token) {
   message += ' on line ' + this.lexer.yylloc.first_line;
   if (!this.suppressErrors) {
-    throw new Error(message);
+    var err = new SyntaxError(
+      message, this.filename, this.lexer.yylloc.first_line
+    );
+    err.columnNumber = this.lexer.yylloc.first_column
+    throw err;
   }
   // Error node :
   var node = this.ast.prepare('error', this)(

test/astTests.js

@@ -9,6 +9,17 @@ describe('Test AST structure', function() {
     ast.children.length.should.be.exactly(0);
   });
 
+
+  it('test syntax error', function() {
+    (function(){
+      var ast = parser.parseCode([
+        '<?php',
+        ' $a = 1',
+        ' $b = 2' // <-- unexpected $b expecting a ';'
+      ].join('\n'));
+    }).should.throw(/line\s3/);
+  });
+
   it('test inline', function() {
     var ast = parser.parseCode('Hello <?php echo "World"; ?> !');
     ast.children[0].kind.should.be.exactly('inline');