Skip to main content

dddlint

Polyglot ubiquitous language linter. Reads class, function, method, and type names across 306 languages and enforces them against a domain vocabulary: banned terms, non-canonical synonyms, and one concept spelled multiple ways.

Works with any language tree-sitter recognises, without per-language queries. Slots into pre-commit hooks, CI pipelines, and coding agent loops via a non-zero exit code on findings. Ships with an LSP server for inline editor diagnostics and rename code actions.

dddlint LSP diagnostics inline in an editor

📖 Full documentation

Install

uv add dddlint

# dddlint map needs an embedding backend; this one runs locally and offline
uv add 'dddlint[embed-local]'

# or, for a hosted model such as openai:text-embedding-3-small
uv add 'dddlint[embed]'

lint, html, and lsp need none of these: only map embeds anything.

Quick start

# lint current directory (looks for dddlint.yaml)
dddlint lint

# lint a specific path
dddlint lint src/

# report vocabulary insights from name embeddings, plus a scatter plot to open
dddlint map

# open an interactive language graph in the browser
dddlint html

# start the LSP server (stdio)
dddlint lsp

Config

Place dddlint.yaml at the project root. When a path is passed to lint or html, the config is looked up in that directory first, then falls back to the current working directory.

similarity_threshold: 0.85   # how alike two domain or context names may be
enforce_canonical: true       # flag alias terms in addition to forbidden ones
name_uniqueness: true         # flag one name claimed by two definitions in a context

# terms that must never appear in a definition name
forbidden:
  - util
  - helper
  - manager

# paths to skip, gitignore syntax, relative to this file's directory
exclude:
  - src/generated
  - "**/*_pb2.py"

# canonical terms and their aliases
synonyms:
  - canonical: customer
    aliases: [client, user, accountholder]
  - canonical: order
    aliases: [purchase, transaction]

# high-level business domains
domains:
  - name: commerce
    include: ["**/commerce/**"]
    synonyms:
      - canonical: order
        aliases: [purchase]

# bounded contexts, same structure as domains, applied after (context wins on conflict)
contexts:
  - name: billing
    include: ["**/billing/**"]
    forbidden: [discount]
    synonyms:
      - canonical: invoice
        aliases: [bill, statement]

Global rules apply everywhere. Domain rules apply to matching paths. Context rules apply after domains, so a context can override a domain synonym.

Rules

Rule Severity Description
forbidden error A definition name contains a banned term
alias warning A definition uses a non-canonical synonym, with a rename suggestion
duplicate warning One name is claimed by more than one definition in the same context, so rg name cannot answer which one
drift info The same concept is spelled multiple ways across the codebase
config:forbidden-canonical-clash error A term is both forbidden and a canonical synonym
config:alias-conflict warning The same alias maps to different canonicals in different scopes
config:duplicate-name info Two domains or contexts have suspiciously similar names

Config rules are checked against dddlint.yaml itself on every run.

Insights

dddlint map embeds every definition name and compares meaning rather than tokens, catching what drift cannot. It always exits 0, so it informs rather than gates.

Rule Description
near-synonym Names that mean the same thing while sharing no token
context-outlier A name whose vocabulary belongs to a different domain or context

Vectors are cached in .dddlint/embeddings.json, keyed by model and dimensions, so only new names are ever embedded. Configure the model under embeddings in dddlint.yaml.

Every run also writes dddmap.html beside the config and opens it: the whole vocabulary laid out by embedding similarity, verbs as triangles and nouns as dots, with one boundary drawn around each bounded context.

The dddlint vocabulary map: names placed by embedding similarity, with a boundary drawn around each bounded context

LSP

The LSP server publishes diagnostics on file open and save, scanning the entire workspace each time so cross-file drift is always caught. Alias findings include a code action to rename the identifier to the canonical term with case preserved (ClientRepoCustomerRepo, get_clientget_customer). The rename is delegated to the language server that owns the file, since that is the one that can find the call sites — see wiring it up.

Neovim, add to init.lua:

vim.api.nvim_create_autocmd("BufReadPost", {
  callback = function(args)
    local root = vim.fs.root(args.buf, { "dddlint.yaml" })
    if root then
      vim.lsp.start({
        name = "dddlint",
        cmd = { "dddlint", "lsp" },
        root_dir = root,
      }, { bufnr = args.buf })
    end
  end,
})

The autocmd fires on every buffer, attaches only when dddlint.yaml is found, and is language-agnostic, so no filetype list is required.

VS Code, via a generic LSP client extension:

{
  "lsp.servers": {
    "dddlint": {
      "command": ["uvx", "dddlint", "lsp"],
      "filetypes": ["*"]
    }
  }
}

Helix, .helix/languages.toml:

[language-server.dddlint]
command = "dddlint"
args = ["lsp"]

Language support

Extraction is powered by tree-sitter-language-pack, which covers 306 languages including:

Ada · Agda · Arduino · Bash · C · C++ · C# · Clojure · COBOL · Crystal · CSS · D · Dart · Dockerfile · Elixir · Elm · Erlang · F# · Fortran · GDScript · GLSL · Go · GraphQL · Groovy · Hack · Haskell · HCL · HTML · Java · JavaScript · Julia · Kotlin · Lean · Lua · MATLAB · Mojo · Nix · OCaml · Odin · Pascal · Perl · PHP · PowerShell · Prolog · Python · R · Racket · Ruby · Rust · Scala · Scheme · Solidity · SQL · Svelte · Swift · Terraform · TLA+ · TOML · TypeScript · V · VHDL · Vim · Vue · WebAssembly · XML · YAML · Zig, and 243 more.

CI

# .github/workflows/dddlint.yml
- run: uvx dddlint lint

Exit code is 0 when clean, 1 when findings exist.

Pre-commit

# .pre-commit-config.yaml
repos:
  - repo: local
    hooks:
      - id: dddlint
        name: dddlint
        entry: dddlint lint
        language: python
        pass_filenames: false

Offline use

The language pack downloads parsers on first use. For CI or air-gapped runs, warm the cache in the image:

python -c "import tree_sitter_language_pack as t; t.download_all()"

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dddlint-0.1.10.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dddlint-0.1.10-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

Details for the file dddlint-0.1.10.tar.gz.

File metadata

  • Download URL: dddlint-0.1.10.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dddlint-0.1.10.tar.gz
Algorithm Hash digest
SHA256 44c21993b811603c16324bc59271473c5bf74cc8913799ef288a4c67a9e3652d
MD5 b5d6dad325d0c45dd0f08fa77aedfc0c
BLAKE2b-256 ecce9b614f33409b36ff36fd94af310b4451f612a71a0e805292b022afa8d8c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for dddlint-0.1.10.tar.gz:

Publisher: workflow.yaml on benomahony/dddlint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dddlint-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: dddlint-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 30.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dddlint-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 60a680e7e357ff0e06918b33954f28331cfc71cad61392a6fc7f4ba640189ca4
MD5 f8345ce08b51c6fdf4976682bd75a1fa
BLAKE2b-256 8717589a729895ba7a3a053c7dcd05f6a04f47efc80495e968d1bad9451b417a

See more details on using hashes here.

Provenance

The following attestation bundles were made for dddlint-0.1.10-py3-none-any.whl:

Publisher: workflow.yaml on benomahony/dddlint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.11

2 files

This release

0.1.10 This release

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page