https://github.com/smnandre/twigmetrics

TwigMetrics turns your templates into numbers: structure, lines of code, code style, complexity, maintanability ...
https://github.com/smnandre/twigmetrics

audit charts code-style console loc metrics numbers php quality symfony template templates tool twig twig-templates

Last synced: 3 months ago
JSON representation

TwigMetrics turns your templates into numbers: structure, lines of code, code style, complexity, maintanability ...

Host: GitHub
URL: https://github.com/smnandre/twigmetrics
Owner: smnandre
License: mit
Created: 2025-08-24T15:15:06.000Z (4 months ago)
Default Branch: main
Last Pushed: 2025-09-05T17:22:34.000Z (4 months ago)
Last Synced: 2025-09-08T13:17:06.567Z (4 months ago)
Topics: audit, charts, code-style, console, loc, metrics, numbers, php, quality, symfony, template, templates, tool, twig, twig-templates
Language: PHP
Homepage:
Size: 228 KB
Stars: 6
Watchers: 0
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Twig 🌿 Metrics

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

Twig Metrics

---

![PHP Version](https://img.shields.io/badge/PHP-8.3+-2e7d32?logoColor=6AB76E&labelColor=010)
![CI](https://img.shields.io/github/actions/workflow/status/smnandre/twigmetrics/CI.yaml?branch=main&label=Tests&logoColor=white&logoSize=auto&labelColor=010&color=388e3c)
![Release](https://img.shields.io/github/v/release/smnandre/twigmetrics?label=Stable&logoColor=white&logoSize=auto&labelColor=010&color=43a047)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/smnandre?logo=github-sponsors&logoColor=66bb6a&logoSize=auto&label=%20Sponsor&labelColor=010&color=a5d6a7)](https://github.com/sponsors/smnandre)
![License](https://img.shields.io/github/license/smnandre/twigmetrics?label=License&logoColor=white&logoSize=auto&labelColor=010&color=2e7d32)

---

> [!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

```bash
$ 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](#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](https://github.com/smnandre/twigmetrics/issues)
* Pull Requests: [github.com/smnandre/twigmetrics/pulls](https://github.com/smnandre/twigmetrics/pulls)

## License

[Twig Metrics](https://github.com/smnandre/twigmetrics) is licensed under the MIT
License. See the [LICENSE](./LICENSE) file for details.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/smnandre/twigmetrics

Awesome Lists containing this project

README

Twig 🌿 Metrics