Skip to content

Commit 7ff394a

Browse files
#49 Release 2.0.0 (#50)
2 parents 47ec18e + ca1c45d commit 7ff394a

28 files changed

+483
-427
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,4 @@ node_modules/
6464
composer.lock
6565

6666
.claude/
67+
CLAUDE.md

.markdownlint.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
# Example markdownlint YAML configuration with all properties set to their default value
1+
#########################################################################
2+
#
3+
# █▀▀▄ ▀ ▀▀█▀▀ ▀█ █
4+
# █ █ ▀█ ▄▀▀▄ ▄▀▀▄ ▄▀▀▄ █ ▄▀▀▄ ▄▀▀▄ █ █▀▀▄ ▄▀▀▄ █▄▀
5+
# █ █ █ ▀▄ █ █ █ █ █ █ █ █ █ █ █ ▄▄█ █
6+
# █▄▄▀ ▄█▄ ▀▄▄▀ ▀▄▄▀ ▀▄▄▀ █ ▀▄▄▀ ▀▄▄▀ ▄█▄ █▄▄▀ ▀▄▄▀ █
7+
#
8+
######### Customizable developer toolbar for Symfony projects ########
9+
#
10+
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
11+
# @copyright 2025-2026 Marcin Orlowski
12+
# @license https://opensource.org/license/mit MIT
13+
# @link https://github.com/MarcinOrlowski/php-discotoolbar-symfony
14+
#
15+
#########################################################################
216

317
# Default state for all rules
418
default: true

.pre-commit-config.yaml

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,34 @@
1-
##################################################################################
2-
#
3-
# Laravel API Response Builder PHPStan config file
4-
#
5-
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
6-
# @copyright 2016-2025 Marcin Orlowski
7-
# @license http://www.opensource.org/licenses/mit-license.php MIT
8-
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
9-
#
10-
##################################################################################
1+
#########################################################################
2+
#
3+
# █▀▀▄ ▀ ▀▀█▀▀ ▀█ █
4+
# █ █ ▀█ ▄▀▀▄ ▄▀▀▄ ▄▀▀▄ █ ▄▀▀▄ ▄▀▀▄ █ █▀▀▄ ▄▀▀▄ █▄▀
5+
# █ █ █ ▀▄ █ █ █ █ █ █ █ █ █ █ █ ▄▄█ █
6+
# █▄▄▀ ▄█▄ ▀▄▄▀ ▀▄▄▀ ▀▄▄▀ █ ▀▄▄▀ ▀▄▄▀ ▄█▄ █▄▄▀ ▀▄▄▀ █
7+
#
8+
######### Customizable developer toolbar for Symfony projects ########
9+
#
10+
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
11+
# @copyright 2025-2026 Marcin Orlowski
12+
# @license https://opensource.org/license/mit MIT
13+
# @link https://github.com/MarcinOrlowski/php-discotoolbar-symfony
14+
#
15+
#########################################################################
16+
1117
#
1218
# Using pre-commit hooks #
1319
#
1420
# To improve quality of your commit, it's recommended to use "pre-commit"
15-
# (http://pre-commit.com) hooks, that will block your commits unless all tests
16-
# pass. This project comes with template configuration file
17-
# `.pre-commit-config.yaml.dist`.
21+
# (http://pre-commit.com) hooks, that will block your commits unless all tests pass.
1822
#
1923
# Brief installation instruction:
2024
#
21-
# * Ensure you got Python installed
22-
# * Install pre-commit: `pip install pre-commit`
23-
# * Go to your Logisim-evolution source code root directory
24-
# * Copy provided config file template: `cp .pre-commit-config.yaml.dist .pre-commit-config.yaml`
25+
# * Install pipx: https://pypi.org/project/pipx/
26+
# * Run `pipx ensurepath`
27+
# * Install pre-commit: `pipx install pre-commit`
2528
# * Plug hooks into Git pipeline: `pre-commit install`
29+
# * Update hooks to most recent version: `pre-commit autoupdate`
30+
#
31+
# To commit with hooks not run, use `--no-verify` while doing `git commit`
2632
#
2733
# See `pre-commit` official installation docs too: https://pre-commit.com/#install
2834
#

CHANGES.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1+
![img](img/banner.webp)
2+
13
# Changelog
24

3-
## 1.6.0 (TBD)
5+
## 2.0.0 (2026-01-30)
46

