A0008 near-duplicate-fns¶
Rule: No two functions are near copies of each other.
| Code | A0008 (stable, never reused) |
| Id | near-duplicate-fns |
| Category | stop-gap |
| Source | spirit_level |
| Fix | by hand |
Level per tier¶
| Tier | Level | Reason |
|---|---|---|
| small | off | |
| small-workspace | off | |
| medium | off | |
| big | off | |
| ai | warn |
a rewrite that keeps the old function leaves two copies to fix |
| embedded | off | |
| ui | off | |
| egui | off | |
| units-strict | off | |
| units-paranoid | off |
Parameters¶
| Name | Type | Default | Meaning |
|---|---|---|---|
min-similarity |
number | 0.9 |
Jaccard index of normalized 4-token shingles from which two functions are copies |
min-tokens |
integer | 60 |
tokens a function needs to be compared |
Why¶
A rewrite that keeps the old version leaves two near-identical functions: both get called, one gets the fix. Agents do this when they add parse_v2 instead of changing parse.
The measure, for every function with a body in the non-test code of the workspace members:
- The function's text (signature and body) is tokenized. Local names (bindings, parameters, the function's own name) become
Iand literalsL. Keywords, punctuation and the names the function calls or reaches through a path (f(,.method,::item) stay. Renamed copies give the same tokens; two functions that call different things do not. - Functions with fewer than
min-tokenstokens are skipped: small accessors are alike by nature. - Each function's tokens become a set of 4-token shingles (windows of four).
- The similarity of two functions is the Jaccard index of their sets: shared shingles over all shingles.
A pair at or above min-similarity is reported, with the similarity as its metric. The finding points at the later of the two and names the other.
fn load(path: &str) -> Config { ... } // 40 lines
fn load_v2(p: &str) -> Config { ... } // the same 40 lines, one constant changed <- 96% alike
How to fix¶
Keep one: delete the old version, or make both call a shared function with the difference as a parameter.
Configure¶
[lints.near-duplicate-fns]
level = "deny"
min-similarity = 0.9
min-tokens = 60
reason = "why this project wants it at this level"
Allow one finding in the code with // spirit-level: allow(near-duplicate-fns) <reason> (waivers); the code works there too, as in [lints.A0008].