pyjslint - JSLint Wrapper

Common errors

• ModuleNotFoundError: No module named 'pyjslint.pyjslint'

  cause Incorrect import path used for the `PyJsLint` class.
  fix The class is nested within a submodule. Change `from pyjslint import PyJsLint` to `from pyjslint.pyjslint import PyJsLint`.

• SyntaxError: Missing parentheses in call to 'print'

  cause This error typically occurs when running Python 2 code on a Python 3 interpreter, as `print` became a function in Python 3.
  fix This specific `SyntaxError` (and others) indicate fundamental incompatibility with Python 3. The library is unmaintained and not updated for Python 3. There is no simple fix other than to abandon `pyjslint` for a modern alternative or run it in a Python 2 environment (not recommended for new projects).

• AttributeError: 'NoneType' object has no attribute 'get'

  cause Attempting to access attributes on the result of `linter.lint()` without checking if it returned `None`.
  fix The `lint()` method returns `None` if no errors are found, or a list of dictionaries if errors are present. Always check for `None` before attempting to iterate or access elements: `result = linter.lint(code); if result: for error in result: ...`.

Warnings

• breaking Project is abandoned and unmaintained since 2013. Expect no new features, bug fixes, or compatibility updates.
  Fix: This library is not suitable for modern development. Consider using actively maintained JavaScript linters like ESLint (run via subprocess or a dedicated Python wrapper if available) or other static analysis tools for JavaScript.
• gotcha The bundled JSLint version is severely outdated (from 2013 or earlier). It will not understand modern JavaScript syntax (ES6+, ES2015+) and its linting rules are not configurable to modern standards.
  Fix: There is no direct fix within this library. For linting modern JavaScript, you must use an external, up-to-date linter like ESLint.
• gotcha Potential Python 3 compatibility issues. The package was released when Python 2 was prevalent, and it has `requires_python: None`.
  Fix: The library was likely written for Python 2.x. While it might run on some Python 3 environments, expect potential `SyntaxError` (e.g., `print` statement vs. function), `TypeError` (e.g., string handling), or other runtime errors. Thorough testing on your target Python 3 version is crucial, but migration to a modern tool is highly recommended.

Install

• pip install pyjslint Install pyjslint

Imports

• PyJsLint
  wrong:

  from pyjslint import PyJsLint

  correct:

  from pyjslint.pyjslint import PyJsLint

  The `PyJsLint` class is located within a submodule named `pyjslint` inside the top-level package, requiring the double `pyjslint` in the import path.

Quickstart

This quickstart demonstrates how to initialize `PyJsLint` and use its `lint()` method to analyze a string of JavaScript code. The method returns a list of error dictionaries or `None` if no errors are found.

from pyjslint.pyjslint import PyJsLint

# Example JavaScript code to lint
code_to_lint = """
var a = 1;
var b = 2;
var c = a + b // Missing semicolon, will be flagged
"""

# Initialize the linter
linter = PyJsLint()

# Lint the code
result = linter.lint(code_to_lint)

if result:
    print("Linting errors found:")
    for error in result:
        print(f"  Line {error.get('line')}, Character {error.get('character')}: {error.get('reason')}")
else:
    print("No linting errors.")