# syntax-checker-new

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

Latest version **1.0.1** (published 2021-01-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install syntax-checker-new
pnpm add syntax-checker-new
yarn add syntax-checker-new
bun add syntax-checker-new
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-01-24 |
| First published | 2021-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | FAXES, Beefer |
| Maintainers | faxes |
| Keywords | syntaxchecker, checker, syntaxcheck, syntax, syntaxcheckernew |

## Links

- npm: https://www.npmjs.com/package/syntax-checker-new
- Repository: https://github.com/FAXES/syntax-checker-new
- Homepage: https://github.com/FAXES/syntax-checker-new#readme
- Issues: https://github.com/FAXES/syntax-checker-new/issues
- npm.io page: https://npm.io/package/syntax-checker-new

## Dependencies (1)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security

## Alternatives

- [@oh-my-pi/pi-natives](https://npm.io/package/@oh-my-pi/pi-natives.md) — 51.8K weekly downloads
- [@capgo/capacitor-light-sensor](https://npm.io/package/@capgo/capacitor-light-sensor.md) — 3.0K weekly downloads
- [@heyhuynhgiabuu/pi-diff](https://npm.io/package/@heyhuynhgiabuu/pi-diff.md) — 492 weekly downloads
- [@lotsa/verdant-lang-asm](https://npm.io/package/@lotsa/verdant-lang-asm.md) — 38 weekly downloads
- [new-era-syntax](https://npm.io/package/new-era-syntax.md) — 20 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-01-24
- 1.0.0 — 2021-01-24

## README

# 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
- [PHP](#php)
- [Ruby](#ruby)
- [Python](#python)
- [Perl](#perl)
- [Lua (needs fixing)](#lua)
- [Bash (needs fixing)](#bash1)
- [c](#c-and-c)
- [c++](#c-and-)
- [js](#javascript)

---

## 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.**


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

Javascript Example.
```js
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.
```js
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.**


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

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

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

---

## Specific Languages

Each language you wish to syntax check may require that language to be installed on your system.

### PHP
If you intend to use PHP syntax checking you will need to install PHP on your system. See the PHP website below for instructions.

https://www.php.net/manual/en/install.php

### Ruby
To use ruby in syntax checking you need to install Ruby. See the below site for more.

https://www.ruby-lang.org/en/documentation/installation/

### Python
To syntax check Python scripts install Python

https://www.python.org/downloads/

### Perl
If you want to syntax check Perl, install Perl.

https://www.perl.org/get.html

### Lua
If you intend to syntax check for Lua errors you need to have Lua installed

http://www.lua.org/download.html

### Bash
Install Bash to syntax check bash scripts.

https://www.gnu.org/software/bash/

### C And C++
These use the same program as the languages are very alike. See the below link.

https://gcc.gnu.org/install/

### Javascript
You're in luck! Javascript uses node for syntax checking so if you have Node.Js installed (which you likely do) then you're fine!


---

## Support
If you need support create a comment on GitHub or if you use Discord talk to the creator (FAXES & Beefer)

[![Discord](https://faxes.zone/i/9wkr3.png)](https://faxes.zone/discord)

---
_Source: https://npm.io/package/syntax-checker-new · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._