README

Twig 🌿 Metrics

Analyze your Twig templates and get a clear picture of their most important metrics

Warning

TwigMetrics is in active development. Use with caution, and expect things to change quickly.

This project is a melting pot of code or ideas I had while working on various Symfony projects. I'm releasing it as a standalone tool in case it can be useful to others.

Depending on the level of interest and feedback, I have plans to expand it into a more reliable and feature-rich tool.

What it does

TwigMetrics scans a directory of .twig templates and produces a full report:

• Template overview: number of files, directories, lines, characters
• Code style: average line length, comment ratio, indentation, formatting
• Callables: functions, filters, variables, macros, blocks, tests
• Architecture: includes, extends, embeds, imports, inheritance depth
• Complexity: logical depth, IF/ELSE/LOOP counts, nesting
• Maintainability: large files, high complexity hotspots, risk scores
• Visual output: ASCII tables and gauges directly in your terminal

$ bin/twigmetrics analyze templates/


  ╭─ Template Files ─────╮  ╭─ Logical Comp... ────╮  ╭─ Twig Callables ─────╮
  │  ● ● ● ● ○ ○      C  │  │  ● ● ● ● ● ○      B  │  │  ● ● ● ● ● ○      B  │
  ╰──────────────────────╯  ╰──────────────────────╯  ╰──────────────────────╯

  ╭─ Code Style ─────────╮  ╭─ Architecture ───────╮  ╭─ Maintainability ────╮
  │  ● ● ● ● ● ○      C  │  │  ● ● ● ● ● ○      B  │  │  ● ● ● ● ● ●      A+ │
  ╰──────────────────────╯  ╰──────────────────────╯  ╰──────────────────────╯

See examples of each section in the Usage section below.

Installation

Global (soon)

Tip

A PHAR release is planned, so you’ll be able to install it globally.

Composer

composer require --dev smnandre/twigmetrics

From source

git clone https://github.com/smnandre/twigmetrics.git
cd twigmetrics
composer install

Usage

To analyze a directory of Twig templates, run:

vendor/bin/twigmetrics path/to/templates

Twig Metrics

Template Files

  ╭─ Template Files ───────────────────────────────────────────────────────────╮
  │                                                                            │
  │   Total Templates ........... 188      Total Lines .............. 11,213   │
  │   Average Lines/File ....... 59.6      Median Lines ................. 48   │
  │   Size Coefficient (CV) .... 0.77      Gini Index ................ 0.380   │
  │   Directories ................ 19      Characters ............... 503.8k   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Logical Complexity

  ╭─ Logical Complexity ───────────────────────────────────────────────────────╮
  │                                                                            │
  │   Avg Complexity ............. 8.3      Max Complexity .............. 79   │
  │   Avg Depth .................. 1.2      Max Depth .................... 6   │
  │   IFs/Template ............... 1.3      FORs/Template .............. 0.6   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Twig Callables

  ╭─ Twig Callables ───────────────────────────────────────────────────────────╮
  │                                                                            │
  │   Total Calls ............. 4,632      Unique Functions ............. 23   │
  │   Unique Filters ............. 32      Unique Tests .................. 7   │
  │   Funcs/Template ............ 2.9      Filters/Template ........... 18.9   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Code Style

  ╭─ Code Style ───────────────────────────────────────────────────────────────╮
  │                                                                            │
  │   Avg Line Length ........... 41.0      Max Line Length ............ 217   │
  │   Indent Consistency ...... 100.0%      P95 Length ................. 217   │
  │   Consistency Score ........ 92.7%      Style Violations ........... 128   │
  │   Comments/Template .......... 0.6      Mixed Indentation ............ 0   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Architecture

  ╭─ Architecture ─────────────────────────────────────────────────────────────╮
  │                                                                            │
  │   Imports/Template ......... 0.00      Extends/Template ........... 0.22   │
  │   Avg Inherit Depth ......... 0.2      Includes/Template .......... 0.57   │
  │   Embeds/Template .......... 0.04      Blocks/Template ............ 1.13   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Maintainability

  ╭─ Maintainability ──────────────────────────────────────────────────────────╮
  │                                                                            │
  │   Empty Lines Ratio ....... 10.0%      MI Average ................ 107.2   │
  │   MI Median ............... 106.7      Comment Density ............ 1.3%   │
  │   High Risk ................... 3      Medium Risk .................. 40   │
  │                                                                            │
  ╰────────────────────────────────────────────────────────────────────────────╯

Contributing

Feedback, issues, and pull requests are very welcome!

• Issues: github.com/smnandre/twigmetrics/issues
• Pull Requests: github.com/smnandre/twigmetrics/pulls

License

Twig Metrics is licensed under the MIT License. See the LICENSE file for details.