-
-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
148 additions
and
127 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,7 @@ | |
| } | ||
| ], | ||
| "require": { | ||
| "php": ">=8.0 <8.4", | ||
| "php": "8.1 - 8.3", | ||
| "ext-session": "*", | ||
| "ext-json": "*" | ||
| }, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,8 @@ | ||
| { | ||
| "devDependencies": { | ||
| "@eslint/js": "^9.1.1", | ||
| "eslint": "^9.1.1", | ||
| "globals": "^15.1.0" | ||
| "@eslint/js": "^9.4.0", | ||
| "@stylistic/eslint-plugin": "^2.1.0", | ||
| "eslint": "^9.4.0", | ||
| "globals": "^15.3.0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,21 @@ | ||
| [Tracy](https://tracy.nette.org) - PHP debugger | ||
| ============================================== | ||
| [](https://tracy.nette.org) | ||
|
|
||
| [](https://packagist.org/packages/tracy/tracy) | ||
| [](https://github.com/nette/tracy/actions) | ||
| [](https://ci.appveyor.com/project/dg/tracy/branch/master) | ||
| [](https://github.com/nette/tracy/releases) | ||
| [](https://github.com/nette/tracy/blob/master/license.md) | ||
|
|
||
| <!----> | ||
|
|
||
| Introduction | ||
| ------------ | ||
|
|
||
| Tracy library is a useful helper for everyday PHP programmers. It helps you to: | ||
|
|
||
| - quickly detect and correct errors | ||
| - log errors | ||
| - dump variables | ||
| - measure execution time of scripts/queries | ||
| - see memory consumption | ||
| ✅ designed to facilitate debugging PHP code<br> | ||
| ✅ hints and corrects you just like a good friend watching your back<br> | ||
| ✅ damn cool visualization of errors | ||
|
|
||
|
|
||
| PHP is a perfect language for making hardly detectable errors because it gives great flexibility to programmers. Tracy\Debugger is more valuable because of that. It is an ultimate tool among the diagnostic ones. | ||
|
|
@@ -26,6 +24,7 @@ If you are meeting Tracy for the first time, believe me, your life starts to be | |
|
|
||
| Documentation can be found on the [website](https://tracy.nette.org). | ||
|
|
||
| <!----> | ||
|
|
||
| [Support Tracy](https://github.com/sponsors/dg) | ||
| ----------------------------------------------- | ||
|
|
@@ -36,6 +35,7 @@ Do you like Tracy? Are you looking forward to the new features? | |
|
|
||
| Thank you! | ||
|
|
||
| <!----> | ||
|
|
||
| Installation and Requirements | ||
| ----------------------------- | ||
|
|
@@ -48,12 +48,10 @@ composer require tracy/tracy | |
|
|
||
| Alternatively, you can download the whole package or [tracy.phar](https://github.com/nette/tracy/releases) file. | ||
|
|
||
| | Tracy | compatible with PHP | compatible with browsers | ||
| |-----------|---------------|---------- | ||
| | Tracy 3.0 | PHP 8.0 – 8.3 | Chrome 112+, Firefox 117+, Safari 16.5+ | ||
| | Tracy 2.10| PHP 8.0 – 8.3 | Chrome 64+, Firefox 69+, Safari 15.4+ | ||
| | Tracy 2.9 | PHP 7.2 – 8.2 | Chrome 64+, Firefox 69+, Safari 13.1+ | ||
|
|
||
| Tracy is compatible with PHP 8.1 to 8.3. | ||
|
|
||
| <!----> | ||
|
|
||
| Usage | ||
| ----- | ||
|
|
@@ -71,6 +69,7 @@ Debugger::enable(); | |
| The first thing you'll notice on the page is the Tracy Bar in the bottom right corner. If you don't see it, it may mean that Tracy is running in production mode. | ||
| This is because Tracy is only visible on localhost for security reasons. To test if it works, you can temporarily put it into development mode using the `Debugger::enable(Debugger::Development)` parameter. | ||
|
|
||
| <!----> | ||
|
|
||
| Tracy Bar | ||
| --------- | ||
|
|
@@ -87,6 +86,7 @@ If you do not want to show Tracy Bar, set: | |
| Debugger::$showBar = false; | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| Visualization of Errors and Exceptions | ||
| -------------------------------------- | ||
|
|
@@ -135,6 +135,7 @@ Debugger::$strictMode = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED; // all error | |
|
|
||
| Note: Tracy when activated changes the error reporting level to E_ALL. If you want to change this, do so after calling `enable()`. | ||
|
|
||
| <!----> | ||
|
|
||
| Development vs Production Mode | ||
| ------------------------------ | ||
|
|
@@ -163,6 +164,7 @@ You can also directly set the development/production mode using the `Debugger::D | |
|
|
||
| (If you use the Nette Framework, take a look at how to set the mode for it, and it will then also be used for Tracy.) | ||
|
|
||
| <!----> | ||
|
|
||
| Error Logging | ||
| ------------- | ||
|
|
@@ -205,12 +207,14 @@ Debugger::$email = '[email protected]'; | |
|
|
||
| To protect your e-mail box from flood, Tracy sends **only one message** and creates a file `email-sent`. When a developer receives the e-mail notification, he checks the log, corrects his application and deletes the `email-sent` monitoring file. This activates the e-mail sending again. | ||
|
|
||
| <!----> | ||
|
|
||
| Opening Files in the Editor | ||
| --------------------------- | ||
|
|
||
| When the error page is displayed, you can click on file names and they will open in your editor with the cursor on the corresponding line. Files can also be created (action `create file`) or bug fixed in them (action `fix it`). In order to do this, you need to [configure the browser and the system](https://tracy.nette.org/cs/open-files-in-ide). | ||
|
|
||
| <!----> | ||
|
|
||
| Variable Dumping | ||
| ---------------- | ||
|
|
@@ -262,6 +266,7 @@ bdump([1, 3, 5, 7, 9], 'odd numbers up to ten'); | |
|
|
||
|  | ||
|
|
||
| <!----> | ||
|
|
||
| Stopwatch | ||
| --------- | ||
|
|
@@ -299,6 +304,7 @@ Debugger::timer(); // runs the timer | |
| echo Debugger::timer(); // elapsed time in seconds | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| Custom Logger | ||
| ------------- | ||
|
|
@@ -330,6 +336,7 @@ services: | |
| tracy.logger: SlackLogger | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| Monolog Integration | ||
| ------------------- | ||
|
|
@@ -348,6 +355,7 @@ Debugger::log('info'); // writes: [<TIMESTAMP>] main-channel.INFO: info [] [] | |
| Debugger::log('warning', Debugger::WARNING); // writes: [<TIMESTAMP>] main-channel.WARNING: warning [] [] | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| Faster Loading | ||
| -------------- | ||
|
|
@@ -366,6 +374,7 @@ The solution is to place `<?php Tracy\Debugger::renderLoader() ?>` into your tem | |
| </head> | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| AJAX and Redirected Requests | ||
| ---------------------------- | ||
|
|
@@ -395,6 +404,7 @@ Debugger::dispatch(); | |
|
|
||
| The `setSessionStorage()` function has existed since version 2.9, before that Tracy always used the native PHP session. | ||
|
|
||
| <!----> | ||
|
|
||
| Content Security Policy | ||
| ----------------------- | ||
|
|
@@ -433,6 +443,7 @@ change it to | |
| try_files $uri $uri/ /index.php$is_args$args; | ||
| ``` | ||
|
|
||
| <!----> | ||
|
|
||
| Integrations | ||
| ------------ | ||
|
|
||
Oops, something went wrong.