7+
- [#044] Renamed package to `marcin-orlowski/disco-toolbar-symfony`
8+
- [#047] Rebranded from DiscoDevBar to DiscoToolbar
9+
- [#041] Added Symfony 8 support
10+
- [#042] Added project logo!
511
- [#035] Added customizable background colors for breathing stripes
6-
- [#033] Added close widget type to dismiss devbar
12+
- [#033] Added close widget type to dismiss toolbar
713

814
## 1.5.2 (2025-12-12)
915

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Marcin Orlowski
3+
Copyright (c) 2025-2026 Marcin Orlowski
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 43 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,40 @@
1-
```ascii
2-
▄▀▀▄ ▄▀█ █▀▀▄ ▀ █▀▀▄ █▀▀▄
3-
▀▄▄ █▀█▀▄ █ ▄▀▀▄ █▀▀▄ █ █ ▀█ ▄▀▀▄ ▄▀▀▄ ▄▀▀▄ █ █ ▄▀▀▄ █ █ █▀▀▄ ▄▀▀▄ █▄▀
4-
█ █ █ █ █ █ ▀█▀ █ █ █ █ █ █ █ █ █ ▀▄ █ █ █ █ █ █▀▀ █ █ █ █ ▄▄█ █
5-
▀▄▄▀ ▀▄▄█ █ █ █ ▀▄▄▀ █ █ ▀▄▄█ █▄▄▀ ▄█▄ ▀▄▄▀ ▀▄▄▀ ▀▄▄▀ █▄▄▀ ▀▄▄▀ ▀▄▀ █▄▄▀ ▀▄▄▀ █
6-
▄▄▄▀ ▄▄▄▀
7-
8-
Customizable developer toolbar for Symfony projects
9-
```
10-
1+
![img](img/banner.webp)
112

12-
[![Latest Stable Version](https://poser.pugx.org/marcin-orlowski/symfony-discodevbar/v)](https://packagist.org/packages/marcin-orlowski/symfony-discodevbar)
13-
[![Monthly Downloads](https://poser.pugx.org/marcin-orlowski/symfony-discodevbar/d/monthly)](https://packagist.org/packages/marcin-orlowski/symfony-discodevbar)
14-
[![License](https://poser.pugx.org/marcin-orlowski/symfony-discodevbar/license)](https://packagist.org/packages/marcin-orlowski/symfony-discodevbar)
3+
[![Latest Stable Version](https://poser.pugx.org/marcin-orlowski/disco-toolbar-symfony/v)](https://packagist.org/packages/marcin-orlowski/disco-toolbar-symfony)
4+
[![Monthly Downloads](https://poser.pugx.org/marcin-orlowski/disco-toolbar-symfony/d/monthly)](https://packagist.org/packages/marcin-orlowski/disco-toolbar-symfony)
5+
[![License](https://poser.pugx.org/marcin-orlowski/disco-toolbar-symfony/license)](https://packagist.org/packages/marcin-orlowski/disco-toolbar-symfony)
156

167

178
# Welcome!
189

19-
**DiscoDevBar** is a developer tool that adds a customizable toolbar/banner to your Symfony application,
20-
providing all-time access to essential development resources right from your browser. Perfect for
21-
streamlining your development workflow by keeping frequently-used tools, admin panels, and services
22-
just one click away.
10+
**DiscoToolbar** is a customizable toolbar for your Symfony application, providing all-time access to
11+
essential resources right from your browser. Perfect for streamlining your workflow by keeping
12+
frequently-used tools, admin panels, and services just one click away.
13+
14+
> **NOTE:** This package is also available for Laravel framework!
15+
> See [project page](https://github.com/MarcinOrlowski/php-discotoolbar-laravel) for more information!
2316
24-
## What is DiscoDevBar?
17+
## What is DiscoToolbar?
2518

26-
DiscoDevBar creates a persistent banner (typically placed at the top of your layout) that displays
19+
DiscoToolbar creates a persistent banner (typically placed at the top of your layout) that displays
2720
during development. It's highly configurable via YAML, allowing you to create custom buttons and
2821
links to anything you need: admin panels, database tools, email catchers, API documentation, or
29-
any other development resource.
22+
any other resource.
3023

31-
![img](img/disco-devbar.png)
24+
![img](img/disco-toolbar.webp)
3225

3326
### Perfect for Docker Environments
3427

3528
Since configuration is YAML-based, it's incredibly easy to generate dynamically when setting up new
36-
development environments. When using Docker or similar containerization, port numbers often change
37-
between setups - but with DiscoDevBar, you can regenerate the configuration file on each environment
29+
environments. When using Docker or similar containerization, port numbers often change
30+
between setups - but with DiscoToolbar, you can regenerate the configuration file on each environment
3831
startup, ensuring all links always point to the correct ports and services.
3932

4033
## Features
4134

4235
- **Fully customizable via YAML** - Easy to configure and regenerate for different environments
4336
- **Flexible widget system** - Create buttons with Font Awesome icons, emoji, text labels, or any combination
44-
- **Display anything** - Add links to admin panels, database tools, email catchers, API docs, or any development resource
37+
- **Display anything** - Add links to admin panels, database tools, email catchers, API docs, or any resource
4538
- **Action buttons** - Direct access to frequently-used tools and services
4639
- **Environment-aware** - Only loads in development environment, zero production overhead
4740
- **Dynamic configuration** - Perfect for Docker setups where ports change - regenerate config on startup
@@ -50,22 +43,22 @@ startup, ensuring all links always point to the correct ports and services.
5043
## Requirements
5144

5245
- PHP 8.1 or higher
53-
- Symfony 6.4+ or 7.0+
46+
- Symfony 6.4+, 7.0+, or 8.0+
5447

5548
## Installation
5649

5750
Install via Composer:
5851

5952
```bash
60-
composer require marcinorlowski/symfony-discodevbar --dev
53+
composer require --dev marcin-orlowski/disco-toolbar-symfony
6154
```
6255

6356
Register the bundle in `config/bundles.php`:
6457

6558
```php
6659
return [
6760
// ... other bundles
68-
MarcinOrlowski\DiscoDevBar\DiscoDevBarBundle::class => ['dev' => true],
61+
MarcinOrlowski\DiscoToolbar\DiscoToolbarBundle::class => ['dev' => true],
6962
];
7063
```
7164

@@ -80,10 +73,10 @@ php bin/console assets:install --symlink
8073
Create a configuration file in your project root with widget configuration. The bundle will automatically
8174
detect and load the first file found (in order of preference):
8275

83-
- `.disco-devbar.yaml` (recommended)
84-
- `.disco-devbar.yml`
76+
- `.disco.yaml` (recommended)
77+
- `.disco.yml`
8578

86-
Example configuration that produces devbar shown in the screenshot above:
79+
Example configuration that produces toolbar shown in the screenshot above:
8780

8881
```yaml
8982
widgets:
@@ -121,26 +114,26 @@ widgets:
121114
122115
### Widget Properties
123116
124-
| Property | Type | Required | Description |
125-
|-------------|:--------:|:--------:|--------------------------------------------------------------------------------|
126-
| `type` | `string` | | Widget type: `link` (default) or `close` (dismisses devbar). |
127-
| `icon`* | `string` | | Optional icon to display. Can be Font Awesome class or emoji/text. |
128-
| `icon_type` | `string` | | Icon type: `fa` (Font Awesome, default) or `text` (emoji/plain text). |
129-
| `text`* | `string` | | Optional widget label to display alongside icon. |
130-
| `url` | `string` | * | Link URL to redirect to once widget is clicked. |
131-
| `target` | `string` | | Link target (e.g., `_blank`). Default: no target |
132-
| `title` | `string` | | Tooltip text. If not given, `url` is shown. |
133-
| `expand` | `bool` | | Set to `true` to make widget expand and fill available space. Default `false`. |
117+
| Property | Type | Required | Description |
118+
|-------------|:--------:|:--------:|---------------------------------------------------------------------------------|
119+
| `type` | `string` | | Widget type: `link` (default) or `close` (dismisses toolbar). |
120+
| `icon`* | `string` | | Optional icon to display. Can be Font Awesome class or emoji/text. |
121+
| `icon_type` | `string` | | Icon type: `fa` (Font Awesome, default) or `text` (emoji/plain text). |
122+
| `text`* | `string` | | Optional widget label to display alongside icon. |
123+
| `url` | `string` | * | Link URL to redirect to once widget is clicked. |
124+
| `target` | `string` | | Link target (e.g., `_blank`). Default: no target |
125+
| `title` | `string` | | Tooltip text. If not given, `url` is shown. |
126+
| `expand` | `bool` | | Set to `true` to make widget expand and fill available space. Default `false`. |
134127

135128
*) Either `icon` or `text` must be provided or exception will be thrown.
136129

137130
### Font Awesome Icons
138131

139-
DiscoDevBar supports Font Awesome icons for widgets. You have two options for including Font Awesome:
132+
DiscoToolbar supports Font Awesome icons for widgets. You have two options for including Font Awesome:
140133

141134
#### Option 1: Automatic Inclusion (Recommended for Quick Setup)
142135

143-
Enable automatic Font Awesome inclusion from CDN in your `.disco-devbar.yaml` configuration file:
136+
Enable automatic Font Awesome inclusion from CDN in your `.disco.yaml` configuration file:
144137

145138
```yaml
146139
font_awesome:
@@ -166,7 +159,7 @@ your project, use Option 2 instead to avoid version conflicts.
166159
#### Option 2: Manual Setup (Recommended if Font Awesome Already Installed)
167160

168161
If your application already includes Font Awesome (via NPM, CDN, or other means), simply use Font Awesome icon
169-
classes in your widget configuration. DiscoDevBar will use your existing Font Awesome installation.
162+
classes in your widget configuration. DiscoToolbar will use your existing Font Awesome installation.
170163

171164
**Example:**
172165

@@ -198,19 +191,19 @@ widgets:
198191

199192
## Usage
200193

201-
Include the devbar template in your base layout:
194+
Include the toolbar template in your base layout:
202195

203196
```twig
204197
{% if app.environment == 'dev' %}
205-
{% include '@DiscoDevBar/devbar.html.twig' %}
198+
{% include '@DiscoToolbar/toolbar.html.twig' %}
206199
{% endif %}
207200
```
208201

209202
## Customization
210203

211204
### Background Colors
212205

213-
Customize the breathing stripes background colors in your `.disco-devbar.yaml`:
206+
Customize the breathing stripes background colors in your `.disco.yaml`:
214207

215208
```yaml
216209
bg_color_light: '#b71c1c'
@@ -220,15 +213,15 @@ bg_color_dark: '#8e0000'
220213
### Custom CSS
221214

222215
The bundle includes default styling. To customize, override the CSS after importing bundle assets or
223-
create your own styles targeting `.disco-devbar` classes.
216+
create your own styles targeting `.disco-toolbar` classes.
224217

225218
### Custom Template
226219

227220
Override the default template by creating:
228-
`templates/bundles/DiscoDevBarBundle/devbar.html.twig`
221+
`templates/bundles/DiscoToolbarBundle/toolbar.html.twig`
229222

230223
## License
231224

232-
- Written and copyrighted &copy;2025 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
233-
- DiscoDevBar is open-source software licensed under
225+
- Written and copyrighted &copy;2025-2026 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
226+
- DiscoToolbar is open-source software licensed under
234227
the [MIT license](http://opensource.org/licenses/MIT)

Resources/config/services.yaml

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,32 @@
1+
2+
#########################################################################
3+
#
4+
# █▀▀▄ ▀ ▀▀█▀▀ ▀█ █
5+
# █ █ ▀█ ▄▀▀▄ ▄▀▀▄ ▄▀▀▄ █ ▄▀▀▄ ▄▀▀▄ █ █▀▀▄ ▄▀▀▄ █▄▀
6+
# █ █ █ ▀▄ █ █ █ █ █ █ █ █ █ █ █ ▄▄█ █
7+
# █▄▄▀ ▄█▄ ▀▄▄▀ ▀▄▄▀ ▀▄▄▀ █ ▀▄▄▀ ▀▄▄▀ ▄█▄ █▄▄▀ ▀▄▄▀ █
8+
#
9+
######### Customizable developer toolbar for Symfony projects ########
10+
#
11+
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
12+
# @copyright 2025-2026 Marcin Orlowski
13+
# @license https://opensource.org/license/mit MIT
14+
# @link https://github.com/MarcinOrlowski/php-discotoolbar-symfony
15+
#
16+
#########################################################################
17+
118
services:
219
_defaults:
320
autowire: true
421
autoconfigure: true
522

6-
MarcinOrlowski\DiscoDevBar\:
23+
MarcinOrlowski\DiscoToolbar\:
724
resource: '../../src/'
825
exclude: '../../src/{DependencyInjection,Dto}'
926

10-
MarcinOrlowski\DiscoDevBar\Service\DiscoDevBarService:
27+
MarcinOrlowski\DiscoToolbar\Service\DiscoToolbarService:
1128
arguments:
1229
$projectDir: '%kernel.project_dir%'
1330

14-
MarcinOrlowski\DiscoDevBar\Twig\DiscoDevBarExtension:
31+
MarcinOrlowski\DiscoToolbar\Twig\DiscoToolbarExtension:
1532
tags: ['twig.extension']

0 commit comments

Comments
 (0)