@zdychacek/syntax-error

syntax-error

This is a fork of syntax-error which uses babylon parser instead of acorn.

Detect and report syntax errors in source code strings.

When you type node src.js you get a friendly error report about exactly where the syntax error is. This module lets you check for syntax errors and report them.

example

var fs = require('fs');
var check = require('@zdychacek/syntax-error');

var file = __dirname + '/src.js';
var src = fs.readFileSync(file);

var err = check(src, file);
if (err) {
    console.error('ERROR DETECTED' + Array(62).join('!'));
    console.error(err);
    console.error(Array(76).join('-'));
}

---

$ node check.js
ERROR DETECTED!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

/home/substack/projects/node-syntax-error/example/src.js:5
        if (Array.isArray(x) res.push.apply(res, x);
                             ^
ParseError: Unexpected token, expected )
---------------------------------------------------------------------------

methods

var check = require('@zdychacek/syntax-error')

var err = check(src, file, opts={})

Check the source code string src for syntax errors. Optionally you can specify a filename file that will show up in the output.

If src has a syntax error, return an error object err that can be printed or stringified.

If there are no syntax errors in src, return undefined.

Optionally set:

• opts.parserPlugins - specifies a list of plugins for underyling babylon parser.

err.toString()

Return the long string description with a source snippet and a ^ under pointing exactly where the error was detected.

attributes

err.message

short string description of the error type

err.line

line number of the error in the original source (indexing starts at 1)

err.column

column number of the error in the original source (indexing starts at 1)

install

With npm do:

npm install @zdychacek/syntax-error

license

MIT