syntax-checker 0.2.0

No project description provided

Syntax-checker: A Multi-Language Syntax Checker

A Python library that uses Tree-sitter to check syntax errors across multiple programming languages based on Rust.

Installation

pip install syntax_checker

Features

• Support for multiple languages including:
• Fast parsing using tree-sitter
• Precise error reporting with line and column numbers
• No need for language-specific toolchains
• Easy to extend with additional language support

Usage

The library provides a simple interface to check syntax errors in source code:

import syntax_checker

# Check Python syntax
output = syntax_checker.check_syntax("py", """
def invalid_function[T](x):  # Invalid type parameter syntax
    print(\"unclosed string')  # Unclosed string
""")

# Get error positions as (line, column) tuples
print(output.errors)  # [(2, 19), (3, 11)]

# Get error descriptions
print(output.description)
# Line 2, Column 19: Syntax error: unexpected ERROR in function_definition
# Line 3, Column 11: Missing string_content in string

# Check a file without errors
output = syntax_checker.check_syntax("py", """
def valid_function(x: int) -> int:
    return x * 2
""")

print(output.errors)  # []
print(output.description)  # ""

Supported Languages and File Extensions

Language	Extension(s)	Command
Bash	.sh	bash
C	.c, .h	c
C++	.cpp, .hpp	cpp
C#	.cs	c_sharp
CSS	.css	css
Elisp	.el	elisp
Elixir	.ex, .exs	elixir
Elm	.elm	elm
Go	.go	go
HTML	.html, .htm	html
Java	.java	java
JavaScript	.js	javascript
JSX	.jsx	jsx
JSON	.json	json
Lua	.lua	lua
PHP	.php	php
Python	.py	python
ReScript	.res	rescript
Ruby	.rb	ruby
Rust	.rs	rust
Solidity	.sol	solidity
TOML	.toml	toml
TypeScript	.ts	typescript
TSX	.tsx	tsx

How It Works

Syntax checker uses tree-sitter parsers to analyze source code and detect syntax errors. Tree-sitter is a parser generator tool and incremental parsing library that can build a concrete syntax tree for source files and efficiently update it as the source file is edited.

The tool:

1. Determines the appropriate parser based on the specified language
2. Parses the input file
3. Traverses the syntax tree looking for ERROR nodes
4. Reports the location and type of any syntax errors found

Contributing

Contributions are welcome! Here are some ways you can contribute:

1. Add support for new languages
2. Improve error reporting
3. Add new features
4. Report bugs
5. Improve documentation

Notes

Some experimental language support (OCaml, QL, SystemRDL) has been temporarily disabled due to parser integration issues. Contributions to fix these parsers are welcome.

License

MIT License - see LICENSE file for details