Skip to content

code_comments

Comment-density per language across tracked source files in the discovered git repo. tokei parses each file into code / comments / blanks; this fetcher surfaces the comment share. Text headlines the whole-repo ratio; TextBlock / MarkdownTextBlock / Entries / Bars rank per-language values (default percent, override with unit = loc | kloc); Ratio exposes the whole-repo share for gauges; Badge tiers documentation posture (undocumented / light / balanced / documented / verbose).

KindSafetyShapes
cachedSafetext, text_block, markdown_text_block, entries, bars, ratio, badge
OptionTypeRequiredDefaultDescription
limitintegerno10Cap on rendered languages (TextBlock / MarkdownTextBlock / Entries / Bars). The Text summary always reports the whole-repo ratio.
unitpercent (alias %) | loc | klocnopercentDisplay format for per-language values: percent (18.3% of that language's code+comments), loc (raw comment lines, 1,234), or kloc (1.2k). Ratio always emits the whole-repo comment share regardless of this option; Badge always reports tier + percent.
ShapeRenderers
textanimated_boot, animated_figlet_morph, animated_postfx, animated_scanlines, animated_splitflap, animated_typewriter, animated_wave, text_ascii, text_plain
text_blockanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, list_plain
markdown_text_blocktext_markdown
entriesanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, grid_table
barsanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, chart_bar, chart_pie, list_ranking
ratioanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, gauge_battery, gauge_circle, gauge_line, gauge_segment, gauge_thermometer
badgeanimated_boot, animated_postfx, animated_scanlines, animated_splitflap, animated_wave, status_badge
▗█  ▟▀▙     ▟▀▙ ▄ ▗▖                             ▟                  ▟▀▙      ▟█ 
 █  ▜▄▛      ▄▛ ▀▗▛     ▟▀▙ ▟▀▙ █▄█▖█▄█▖▟▀▙ █▀▙ ▝█▀ ▟▀▀      ▗▖      ▄▛     ▟▘█ 
 █  █ █  ▄  ▄ █ ▗▛▗▖    █ ▄ █ █ █▜▜▌█▜▜▌█▀▀ █ █  █▗ ▝▀▙      ▝▘     ▄ █  ▄  ▀▀█▘
▀▀▀ ▝▀▘  ▀  ▝▀▘ ▀ ▝▘    ▝▀▘ ▝▀▘ ▀ ▝▘▀ ▝▘▝▀▘ ▀ ▀  ▝▘ ▀▀▘             ▝▀▘ ▗▛   ▝▀▘
                                                                                
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "text_ascii"
18.3% comments · 3,456 / 18,892 lines   
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "text_plain"
Rust         24.1%                      
Markdown     58.0%                      
TypeScript    9.4%                      
TOML          4.2%                      
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "list_plain"
- Rust 24.1%                            
- Markdown 58.0%                        
- TypeScript 9.4%                       
- TOML 4.2%                             
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "text_markdown"
Rust                               24.1%
Markdown                           58.0%
TypeScript                          9.4%
TOML                                4.2%
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "grid_table"
███                                     
███                                     
███                                     
███                                     
███ ▁▁▁                                 
███ ███                                 
███ 580 ▆▆▆ 32                          
Rus Mar Typ TOM                         
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "chart_bar"
                                        
         ●          ■ Rust 69.3%        
    ●●●●●●●●●●●                         
   ●●●●●●●●●●●●●    ■ Markdown 21.2%    
  ●●●●●●●●●●●●●●●                       
 ●●●●●●●●●●●●●●●●●  ■ TypeScript 8.4%   
  ●●●●●●●●●●●●●●●                       
   ●●●●●●●●●●●●●    ■ TOML 1.2%         
    ●●●●●●●●●●●                         
         ●                              
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "chart_pie"
1. Rust                             1900
2. Markdown                          580
3. TypeScript                        230
4. TOML                               32
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "list_ranking"
                                        
         ┌────────────────────────┐     
comments │████░░░░░░░░░░░░░░░░░░░░│▮ 18%
         └────────────────────────┘     
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "gauge_battery"
███████                                 
███████         comments                
███████                                 
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "gauge_circle"
comments: ▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░ 18% 
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "gauge_line"
                                        
                                        
comments ▰▱▱▱▱ 18%                      
                                        
                                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "gauge_segment"
         ╭─╮        
         │░│        
         │░│        
         │░│        
comments │░│ 18%    
         │░│        
         │█│        
         ╰●╯        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "gauge_thermometer"
● balanced · 18%                        
[[widget]]
id = "code_comments"
fetcher = "code_comments"
render = "status_badge"