amperser/proselint is tracked by TopGit as a developer tool, with 4.6k stars on GitHub, written primarily in JavaScript. [Mirror] A linter for prose.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Writing is notoriously hard, even for the best writers, and it's not for lack of
good advice — a tremendous amount of knowledge about the craft is strewn across
usage guides, dictionaries, technical manuals, essays, pamphlets, websites, and
the hearts and minds of great authors and editors. But poring over Strunk &
White hardly makes one a better writer — it turns you into neither Strunk nor
White. And nobody has the capacity to apply all the advice from Garner’s Modern
English Usage, an 1100-page usage guide, to everything they write. In fact, the
whole notion that one becomes a better writer by reading advice on writing rests
on untenable assumptions about learning and memory. The traditional formats of
knowledge about writing are thus essentially inert, waiting to be transformed.
We devised a simple solution: proselint, a linter for English prose. A linter
is a computer program that, akin to a spell checker, scans through a file and
detects issues — like how a real lint roller helps you get unwanted lint off of
your shirt.
proselint places the world's greatest writers and editors by your side, where
they whisper suggestions on how to improve your prose. You’ll be guided by
advice inspired by Bryan Garner, David Foster Wallace, Chuck Palahniuk, Steve
Pinker, Mary Norris, Mark Twain, Elmore Leonard, George Orwell, Matthew
Butterick, William Strunk, Elwyn White, Philip Corbett, Ernest Gowers, and the
editorial staff of the world’s finest literary magazines and newspapers, among
others. Our goal is to aggregate knowledge about best practices in writing and
to make that knowledge immediately accessible to all authors in the form of a
linter for prose; all in a neat command-line utility that you can integrate into
other tools, scripts, and workflows.
Be sure to change rev to use the desired proselint git tag or revision.
Thanks to Andy Airey for the pre-commit configuration.
Declarative
environment.systemPackages = [pkgs.proselint];
Imperative
nix profile install nixpkgs#proselint
Plugins for other software
proselint is available on:
Vim via ALE
Emacs via Flycheck
CI/CD via MegaLinter
Neovim via none-ls.nvim
The following plugins are also available, but they are archived or unmaintained:
IntelliJ plugin by Victor Kropp
Flymake plugin by Manuel Uberti
Sublime Text plugin by Jordan Suchow
Phabricator Arc plugin by Jeff Verkoeyen
Visual Studio Code plugin by Patryk Peszko
Coala plugin by the Coala Development Group
Danger plugin by David Grandinetti and Orta Therox
Syntastic plugin by LCD 047, M Bussonnier, and Daniel M. Cappella
Usage
On the command line
Suppose you have a document text.md with the following text:
John is very unique.
You can run proselint over the document using the command line:
proselint check text.md
This prints a list of suggestions to stdout, one per line. Each suggestion is of
the form:
file:<line>:<column>: <check_name>: <message>
For example,
text.md:1:9: uncomparables: Comparison of an uncomparable: 'very unique' is not comparable.
The command-line utility can also print suggestions in JSON using the
--output-format json option. In this case, the output is considerably richer,
following our stable wire schema.
{
"result": {
"file:///path/to/text.md": {
"diagnostics": [
{
// Name of the check that output this suggestion.
"check_path": "uncomparables",
// Message to describe the suggestion
"message": "Comparison of an uncomparable: 'very unique' is not comparable.",
// Line and column where the error begins in the source
"pos": [1, 9],
// Absolute start and end of the error in the source
"span": [9, 20],
// Suggested replacements for the content, if applicable
"replacements": null,
}
]
}
}
}
As a library
To run the linter as part of another Python program, you can use the LintFile
class in proselint.tools. This requires CheckRegistry to be populated.
from proselint.checks import __register__
from proselint.registry import CheckRegistry
from proselint.tools import LintFile
CheckRegistry().register_many(__register__)
suggestions = LintFile("source-name", "This sentence is very unique").lint()
This will return a list of suggestions:
[LintResult(
check_result=CheckResult(
check_path='uncomparables',
message="Comparison of an uncomparable: 'very unique' is not comparable.",
span=(18, 29),
replacements=None,
),
pos=(1, 18),
)]
Configuring
[!NOTE]
proselint searches for configuration files in the order described below, and
loads the first file it finds. If no configuration files are found, it falls
back to its built in defaults.
The file given by the --config flag, if specified
proselint.json in the current working directory
proselint.json in any directory above the current working directory
$XDG_CONFIG_HOME/proselint/config.json, defaulting to
~/.config/proselint/config.json if XDG_CONFIG_HOME is not set
This section's examples use JSONC for comments and trailing commas. Please
ensure you remove these features from your own configuration to avoid errors.
The configuration schema and defaults are as follows:
{
// The maximum allowable number of results proselint can output.
"max_errors": 1000,
// Checks to select or deselect.
"checks": {
// ...
},
// Checks to select or deselect on a per-file basis. These are merged with
// the selections specified in "checks" so you don't have to repeat them.
"per_file_checks": {},
}
Check selection
Check selection is granular at any level, illustrated in the following example:
This configuration would enable all checks in the typography module, excluding
typography.punctuation.hyperbole and those in typography.symbols, but
preserving typography.symbols.curly_quotes. Using this system allows you to
concisely and precisely select checks at an individual level.
Per-file checks
[!WARNING]
The path globs described in this section work differently than you may be
used to. Refer to the Python documentation for partial non-recursive globs
for more information.
You can select different checks for different files, or files matching given
partial globs. Take the following example.
This configuration would select typography for all files except markdown
files. Values in per_file_checks are the same as in checks, and have exactly
the same features.
Checks
ID
Description
annotations
Catch annotations left in the text
archaism
Avoid archaic forms
cliches.hell
Avoid a common cliché regarding hell
cliches.misc
Avoid clichés
dates_times.am_pm
Format the time of day correctly
dates_times.dates
Format dates appropriately
hedging
Avoid undermining yourself with uncertainty
industrial_language.airlinese
Avoid jargon of the airline industry
industrial_language.bureaucratese
Avoid bureaucratese
industrial_language.chatspeak
Avoid lolling and other chatspeak
industrial_language.commercialese
Avoid jargon of the commercial world
industrial_language.corporate_speak
Avoid corporate buzzwords
industrial_language.jargon
Avoid miscellaneous jargon
lexical_illusions
Avoid repeating words or phrases
malapropisms
Avoid common malapropisms
misc.apologizing
Be confident and avoid excessive apologizing
misc.back_formations
Avoid redundant backformations
misc.but
Do not start a paragraph with "But..."
misc.capitalization
Capitalize only what ought to be capitalized
misc.composition
Adhere to principles of composition
misc.currency
Avoid redundant currency symbols
misc.debased
Avoid debased language
misc.false_plurals
Avoid false plurals
misc.greylist
Avoid greylisted terms
misc.illogic
Avoid illogical forms
misc.inferior_superior
Superior to, not than
misc.institution_name
Use the correct names of institutions
misc.latin
Avoid overuse of Latin phrases
misc.many_a
Use singular forms with "many a"
misc.metadiscourse
Avoid discussing the discussion
misc.narcissism
Talk about the subject, not its study
misc.not_guilty
Avoid "not guilty beyond a reasonable doubt"
misc.phrasal_adjectives
Hyphenate phrasal adjectives correctly
misc.preferred_forms
Use the preferred forms of terms
misc.pretension
Do not be pretentious
misc.professions
Use the right names for jobs
misc.scare_quotes
Do not misuse scare quotes
misc.suddenly
Retain suddenness by not using "suddenly"
misc.tense_present
Follow advice from Tense Present
misc.waxed
Use adjectives for waxed, as in "wax poetic"
misc.whence
Avoid redundancy with "whence"
mixed_metaphors
Do not mix metaphors
mondegreens
Avoid mondegreens
needless_variants
Use preferred forms over uncommon variants
nonwords
Do not use nonwords
oxymorons
Avoid oxymorons
psychology
Avoid misusing psychological terms
redundancy.misc
Avoid redundancy in phrases
redundancy.ras_syndrome
Avoid redundancy in acronyms
restricted.elementary
Restrict writing to terms from elementary school
restricted.top1000
Restrict writing to the top 1000 words by usage
skunked_terms
Avoid using skunked terms
social_awareness.lgbtq
Be aware of LGBTQ+ terminology
social_awareness.nword
Take responsibility for use of "the n-word"
social_awareness.sexism
Be aware of sexist language
spelling.able_atable
Use the correct form of -able and -atable
spelling.able_ible
Use the correct form of -able and -ible
spelling.ally_ly
Use the correct form of -ally and -ly
spelling.ance_ence
Use the correect form of -ance and -ence
spelling.athletes
Spell the names of athletes correctly
spelling.consistency
Be consistent in spelling
spelling.ely_ly
Use the correct form of -ely and -ly
spelling.em_im_en_in
Use the correct form of -em, -im, -en, and -in
spelling.er_or
Use the correct form of -er and -or
spelling.in_un
Use the correct form of -in and -un
spelling.misc
Spell miscellaneous terms correctly
spelling.ve_of
Use the correct form of -ve and -of
terms.animal_adjectives
Use the right adjectives for likening animals
terms.denizen_labels
Use the right names for denizens
terms.eponymous_adjectives
Use the right names for likening people
terms.venery
Use the right names for groups of animals
typography.diacritical_marks
Use diacritical marks
typography.punctuation
Use punctuation correctly
typography.symbols
Use symbols correctly
uncomparables
Do not compare uncomparables
weasel_words
Avoid weasel words
Contributing
Interested in contributing to proselint? Great — there are plenty of ways you
can help. Check out our contributing guidelines, where we describe how you
can help us build proselint into the greatest writing tool in the world.
Issue Tracker
Source Code
Support
If you run into a problem, please open an issue.
Running Tests
Automated tests are included in the tests directory. To run these
tests locally, you can use pytest via poe test.
How does amperser/proselint compare to other Developer Tools projects?
amperser/proselint is tracked by TopGit in the Developer Tools category, with 4.6k GitHub stars and written in JavaScript. Browse the Developer Tools topic page on TopGit to compare it against similar projects by stars and activity.
Is amperser/proselint open source?
Yes — amperser/proselint ships under the BSD-3-Clause license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/amperser/proselint.
What else is in the Developer Tools space?
amperser/proselint is tracked by TopGit under the Developer Tools category, alongside 7 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is amperser/proselint?
amperser/proselint (amperser/proselint) is a JavaScript project on GitHub. From the project's own README: [Mirror] A linter for prose.
Where do I read more about amperser/proselint?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/amperser/proselint is the definitive source.
Why is amperser/proselint categorized under Developer Tools?
TopGit places amperser/proselint in the Developer Tools category based on its GitHub topics and description (tagged: "advice", "knowledge", "language"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Still deciding about proselint?
One click hands the question to an AI along with this page — see what it says about proselint.