Initial commit

.gitignore

@@ -0,0 +1 @@
+/vendor/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Gaëtan Faugère
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,80 @@
+# Colored LineFormatter for Monolog
+A simple Formatter that adds level-dependant colors to your logs.
+
+## Basic usage
+Use it the same way you would use a `Monolog\LineFormatter`:
+
+```php
+<?php
+
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+use gfaugere\Monolog\Formatter\ColoredLineFormatter;
+
+$formatter = new ColoredLineFormatter();
+
+// Create a handler
+$stream = new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG);
+// Don't forget to attach your new formatter
+$stream->setFormatter($formatter);
+// Create a log channel
+$log = new Logger('name');
+$log->pushHandler($stream);
+
+// Add records as usual
+$log->warning('Foo');
+$log->error('Bar');
+```
+
+## Default colors
+This is what your logs will look like:  \
+![Logs of ascending levels with different colors wrapping the level, spelling "Hello! This is a small and colorful formatter"](images/default.png)
+
+## Customize the format
+By default, the `%level_name%` will be wrapped in colors. You can chose what is colored using the new `%color_start%` and `%color_end%` variables in your format:  \
+![Logs of ascending levels with different colors wrapping the date, channel name, and log level ; spelling "You can chose where to put the colors."](images/custom_format.png)  \
+This example uses `"%color_start%[%datetime%] %channel%.%level_name%:%color_end% %message% %context% %extra%\n"` as a format.
+
+_If you want to use several `%level_name%` and only color the first one, you can set `$colorMode` to `ColoredLineFormatter::MODE_COLOR_LEVEL_FIRST` so that only the first occurrence is formatted._
+
+## Customize the scheme
+You can chose your own color scheme:
+```php
+<?php
+
+use Monolog\Logger;
+use Monolog\Handler\StreamHandler;
+use gfaugere\Monolog\Formatter\ColoredLineFormatter;
+
+$format = "[%datetime%] %color_start%%channel%.%level_name%: %message%%color_end% %context% %extra%\n";
+$scheme = [
+    Logger::DEBUG     => "\033[38;5;206m",
+    Logger::INFO      => "\033[38;5;196m",
+    Logger::NOTICE    => "\033[38;5;202m",
+    Logger::WARNING   => "\033[38;5;226m",
+    Logger::ERROR     => "\033[38;5;34m",
+    Logger::CRITICAL  => "\033[38;5;81m",
+    Logger::ALERT     => "\033[38;5;53m",
+    Logger::EMERGENCY => "\033[38;5;129m"
+];
+
+$formatter = new ColoredLineFormatter($format, null, false, false, $scheme);
+
+// Create a handler
+$stream = new StreamHandler(__DIR__.'/my_app.log', Logger::DEBUG);
+// Don't forget to attach your new formatter
+$stream->setFormatter($formatter);
+// Create a log channel
+$log = new Logger('name');
+$log->pushHandler($stream);
+
+// Add records as usual
+$log->warning('Foo');
+$log->error('Bar');
+```
+This formatter doesn't perform any kind of checks or validation of sequences. You can use whatever your terminal supports!  \
+![Logs of ascending levels with different colors wrapping the channel name, level and message ; spelling "Supports whatever your terminal supports with ANSI code"](images/custom_scheme.png)
+
+## About
+### Requirements
+Supports Monolog `^2.0`, which works with PHP 7.2 or above

composer.json

@@ -0,0 +1,25 @@
+{
+    "name": "gfaugere/monolog-colored-line",
+    "description": "A simple Formatter that adds level-dependant colors to your logs.",
+    "keywords": ["log", "monolog", "color", "colour"],
+    "require": {
+        "monolog/monolog": "^2.0"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Faugère Gaëtan",
+            "email": "gaetan@fauge.re"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "gfaugere\\Monolog\\" : "src/"
+        }
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^0.12.42",
+        "phpunit/phpunit": "^9.3",
+        "phpunit/php-code-coverage": "^9.1"
+    }
+}