Merge branch 'cleanup'

Author: lkrms

scripts/generate.php

@@ -57,7 +57,7 @@
 $facades = [
     Application::class => App::class,
     CacheStore::class => Cache::class,
-    ConsoleWriter::class => Console::class,
+    ConsoleWriter::class => [Console::class, '--api'],
     Container::class => DI::class,
     ErrorHandler::class => [Err::class, '--skip', 'handleShutdown,handleError,handleException'],
     EventDispatcher::class => Event::class,

src/Console/Catalog/ConsoleTag.php

@@ -5,7 +5,7 @@
 use Lkrms\Concept\Enumeration;
 
 /**
- * Inline console output formatting tags
+ * Console output formatting tags
  *
  * @extends Enumeration<int>
  */
@@ -60,8 +60,6 @@ final class ConsoleTag extends Enumeration
     /**
      * Fenced code block
      *
-     * Syntax:
-     *
      * ` ``` `<br>
      * text<br>
      * ` ``` `

src/Console/ConsoleFormatter.php

@@ -6,6 +6,7 @@
 use Lkrms\Console\Catalog\ConsoleMessageType as MessageType;
 use Lkrms\Console\Catalog\ConsoleTag as Tag;
 use Lkrms\Console\Contract\ConsoleFormatInterface as Format;
+use Lkrms\Console\Contract\ConsoleTargetInterface as Target;
 use Lkrms\Console\Support\ConsoleMessageAttributes as MessageAttributes;
 use Lkrms\Console\Support\ConsoleMessageFormat as MessageFormat;
 use Lkrms\Console\Support\ConsoleMessageFormats as MessageFormats;
@@ -21,7 +22,7 @@
 /**
  * Formats messages for a console output target
  *
- * @see ConsoleTarget::getFormatter()
+ * @see Target::getFormatter()
  */
 final class ConsoleFormatter
 {
@@ -514,20 +515,17 @@ public static function removeTags(string $string): string
 
     private static function getDefaultFormatter(): self
     {
-        return self::$DefaultFormatter
-            ?? (self::$DefaultFormatter = new self());
+        return self::$DefaultFormatter ??= new self();
     }
 
     private static function getDefaultTagFormats(): TagFormats
     {
-        return self::$DefaultTagFormats
-            ?? (self::$DefaultTagFormats = new TagFormats());
+        return self::$DefaultTagFormats ??= new TagFormats();
     }
 
     private static function getDefaultMessageFormats(): MessageFormats
     {
-        return self::$DefaultMessageFormats
-            ?? (self::$DefaultMessageFormats = new MessageFormats());
+        return self::$DefaultMessageFormats ??= new MessageFormats();
     }
 
     /**

src/Console/Contract/ConsoleFormatInterface.php

@@ -5,15 +5,12 @@
 use Lkrms\Console\Support\ConsoleMessageAttributes as MessageAttributes;
 use Lkrms\Console\Support\ConsoleTagAttributes as TagAttributes;
 
-/**
- * Applies target-defined formatting to console output
- */
 interface ConsoleFormatInterface
 {
     /**
      * Format text before it is written to the target
      *
-     * @param MessageAttributes|TagAttributes $attributes
+     * @param MessageAttributes|TagAttributes|null $attributes
      */
     public function apply(?string $text, $attributes = null): string;
 }

src/Console/Contract/ConsoleTargetInterface.php

@@ -7,6 +7,8 @@
 
 /**
  * A console output target
+ *
+ * @api
  */
 interface ConsoleTargetInterface
 {

src/Console/Contract/ConsoleTargetPrefixInterface.php

@@ -5,6 +5,8 @@
 /**
  * A console output target that applies an optional prefix to each line of
  * output
+ *
+ * @api
  */
 interface ConsoleTargetPrefixInterface extends ConsoleTargetInterface
 {

src/Console/Contract/ConsoleTargetStreamInterface.php

@@ -4,6 +4,8 @@
 
 /**
  * A console output target with an underlying PHP stream
+ *
+ * @api
  */
 interface ConsoleTargetStreamInterface extends ConsoleTargetInterface
 {

src/Console/Support/ConsoleFormat.php

@@ -8,8 +8,7 @@
 use Lkrms\Support\Catalog\TtyControlSequence as Colour;
 
 /**
- * Applies formatting to console output by adding inline character sequences
- * defined by the target
+ * Applies inline character sequences to console output
  */
 final class ConsoleFormat implements ConsoleFormatInterface
 {

src/Console/Support/ConsoleMessageFormat.php

@@ -6,7 +6,7 @@
 use Lkrms\Console\Support\ConsoleMessageAttributes as MessageAttributes;
 
 /**
- * Applies target-defined formats to the components of a console message
+ * Applies formats to the components of a console message
  */
 final class ConsoleMessageFormat
 {

src/Console/Support/ConsoleMessageFormats.php

@@ -7,7 +7,7 @@
 use Lkrms\Console\Support\ConsoleMessageFormat as MessageFormat;
 
 /**
- * Maps message levels and types to target-defined formats
+ * Maps message levels and types to formats
  *
  * If multiple formats are assigned to the same {@see Level} and
  * {@see MessageType}, the format assigned last takes precedence.