Skip to main content

A console prose linter — readability checks plus opt-in AI-writing / de-slop checks. Like flake8, but for English.

Project description

nabokov

A console linter for English prose. Hard sentences, adverbs, passive voice: one warning per line.

Python Built with spaCy License: MIT

Code gets review. Prose gets a shrug. nabokov catches hard-to-read sentences, adverbs, passive voice, wordy phrases, and qualifiers, plus opt-in checks for the tells of AI writing. A readability grade comes with the report. Findings print as warnings you can pipe into an editor or CI. Each check is a rule with its own code, so you switch checks on and off the way you do with flake8.

Try it

uvx nabokov draft.md          # one command, no setup; fetches the model on first run

Why

Code has linters, but prose rarely does. Style guides live in people's heads. nabokov moves them into your terminal. It points at the sentence that reads hard and says why.

The rule set is inspired by the Hemingway Editor. Detection runs on spaCy. Passive voice comes from a dependency parse, not a fragile regex.

Install

Requires Python 3.12 or newer.

uv tool install nabokov       # or: pipx install nabokov
nabokov download-model        # one-time: fetch the spaCy model (en_core_web_sm)
nabokov draft.md

The model is a separate download because PyPI does not allow the direct-URL dependency it ships as. nabokov fetches it on first run; the explicit nabokov download-model (or python -m spacy download en_core_web_sm) does it up front. For local development, uv sync installs everything, including the model.

Usage

nabokov draft.md                 # colored report for humans
nabokov --format=flake8 x.md     # path:line:col: CODE message
cat notes.txt | nabokov -        # read from stdin
nabokov docs/                    # walk a directory of .txt / .md / .html files
nabokov --max-grade 9 x.md       # exit non-zero if the grade goes over 9
nabokov --select NB302 x.md      # run one rule
nabokov --ignore NB301 x.md      # skip a rule
nabokov --list-rules             # print every code

nabokov reads plain text, Markdown, and HTML. For .md and .html it blanks the markup: code, tags, and link URLs. It then checks only the visible prose, so findings point at real writing. For stdin, --stdin-display-name draft.md sets the type.

Exit codes follow flake8: 0 when clean, 1 when there are findings, 2 on a usage error.

Output formats

Choose one with --format:

  • Color (--format=color) highlights snippets and adds a grade summary. It is the terminal default.
  • Flake8 (--format=flake8) prints one finding per line, for editors and CI.
  • JSON (--format=json) returns diagnostics plus the document grade.
  • GitHub (--format=github) emits workflow annotations for GitHub Actions.

Rules

Run nabokov --list-rules to see them all. The full reference lives in docs/RULES.md.

  • NB201 / NB202: the very hard and hard reading levels.
  • NB301: adverbs.
  • NB302: passive voice.
  • NB303: qualifiers and hedges.
  • NB401: wordy phrases, with a simpler suggestion.
  • NB101: the document grade, reported with --max-grade.

Signs of AI writing (opt-in)

nabokov also spots common LLM tells (NB5xx). The lists come from the Wikipedia guide and community threads. It catches the it's not X, it's Y construction and puffery like delve or tapestry. Promotional phrases, chatbot filler like Great question!, and overused transitions all trip it. It also flags em-dash and emoji overuse. Rule-of-three fragments, flat sentence rhythm, and repeated openers round it out.

These checks stay off by default, because they often flag a writer's own voice. Turn them on with a flag:

nabokov --ai draft.md         # the core checks plus the AI-writing checks
nabokov --ai-only essay.md    # only the AI-writing checks

--ai is shorthand for --extend-select NB5, and --ai-only for --select NB5.

Pair it with the agent skill

The linter catches the mechanical part. Add the nabokov-editor skill to your coding agent and it also fixes the findings, then reads for what rules miss: empty sentences, invented detail, hollow closers. Fixes keep your meaning. Big edits wait for your approval.

# Claude Code
/plugin marketplace add viewflow/nabokov
/plugin install nabokov@viewflow

# Cursor, Codex, Gemini CLI, and other agents (via the skills CLI)
npx skills add viewflow/nabokov

Then ask your agent to lint or de-slop a file. Skill details live in skills/nabokov-editor/SKILL.md.

Configuration

Put settings under [tool.nabokov] in pyproject.toml, or in a .nabokov.toml. nabokov walks up from the current directory to find one. CLI flags win.

[tool.nabokov]
target = "NORMAL"       # ACCESSIBLE | NORMAL | TECHNICAL
ignore = ["NB301"]      # e.g. stop flagging adverbs

Suppress one line inline:

This sentence is fine.  <!-- nabokov: ignore NB302 -->

How it works

nabokov scores readability with the Automated Readability Index (ARI). Word characters drive the grade, so nabokov counts no syllables.

The adverb list, phrase dictionary, and reading-level thresholds combine classic plain-language word lists with our own additions: extra hedges, more phrase alternatives, and a fuller set of irregular participles.

spaCy handles the parsing. Passive voice reads the auxpass dependency. Adverbs read the part-of-speech tag plus the -ly suffix. The pipeline loads once and runs on every file.

Development

uv run pytest               # the test suite
uv run ruff check .         # lint
uv run ruff format .        # format
uv run pyright              # type-check

The nabokov-editor skill drives the linter inside an agent loop. It detects issues, rewrites while preserving meaning, and asks before any large change.

License

MIT.

Credits

Inspired by the Hemingway Editor. Parsing uses spaCy. The name is a nod to a writer who cared about sentences.

Project details


Download files

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

Source Distribution

nabokov-26.7.1.tar.gz (115.8 kB view details)

Uploaded Source

Built Distribution

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

nabokov-26.7.1-py3-none-any.whl (44.5 kB view details)

Uploaded Python 3

File details

Details for the file nabokov-26.7.1.tar.gz.

File metadata

  • Download URL: nabokov-26.7.1.tar.gz
  • Upload date:
  • Size: 115.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for nabokov-26.7.1.tar.gz
Algorithm Hash digest
SHA256 ab67ae1568a7c149fd0c188749ae3ec8ed4afc1d3dd634015369323423ed986d
MD5 e7e6c0dbcdae0ae4146fc6cc47cdb69a
BLAKE2b-256 5baae4c49f9b453737f4175dc074bbfe180276cb2dcae7369a9423aad8bdc2e6

See more details on using hashes here.

File details

Details for the file nabokov-26.7.1-py3-none-any.whl.

File metadata

  • Download URL: nabokov-26.7.1-py3-none-any.whl
  • Upload date:
  • Size: 44.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for nabokov-26.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e824e997b74183f04f6965dc1b4382359288fd14534392f3b72f40c0747cedad
MD5 f14a1def0281c961601c29fa5971bc15
BLAKE2b-256 9352d313d43583396db4ce3a1408b8640676a067a67c1691387567499b00663c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page