codelaw-rules-spell 0.3.0__py3-none-any.whl

codelaw_rules_spell/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Arpit Arya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+SPDX-License-Identifier: MIT

codelaw_rules_spell/NOTICE

@@ -0,0 +1,45 @@
+@codelaw/rules-spell / codelaw-rules-spell
+
+The rules are codelaw's own (SR-SPELL). No code, word list, option or message
+is taken from another spell checker, and no word comes from a published list
+of common misspellings (SR-SPELL decision 6).
+
+data/spell/ is generated by codelaw's scripts/spell-data.py from the three
+sources below, and from no other (L11 §3, D-42, D-43 and D-44):
+
+- typos.json holds variants of words, not the sources' lists: single-edit
+  misspellings of SCOWL's most common words, with the word each comes from;
+- words.json is a dictionary: the words of SCOWL's English, American and
+  British lists of size 60 and below, in lower case, with the letters of the
+  software-terms list;
+- locale.json holds VarCon's one-to-one American and British spelling pairs.
+
+SCOWL (Spell Checker Oriented Word Lists), release 2020.12.07
+(http://wordlist.aspell.net/, scowl-2020.12.07.tar.gz,
+SHA-256 5587667caa20c4891390c2d42dbb4d5c4c3f41bee77af1457ece3ba23fb859cc) —
+Copyright 2000-2018 by Kevin Atkinson, with the notices of the works it draws
+on (12dicts, ENABLE, the Moby Words, Brian Kelk's word list, WordNet, the UK
+Advanced Cryptics Dictionary — Copyright (c) J Ross Beresford 1993-1999 — and
+VarCon, with the Ispell copyright of Geoff Kuenning). Permission to use, copy,
+modify, distribute and sell is granted provided the copyright notices appear;
+the full text, as published, is in licenses/SCOWL-Copyright.txt. The source
+words are SCOWL's English, American and British word lists of size 20 and
+below; the lists up to size 80, and its name, abbreviation and contraction
+lists, decide what is a word.
+
+@cspell/dict-software-terms 5.4.8 (https://github.com/streetsidesoftware/cspell-dicts,
+dict-software-terms-5.4.8.tgz, SHA-256
+4ea4907a9d9a066d53efbd964b44a8712c34014b5e6c7a5cf605a6ff2d0f11a1) — the word
+list dict/softwareTerms.txt.gz only, used to decide what is a word —
+Copyright (c) 2017-2025 Street Side Software, released under the MIT License;
+a copy is in licenses/software-terms-MIT.txt. Its corrections file
+(cspell-corrections.yaml) is not read.
+
+VarCon, release 2020.12.07 (http://wordlist.aspell.net/varcon.html,
+varcon-2020.12.07.tar.gz, SHA-256
+3b0720c5718008f37c02658a83d51d5598dd86531f0a2206d410c854006cb184) —
+Copyright 2000-2019 by Kevin Atkinson, Copyright 2016 by Benjamin Titze, and
+the Ispell copyright of Geoff Kuenning (1993). Permission to use, copy,
+modify, distribute and sell is granted provided the copyright notices
+appear; the full text, as published in its README, is in
+licenses/VarCon-Copyright.txt. Only varcon.txt is read.

codelaw_rules_spell/README.md

@@ -0,0 +1,69 @@
+# @codelaw/rules-spell
+
+codelaw's spell checker — one of the first-party rule packs
+([SR-RULE-PACKS](../../records/0101_rule-packs.md)), on npm and PyPI
+(`codelaw-rules-spell`). It reads the prose of every L3 language from the tree
+the engine parsed: comments and docstrings, prose strings, Markdown and HTML
+text, the string values of JSON, YAML and TOML, and the names a file
+declares — identifiers, keys, classes and ids. It is codelaw's own
+code and codelaw's own word data, generated from SCOWL
+([SR-SPELL](../../records/0116_spell.md)); it does not wrap CSpell.
+
+`codelaw init` never adds it: a team installs it on purpose.
+
+```toml
+# codelaw.toml
+extends = ["codelaw:spell/recommended"]
+preview = true   # every rule is `preview` until a corpus run promotes it
+```
+
+```sh
+npm i -D @codelaw/rules-spell      # or
+pip install codelaw-rules-spell
+```
+
+## Presets
+
+<!-- docs-sync:presets -->
+
+| preset | rules | ported from |
+|---|---|---|
+| `spell/recommended` | 3 | codelaw's own: known typos from a list generated from SCOWL, fixed unattended |
+| `spell/strict` | 6 | `spell/recommended` plus the dictionary check, one spelling per word across the project and the `[spell] words` check |
+
+<!-- /docs-sync:presets -->
+
+## Rules
+
+<!-- docs-sync:rules -->
+
+| rule | fix | flags |
+|---|---|---|
+| `spell/known-typo` | auto | a word on the known-typo list in a comment, a doc, a prose string or Markdown |
+| `spell/known-typo-identifier` | auto | a known typo in a JS, TS or Python name where it is declared; renamed only when the name is provably file-local |
+| `spell/known-typo-key` | manual | a known typo in a JSON, YAML or TOML key, a CSS or SCSS class, id or custom property, or an HTML `id` |
+| `spell/unknown-word` | suggest | a word of prose in no word list; the nearest dictionary word as the edit, up to three named (`spell/strict`) |
+| `spell/locale-variant` | auto | the other locale's spelling (`colour` under `en-US`), while `[spell] locale` is set (in no preset) |
+| `spell/inconsistent-term` | suggest | one word spelled two ways across the project (`canceled` / `cancelled`); the spelling the project uses most as the edit (`spell/strict`, a project rule) |
+| `spell/suspicious-word` | manual | a `[spell] words` entry that is a known typo or one edit from a common word (`spell/strict`) |
+
+<!-- /docs-sync:rules -->
+
+## Config
+
+```toml
+# codelaw.toml (the root config only)
+[spell]
+locale = "en-US"            # or "en-GB"; spell/locale-variant reports the other one
+words = ["kubectl", "Acme"] # accepted by every spell/* rule; spell/suspicious-word checks them
+
+[rules]
+"spell/locale-variant" = "warn"
+```
+
+## The word data
+
+`data/spell/` is written by `scripts/spell-data.py` and committed; the same
+sources write the same bytes: `typos.json` (188,138 generated known typos),
+`words.json` (92,758 words: SCOWL's US and British English to size 60, and the
+software terms) and `locale.json` (VarCon's one-to-one US and British pairs). Sources and their notices: [`NOTICE`](NOTICE).

codelaw_rules_spell/codelaw-pack.toml

@@ -0,0 +1,6 @@
+name = "@codelaw/rules-spell"
+version = "0.3.0"
+min_codelaw = "0.2.0"
+languages = ["javascript", "jsx", "typescript", "tsx", "python", "json", "yaml", "toml", "markdown", "css", "scss", "html"]
+presets = ["spell/recommended", "spell/strict"]
+description = "codelaw's spell checker: known typos fixed unattended, in every L3 language; word data generated from SCOWL (SR-SPELL)"

codelaw_rules_spell/corpus.toml

@@ -0,0 +1,11 @@
+# `codelaw test --corpus` finding counts (SR-RULE-AUTHORING decision 4).
+# Rewrite with --update-snapshot, and review the change.
+
+[findings]
+"spell/inconsistent-term" = 107
+"spell/known-typo" = 125
+"spell/known-typo-identifier" = 3
+"spell/known-typo-key" = 1
+"spell/locale-variant" = 0
+"spell/suspicious-word" = 0
+"spell/unknown-word" = 8948