pain001-lsp 0.0.64

B -->|compute_diagnostics / completion_items / hover_text / formatting / document_symbol| C["pain001"]
C -->|schema + IBAN/BIC validation| B
B -->|diagnostics · completion · hover · code action · format · outline| A

---

## When not to use pain001-lsp

- **You're not editing JSON payment data.** The server targets the
  JSON record format consumed by the `pain001` generator; if you're
  authoring the underlying XML directly, use a generic XSD-aware
  language server.
- **You need CSV diagnostics in the editor.** The CSV diagnostic engine
  ships in-tree under [`pain001[lsp]`](https://github.com/sebastienrousseau/pain001)
  (`pain001-lsp-builtin`); this standalone server focuses on the
  richer JSON surface.
- **You want agent tools, not editor diagnostics.** Use
  [`pain001-mcp`](https://pypi.org/project/pain001-mcp/) — it speaks
  the Model Context Protocol to AI assistants.

---

## Development

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

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

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

Current state (v0.0.54): 81 tests passing, 100% line + branch coverage against a 100% enforced floor, mypy --strict clean, interrogate 100% docstring coverage.

Security

• No filesystem writes. The server reads from the editor's in-memory document buffer; no scratch files, no temp directories.
• JSON parsing uses the stdlib json module on already-quoted text from the editor — no eval, no shelling out, no XML.
• Validation failures 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.pain001.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 pain001-lsp.

License

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

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

pain001.com · PyPI · GitHub