bankstatementparser-lsp 0.0.18

B -->|diagnostics_for_mt940| C["diagnostic engine (MT940 tag patterns)"]
C -->|Diagnostic objects| B
B -->|publishDiagnostics| A

---

## When not to use bankstatementparser-lsp

- **You're not editing MT940 statements.** The server targets the SWIFT
  MT940 tag-and-line format (`.mt940` / `.sta`); for CAMT XML or other
  formats use a format-appropriate language server.
- **You need full parsing, not editor diagnostics.** Use the core
  [`bankstatementparser`](https://pypi.org/project/bankstatementparser/)
  library to parse statements into structured records.

---

## Development

`bankstatementparser-lsp` uses [Poetry](https://python-poetry.org/) and
[mise](https://mise.jdx.dev/).

```bash
git clone https://github.com/sebastienrousseau/bankstatementparser-lsp.git
cd bankstatementparser-lsp
mise install
poetry install

A Makefile orchestrates the quality gates (kept in lockstep with CI):

Current state (v0.0.18): 91 tests passing, 100% line + branch coverage against a 100% enforced floor, mypy --strict clean, interrogate 100% docstring coverage. The suite includes documentation and example regression tests (tests/test_docs_accuracy.py, tests/test_regression_docs.py, tests/test_regression_examples.py) that execute every documented snippet and every examples/*.py script.

Security

• No filesystem writes. The server reads from the editor's in-memory document buffer; no scratch files, no temp directories.
• MT940 parsing is a pure-re line scanner over text from the editor — no eval, no shelling out, no XML, no network.
• Lint findings are returned as lsprotocol.Diagnostic objects with no stack traces, so the editor never sees an internal path or exception message.
• Dependencies are pinned via poetry.lock and audited by pip-audit and Bandit in CI.

To report a vulnerability, please use GitHub private vulnerability reporting rather than a public issue.

Documentation

• Runnable examples: examples/
• VS Code scaffold: editors/vscode/
• Release history: CHANGELOG.md
• Core library docs: docs.bankstatementparser.com
• LSP specification: microsoft.github.io/language-server-protocol

Contributing

Contributions are welcome — see the contributing instructions. Thanks to all the contributors who have helped build bankstatementparser-lsp.

License

Licensed under the Apache License, Version 2.0. Built on pygls and lsprotocol by the Open Law Library, and on the core bankstatementparser library that powers the validators and schemas.

Any contribution submitted for inclusion shall be licensed as above, without additional terms.

bankstatementparser.com · PyPI · GitHub