Skip to main content

treepeat: a tool to find similarities in a codebase

Project description

Overview

treepeat is a tool that analyzes finds similarities in your codebase.

  • Find duplicate code blocks meaningful to the language (classes/functions), not just lines (--ruleset none)
  • Find near-duplicates, ignore whitespace, strings, high level AST nodes such as function and names (--ruleset default)
  • Find structurally similar code, ignoring anonymizing identifiers, constants, etc (--ruleset loose)

Pull requests welcome: This is very much an proof of concept - I'm happy with it, but I haven't supported very many languages at present. PRs welcome!

Current languages supported so far: bash, css, go, html, javascript, markdown, python, sql, typescript

Usage

Installation

pip insteall treepeat

detect

Scan a codebase for similar or duplicate code blocks using tree-sitter AST analysis and locality-sensitive hashing.

Key flags:

  • --ruleset: Normalization ruleset to use (none, default, loose) - controls how code is normalized before comparison
  • --similarity: Percent similarity from 1-100 (default: 100 for exact duplicates)
  • --min-lines: Minimum number of lines for a match (default: 5)
  • --diff: Show side-by-side comparisons of similar blocks
  • --format: Output format - console (default) or sarif for CI integration
# Find exact duplicates
treepeat detect /path/to/codebase

# Find near-duplicates with 80% similarity threshold
treepeat detect --similarity 80 /path/to/codebase

# Show diffs between similar blocks and use loose ruleset
treepeat --ruleset loose detect --diff --min-lines 10 /path/to/codebase

# Output results in SARIF format for CI tools
treepeat detect --format sarif -o results.sarif /path/to/codebase

Other sub commands

list-ruleset

List all rules in a ruleset, along with their descriptions. Use --language to see which rules apply to a specific language.

treesitter

Display how treepeat normalizes source code into tree-sitter tokens for similarity detection -- helpful for debugging why a certain section of a file might be similar to another. Shows the original source code side-by-side with the normalized token representation.

Dev setup

make setup
make test

ADRs

Architecture Decision Records live in docs/adr.

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

treepeat-0.1.1.tar.gz (48.6 kB view details)

Uploaded Source

Built Distribution

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

treepeat-0.1.1-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

Details for the file treepeat-0.1.1.tar.gz.

File metadata

  • Download URL: treepeat-0.1.1.tar.gz
  • Upload date:
  • Size: 48.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for treepeat-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c45798702ebbf68dcb2f5e223d0632d5a0a881057bcf8537dd77ce84c967cfcf
MD5 8a9ab09c287a209fc1d059ff8f82aa1b
BLAKE2b-256 45132c524e3fc7e5051aaa2fbba99c1d80fa7e8613ccad15d1d48d8c0ad5ffc7

See more details on using hashes here.

File details

Details for the file treepeat-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: treepeat-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 62.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for treepeat-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24d2827e60c8f5faf4c07e5d61039c5a0b3952d70f2806e0544f384c90d27d6a
MD5 a1d0aaf25a8c21be34084cf9dab0591c
BLAKE2b-256 5c6962a3cfda60c3380e48f64a8d02fd19aa3491f21baa6335eb057f58df984b

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