API Reference¶
This page provides documentation for Recursivist's Python API, automatically generated from the source code's docstrings, which can be used to integrate directory visualization and analysis capabilities into your own Python applications.
Core Module¶
recursivist.core
¶
Core functionality for the Recursivist directory visualization tool.
This module provides the fundamental components for building, filtering, displaying, and exporting directory structures. It handles directory traversal, pattern matching, color coding, file statistics calculation, and tree construction.
Key components: - Directory structure parsing and representation - Pattern-based filtering (gitignore, glob, regex) - File extension color coding - Tree visualization with rich formatting - Lines of code counting - File size calculation and formatting - Modification time retrieval and formatting - Maximum depth limiting
build_tree(structure, tree, color_map, parent_name='Root', show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Build the tree structure with colored file names.
Recursively builds a rich.Tree representation of the directory structure with files color-coded by extension. When sort_by_loc is True, displays lines of code counts for files and directories. When sort_by_size is True, displays file sizes for files and directories. When sort_by_mtime is True, displays file modification times.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
structure | Dict | Dictionary representation of the directory structure | required |
tree | Tree | Rich Tree object to build upon | required |
color_map | Dict[str, str] | Mapping of file extensions to colors | required |
parent_name | str | Name of the parent directory | 'Root' |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to display lines of code counts | False |
sort_by_size | bool | Whether to display file sizes | False |
sort_by_mtime | bool | Whether to display file modification times | False |
Source code in recursivist/core.py
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 |
|
compile_regex_patterns(patterns, is_regex=False)
¶
Convert patterns to compiled regex objects when appropriate.
When is_regex is True, compiles string patterns into regex pattern objects for efficient matching. For invalid regex patterns, logs a warning and keeps them as strings.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
patterns | Sequence[str] | List of patterns to compile | required |
is_regex | bool | Whether the patterns should be treated as regex (True) or glob patterns (False) | False |
Returns:
Type | Description |
---|---|
List[Union[str, Pattern[str]]] | List of patterns (strings for glob patterns or compiled regex objects) |
Source code in recursivist/core.py
count_lines_of_code(file_path)
¶
Count the number of lines in a file.
Counts lines in text files while handling encoding issues and skipping binary files.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path | str | Path to the file | required |
Returns:
Type | Description |
---|---|
int | Number of lines in the file, or 0 if the file cannot be read or is binary |
Source code in recursivist/core.py
display_tree(root_dir, exclude_dirs=None, ignore_file=None, exclude_extensions=None, exclude_patterns=None, include_patterns=None, use_regex=False, max_depth=0, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Display a directory tree in the terminal with rich formatting.
Presents a directory structure as a tree with: - Color-coded file extensions - Optional statistics (lines of code, sizes, modification times) - Filtered content based on exclusion patterns - Depth limitations if specified
This function handles the entire process from scanning the directory to displaying the final tree visualization.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root_dir | str | Root directory path to display | required |
exclude_dirs | Optional[List[str]] | List of directory names to exclude | None |
ignore_file | Optional[str] | Name of ignore file (like .gitignore) | None |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
exclude_patterns | Optional[List[str]] | List of patterns to exclude | None |
include_patterns | Optional[List[str]] | List of patterns to include (overrides exclusions) | None |
use_regex | bool | Whether to treat patterns as regex instead of glob patterns | False |
max_depth | int | Maximum depth to display (0 for unlimited) | 0 |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to show and sort by lines of code | False |
sort_by_size | bool | Whether to show and sort by file size | False |
sort_by_mtime | bool | Whether to show and sort by modification time | False |
Source code in recursivist/core.py
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 |
|
export_structure(structure, root_dir, format_type, output_path, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Export the directory structure to various formats.
Maps the requested format to the appropriate export method using DirectoryExporter. Handles txt, json, html, md, and jsx formats with consistent styling.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
structure | Dict | Directory structure dictionary | required |
root_dir | str | Root directory name | required |
format_type | str | Export format ('txt', 'json', 'html', 'md', 'jsx') | required |
output_path | str | Path where the export file will be saved | required |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to include lines of code counts in the export | False |
sort_by_size | bool | Whether to include file size information in the export | False |
sort_by_mtime | bool | Whether to include file modification times in the export | False |
Raises:
Type | Description |
---|---|
ValueError | If the format_type is not supported |
Source code in recursivist/core.py
format_size(size_in_bytes)
¶
Format a size in bytes to a human-readable string.
Converts raw byte counts to appropriate units (B, KB, MB, GB) with consistent formatting.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
size_in_bytes | int | Size in bytes | required |
Returns:
Type | Description |
---|---|
str | Human-readable size string (e.g., "4.2 MB") |
Source code in recursivist/core.py
format_timestamp(timestamp)
¶
Format a Unix timestamp to a human-readable string.
Intelligently formats timestamps with different representations based on recency: - Today: "Today HH:MM" - Yesterday: "Yesterday HH:MM" - Last week: "Day HH:MM" (e.g., "Mon 14:30") - This year: "Month Day" (e.g., "Mar 15") - Older: "YYYY-MM-DD"
Parameters:
Name | Type | Description | Default |
---|---|---|---|
timestamp | float | Unix timestamp (seconds since epoch) | required |
Returns:
Type | Description |
---|---|
str | Human-readable date/time string |
Source code in recursivist/core.py
generate_color_for_extension(extension)
¶
Generate a consistent color for a file extension.
Creates a deterministic color based on the extension string using a hash function. The same extension will always get the same color within a session, ensuring visual consistency.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
extension | str | File extension (with or without leading dot) | required |
Returns:
Type | Description |
---|---|
str | Hex color code (e.g., "#FF5733") |
Source code in recursivist/core.py
get_directory_structure(root_dir, exclude_dirs=None, ignore_file=None, exclude_extensions=None, parent_ignore_patterns=None, exclude_patterns=None, include_patterns=None, max_depth=0, current_depth=0, current_path='', show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Build a nested dictionary representing a directory structure.
Recursively traverses the file system applying filters and collecting statistics. The resulting structure contains: - Hierarchical representation of directories and files - Optional statistics (lines of code, sizes, modification times) - Filtered entries based on various exclusion patterns
Special dictionary keys: - "_files": List of files in the directory - "_loc": Total lines of code (if sort_by_loc is True) - "_size": Total size in bytes (if sort_by_size is True) - "_mtime": Latest modification timestamp (if sort_by_mtime is True) - "_max_depth_reached": Flag indicating max depth was reached
Parameters:
Name | Type | Description | Default |
---|---|---|---|
root_dir | str | Root directory path to start from | required |
exclude_dirs | Optional[Sequence[str]] | List of directory names to exclude | None |
ignore_file | Optional[str] | Name of ignore file (like .gitignore) | None |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
parent_ignore_patterns | Optional[Sequence[str]] | Patterns from parent directories' ignore files | None |
exclude_patterns | Optional[Sequence[Union[str, Pattern[str]]]] | List of patterns (glob or regex) to exclude | None |
include_patterns | Optional[Sequence[Union[str, Pattern[str]]]] | List of patterns (glob or regex) to include (overrides exclusions) | None |
max_depth | int | Maximum depth to traverse (0 for unlimited) | 0 |
current_depth | int | Current depth in the directory tree (for internal recursion) | 0 |
current_path | str | Current path for full path display (for internal recursion) | '' |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to calculate and track lines of code counts | False |
sort_by_size | bool | Whether to calculate and track file sizes | False |
sort_by_mtime | bool | Whether to track file modification times | False |
Returns:
Type | Description |
---|---|
Tuple[Dict[str, Any], Set[str]] | Tuple of (structure dictionary, set of file extensions found) |
Source code in recursivist/core.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 |
|
get_file_mtime(file_path)
¶
Get the modification time of a file in seconds since epoch.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path | str | Path to the file | required |
Returns:
Type | Description |
---|---|
float | Modification time as a float (seconds since epoch), or 0 if the file cannot be accessed |
Source code in recursivist/core.py
get_file_size(file_path)
¶
Get the size of a file in bytes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path | str | Path to the file | required |
Returns:
Type | Description |
---|---|
int | Size of the file in bytes, or 0 if the file cannot be accessed |
Source code in recursivist/core.py
parse_ignore_file(ignore_file_path)
¶
Parse an ignore file (like .gitignore) and return patterns.
Reads an ignore file and extracts patterns for excluding files and directories. Handles comments and trailing slashes in directories.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ignore_file_path | str | Path to the ignore file | required |
Returns:
Type | Description |
---|---|
List[str] | List of patterns to ignore |
Source code in recursivist/core.py
should_exclude(path, ignore_context, exclude_extensions=None, exclude_patterns=None, include_patterns=None)
¶
Determine if a path should be excluded based on filtering rules.
Applies a hierarchical filtering logic: 1. If include_patterns match, INCLUDE the path (overrides all exclusions) 2. If exclude_patterns match, EXCLUDE the path 3. If file extension is in exclude_extensions, EXCLUDE the path 4. If gitignore-style patterns match, follow their rules (including negations)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path | str | Path to check for exclusion | required |
ignore_context | Dict | Dictionary with 'patterns' and 'current_dir' keys | required |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
exclude_patterns | Optional[Sequence[Union[str, Pattern[str]]]] | List of patterns (glob or regex) to exclude | None |
include_patterns | Optional[Sequence[Union[str, Pattern[str]]]] | List of patterns (glob or regex) to include (overrides exclusions) | None |
Returns:
Type | Description |
---|---|
bool | True if path should be excluded, False otherwise |
Source code in recursivist/core.py
sort_files_by_type(files, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Sort files by extension and then by name, or by LOC/size/mtime if requested.
The sort precedence follows: LOC > size > mtime > extension/name
Parameters:
Name | Type | Description | Default |
---|---|---|---|
files | Sequence[Union[str, Tuple[str, str], Tuple[str, str, int], Tuple[str, str, int, int], Tuple[str, str, int, int, float]]] | List of file items, which can be strings or tuples of various forms | required |
sort_by_loc | bool | Whether to sort by lines of code | False |
sort_by_size | bool | Whether to sort by file size | False |
sort_by_mtime | bool | Whether to sort by modification time | False |
Returns:
Type | Description |
---|---|
List[Union[str, Tuple[str, str], Tuple[str, str, int], Tuple[str, str, int, int], Tuple[str, str, int, int, float]]] | Sorted list of file items |
Source code in recursivist/core.py
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 |
|
Exports Module¶
recursivist.exports
¶
Export functionality for the Recursivist directory visualization tool.
This module handles the export of directory structures to various formats through the DirectoryExporter class, which provides a unified interface for transforming directory structures into different output formats.
Supported export formats: - TXT: ASCII tree representation - JSON: Structured data for programmatic use - HTML: Interactive web page with styling - Markdown: Clean representation for documentation - JSX: React component for web integration
Each format maintains consistent styling and organization, with support for showing lines of code, file sizes, and modification times.
DirectoryExporter
¶
Export directory structures to various formats.
Provides a unified interface for transforming directory structures into different output formats with consistent styling and organization.
Supported formats: - TXT: ASCII tree representation - JSON: Structured data for programmatic use - HTML: Interactive web page with styling - Markdown: Clean representation for documentation - JSX: React component for web integration
Each format maintains consistent features for: - Directory and file hierarchical representation - Optional statistics (lines of code, sizes, modification times) - Path display options (full or relative paths)
Source code in recursivist/exports.py
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 |
|
__init__(structure, root_name, base_path=None, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Initialize the exporter with directory structure and root name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
structure | Dict[str, Any] | The directory structure dictionary | required |
root_name | str | Name of the root directory | required |
base_path | Optional[str] | Base path for full path display (if None, only show filenames) | None |
sort_by_loc | bool | Whether to include lines of code counts in exports | False |
sort_by_size | bool | Whether to include file size information in exports | False |
sort_by_mtime | bool | Whether to include modification time information in exports | False |
Source code in recursivist/exports.py
to_html(output_path)
¶
Export directory structure to an HTML file.
Creates a standalone HTML file with a styled representation of the directory structure using nested unordered lists with CSS styling for colors and indentation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_path | str | Path where the HTML file will be saved | required |
Source code in recursivist/exports.py
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 |
|
to_json(output_path)
¶
Export directory structure to a JSON file.
Creates a JSON file containing the directory structure with options for including full paths, LOC counts, file sizes, and modification times. The JSON structure includes a root name and the hierarchical structure of directories and files.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_path | str | Path where the JSON file will be saved | required |
Source code in recursivist/exports.py
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 |
|
to_jsx(output_path)
¶
Export directory structure to a React component (JSX file).
Creates a JSX file containing a React component for interactive visualization of the directory structure with collapsible folders and styling.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_path | str | Path where the React component file will be saved | required |
Source code in recursivist/exports.py
to_markdown(output_path)
¶
Export directory structure to a Markdown file.
Creates a Markdown file with a structured representation of the directory hierarchy using headings, lists, and formatting to distinguish between files and directories.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_path | str | Path where the Markdown file will be saved | required |
Source code in recursivist/exports.py
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 |
|
to_txt(output_path)
¶
Export directory structure to a text file with ASCII tree representation.
Creates a text file containing an ASCII tree representation of the directory structure using standard box-drawing characters and indentation.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_path | str | Path where the txt file will be saved | required |
Source code in recursivist/exports.py
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
|
sort_files_by_type(files, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Sort files by extension and then by name, or by LOC/size/mtime if requested.
Source code in recursivist/exports.py
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
|
Compare Module¶
recursivist.compare
¶
Comparison functionality for the Recursivist directory visualization tool.
This module implements side-by-side directory structure comparison with visual highlighting of differences. It provides terminal output with colored indicators and HTML export for sharing and documentation.
Key features: - Visual highlighting of items unique to each directory - Consistent color coding for file extensions - Support for all the same filtering options as visualization - Export to HTML with interactive features - Optional display of statistics (LOC, size, modification times) - Legend explaining the highlighting scheme
_export_comparison_to_html(comparison_data, output_path)
¶
Export comparison to HTML format.
Internal helper function that generates an HTML file from comparison data. Creates a responsive, styled HTML document with side-by-side directory trees and highlighted differences. Supports displaying LOC counts, file sizes, and modification times when enabled.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
comparison_data | Dict[str, Any] | Dictionary containing comparison structures and metadata | required |
output_path | str | Path where the HTML file will be saved | required |
Source code in recursivist/compare.py
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 |
|
build_comparison_tree(structure, other_structure, tree, color_map, parent_name='Root', show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Build a tree structure with highlighted differences.
Recursively builds a Rich tree with visual indicators for: - Items that exist in both structures (normal display) - Items unique to the current structure (green background) - Items unique to the comparison structure (red background)
When sort_by_loc is True, also displays lines of code counts. When sort_by_size is True, also displays file sizes. When sort_by_mtime is True, also displays file modification times.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
structure | Dict | Dictionary representation of the current directory structure | required |
other_structure | Dict | Dictionary representation of the comparison directory structure | required |
tree | Tree | Rich Tree object to build upon | required |
color_map | Dict[str, str] | Mapping of file extensions to colors | required |
parent_name | str | Name of the parent directory | 'Root' |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to display lines of code counts | False |
sort_by_size | bool | Whether to display file sizes | False |
sort_by_mtime | bool | Whether to display file modification times | False |
Source code in recursivist/compare.py
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 |
|
compare_directory_structures(dir1, dir2, exclude_dirs=None, ignore_file=None, exclude_extensions=None, exclude_patterns=None, include_patterns=None, max_depth=0, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Compare two directory structures and return both structures with a combined set of extensions.
Retrieves the directory structures for both directories using the same filtering options, then combines their file extensions for consistent color mapping in visualizations.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dir1 | str | Path to the first directory | required |
dir2 | str | Path to the second directory | required |
exclude_dirs | Optional[Sequence[str]] | List of directory names to exclude | None |
ignore_file | Optional[str] | Name of ignore file (like .gitignore) | None |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
exclude_patterns | Optional[Sequence[Union[str, Pattern]]] | List of patterns to exclude | None |
include_patterns | Optional[Sequence[Union[str, Pattern]]] | List of patterns to include (overrides exclusions) | None |
max_depth | int | Maximum depth to display (0 for unlimited) | 0 |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to calculate and display lines of code counts | False |
sort_by_size | bool | Whether to calculate and display file sizes | False |
sort_by_mtime | bool | Whether to calculate and display file modification times | False |
Returns:
Type | Description |
---|---|
Tuple[Dict, Dict, Set[str]] | Tuple of (structure1, structure2, combined_extensions) |
Source code in recursivist/compare.py
display_comparison(dir1, dir2, exclude_dirs=None, ignore_file=None, exclude_extensions=None, exclude_patterns=None, include_patterns=None, use_regex=False, max_depth=0, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Display two directory trees side by side with highlighted differences.
Creates a side-by-side terminal visualization with: - Two panel layout with labeled directory trees - Color-coded highlighting for unique items (green/red background) - Informative legend explaining the highlighting - Support for all standard filtering options - Optional statistics display (LOC, size, modification time)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dir1 | str | Path to the first directory | required |
dir2 | str | Path to the second directory | required |
exclude_dirs | Optional[List[str]] | List of directory names to exclude | None |
ignore_file | Optional[str] | Name of ignore file (like .gitignore) | None |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
exclude_patterns | Optional[List[str]] | List of patterns to exclude | None |
include_patterns | Optional[List[str]] | List of patterns to include (overrides exclusions) | None |
use_regex | bool | Whether to treat patterns as regex instead of glob patterns | False |
max_depth | int | Maximum depth to display (0 for unlimited) | 0 |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to show and sort by lines of code | False |
sort_by_size | bool | Whether to show and sort by file size | False |
sort_by_mtime | bool | Whether to show and sort by modification time | False |
Source code in recursivist/compare.py
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
|
export_comparison(dir1, dir2, format_type, output_path, exclude_dirs=None, ignore_file=None, exclude_extensions=None, exclude_patterns=None, include_patterns=None, use_regex=False, max_depth=0, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Export directory comparison to HTML format.
Creates an HTML file containing the side-by-side comparison with: - Highlighted differences between directories - Interactive, responsive layout - Detailed metadata about the comparison settings - Visual legend explaining the highlighting - Optional statistics display
Currently only supports HTML export format.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dir1 | str | Path to the first directory | required |
dir2 | str | Path to the second directory | required |
format_type | str | Export format (only 'html' is supported) | required |
output_path | str | Path where the export file will be saved | required |
exclude_dirs | Optional[List[str]] | List of directory names to exclude | None |
ignore_file | Optional[str] | Name of ignore file (like .gitignore) | None |
exclude_extensions | Optional[Set[str]] | Set of file extensions to exclude | None |
exclude_patterns | Optional[List[str]] | List of patterns to exclude | None |
include_patterns | Optional[List[str]] | List of patterns to include (overrides exclusions) | None |
use_regex | bool | Whether to treat patterns as regex instead of glob patterns | False |
max_depth | int | Maximum depth to display (0 for unlimited) | 0 |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to show and sort by lines of code | False |
sort_by_size | bool | Whether to show and sort by file size | False |
sort_by_mtime | bool | Whether to show and sort by modification time | False |
Raises:
Type | Description |
---|---|
ValueError | If the format_type is not supported |
Source code in recursivist/compare.py
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 |
|
JSX Export Module¶
recursivist.jsx_export
¶
React component export functionality for the Recursivist directory visualization tool.
This module generates a JSX file containing a sophisticated, interactive directory viewer React component with advanced features:
- Folder expansion/collapse functionality
- Breadcrumb navigation
- Search with highlighted matches
- Dark mode toggle
- Optional file statistics display
- Sorting by different metrics
- Path copying
- Mobile-responsive design
The generated component is standalone and can be integrated into React applications with minimal dependencies.
generate_jsx_component(structure, root_name, output_path, show_full_path=False, sort_by_loc=False, sort_by_size=False, sort_by_mtime=False)
¶
Generate a React component file for directory structure visualization.
Creates a standalone JSX file containing a sophisticated directory viewer component with: - Reliable folder expand/collapse functionality - Breadcrumbs navigation - Search functionality with highlighted matches - Dark mode toggle - Path copying - Expand/collapse all buttons - Optional statistics display (LOC, size, modification times) - Mobile-responsive design
Parameters:
Name | Type | Description | Default |
---|---|---|---|
structure | Dict[str, Any] | Directory structure dictionary | required |
root_name | str | Root directory name | required |
output_path | str | Path where the React component file will be saved | required |
show_full_path | bool | Whether to show full paths instead of just filenames | False |
sort_by_loc | bool | Whether to show lines of code counts and sort by them | False |
sort_by_size | bool | Whether to show file sizes and sort by them | False |
sort_by_mtime | bool | Whether to show file modification times and sort by them | False |
Source code in recursivist/jsx_export.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 |
|
Using the Python API in Custom Scripts¶
Here's an example of how to use the Python API to create a custom directory analysis script:
import sys
from recursivist.core import get_directory_structure
from recursivist.core import export_structure
def analyze_directory(directory_path):
# Get directory structure with line counts and file sizes
structure, extensions = get_directory_structure(
directory_path,
exclude_dirs=["node_modules", ".git", "venv"],
exclude_extensions={".pyc", ".log", ".tmp"},
sort_by_loc=True,
sort_by_size=True
)
# Export to multiple formats
export_structure(structure, directory_path, "md", "analysis.md", sort_by_loc=True, sort_by_size=True)
export_structure(structure, directory_path, "json", "analysis.json", sort_by_loc=True, sort_by_size=True)
# Calculate some statistics
total_loc = structure.get("_loc", 0)
total_size = structure.get("_size", 0)
print(f"Directory: {directory_path}")
print(f"Total lines of code: {total_loc}")
print(f"Total size: {total_size} bytes")
# Find the files with the most lines of code
def collect_files(structure, path=""):
files = []
for name, content in structure.items():
if name == "_files":
for file_item in content:
if isinstance(file_item, tuple) and len(file_item) > 2:
file_name, full_path, loc = file_item[0], file_item[1], file_item[2]
files.append((file_name, full_path, loc))
elif isinstance(content, dict) and name not in ["_max_depth_reached", "_loc", "_size", "_mtime"]:
files.extend(collect_files(content, f"{path}/{name}"))
return files
files = collect_files(structure)
files.sort(key=lambda x: x[2], reverse=True)
print("\nTop 5 files by lines of code:")
for i, (name, path, loc) in enumerate(files[:5], 1):
print(f"{i}. {path} ({loc} lines)")
if __name__ == "__main__":
if len(sys.argv) > 1:
analyze_directory(sys.argv[1])
else:
analyze_directory(".")
API Extension Points¶
If you're looking to extend Recursivist's functionality, these are the main extension points:
- Custom Pattern Matching: Extend the
should_exclude
function incore.py
- New Export Format: Add a new method to the
DirectoryExporter
class inexports.py
- Custom Visualization: Modify the
build_tree
anddisplay_tree
functions incore.py
- Custom Statistics: Add new statistics collection to the
get_directory_structure
function
The API is designed to be modular, making it possible to reuse individual components for custom functionality while maintaining consistent behavior across the library.