Syntax-checker-new NPM

Code Syntax Checker (New)

This package is aimed at providing a basic syntax check for many languages (listed below) to ensure correct syntax.

You do need to install a few things for each one to work on your system. Click on the languages to scroll to point.

Check syntax via string or file!

Supported Languages

Installing

To install this package use the below command. Reference each language below for those steps.

npm i syntax-checker-new

Examples & Usage for `checkSyntaxString()`

codeString: The string of code you wish to validate.
language: The language your string of code is. This is the language file extension. For example C++ would be cpp.
callback: The functions call back object.
- passed: Boolean of whether or not the code passed.
- error: The error code for the syntax error if passed = false. This is currently not used.

checkSyntaxString(codeString, language, function(syntaxReturn){
    console.log(syntaxReturn.passed);
    console.log(syntaxReturn.error);
});

Javascript Example.

const syntaxchecker = require("syntax-checker-new");
let jscode = `console.log(syntaxReturn);`;
syntaxchecker.checkSyntaxString(jscode, "js", function(syntaxReturn){
    console.log(syntaxReturn.passed) // Expected result: true
});

PHP Example.

const syntaxchecker = require("syntax-checker-new");
let phpcode = `<?php echo 'test message; ?>`;
syntaxchecker.checkSyntaxString(phpcode, "php", function(syntaxReturn){
    console.log(syntaxReturn.passed) // Expected result: false (as the quote is not closed)
});

Examples & Usage for `checkSyntaxFile()`

filePath: The file path of the file to check.
language: The language your string of code is. This is the language file extension. For example C++ would be cpp.
callback: The functions call back object.
- passed: Boolean of whether or not the code passed.
- error: The error code for the syntax error if passed = false. This is currently not used.

checkSyntaxFile(filePath, language, function(syntaxReturn){
    console.log(syntaxReturn.passed);
    console.log(syntaxReturn.error);
});

Javascript Example.

const syntaxchecker = require("syntax-checker-new");
let jspath = `/root/test.js`;
syntaxchecker.checkSyntaxFile(jspath, "js", function(syntaxReturn){
    console.log(syntaxReturn.passed)
});

PHP Example.

const syntaxchecker = require("syntax-checker-new");
let phppath = `/root/test.php`;
syntaxchecker.checkSyntaxFile(phppath, "php", function(syntaxReturn){
    console.log(syntaxReturn.passed)
});