Add DotEnv

Author: brendt

src/Highlighter.php

@@ -12,6 +12,7 @@
 use Tempest\Highlight\Languages\Diff\DiffLanguage;
 use Tempest\Highlight\Languages\DocComment\DocCommentLanguage;
 use Tempest\Highlight\Languages\Dockerfile\DockerfileLanguage;
+use Tempest\Highlight\Languages\DotEnv\DotEnvLanguage;
 use Tempest\Highlight\Languages\Ellison\EllisonLanguage;
 use Tempest\Highlight\Languages\Gdscript\GdscriptLanguage;
 use Tempest\Highlight\Languages\Html\HtmlLanguage;
@@ -55,6 +56,7 @@ public function __construct(
             ->addLanguage(new SqlLanguage())
             ->addLanguage(new XmlLanguage())
             ->addLanguage(new YamlLanguage())
+            ->addLanguage(new DotEnvLanguage())
             ->addLanguage(new TwigLanguage());
     }
 

src/Languages/DotEnv/DotEnvLanguage.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Tempest\Highlight\Languages\DotEnv;
+
+use Tempest\Highlight\Languages\Base\BaseLanguage;
+use Tempest\Highlight\Languages\DotEnv\Patterns\DotEnvCommentPattern;
+use Tempest\Highlight\Languages\DotEnv\Patterns\DotEnvKeyPattern;
+
+final class DotEnvLanguage extends BaseLanguage
+{
+    public function getName(): string
+    {
+        return 'dotenv';
+    }
+
+    public function getAliases(): array
+    {
+        return ['env'];
+    }
+
+    public function getPatterns(): array
+    {
+        return [
+            ...parent::getPatterns(),
+            new DotEnvKeyPattern(),
+            new DotEnvCommentPattern(),
+        ];
+    }
+}

src/Languages/DotEnv/Patterns/DotEnvCommentPattern.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Tempest\Highlight\Languages\DotEnv\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+use Tempest\Highlight\Tokens\TokenTypeEnum;
+
+#[PatternTest(input: '# FOO=bar', output: '# FOO=bar')]
+final class DotEnvCommentPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '/(?<match>\#.*)/';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenTypeEnum::COMMENT;
+    }
+}

src/Languages/DotEnv/Patterns/DotEnvKeyPattern.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Tempest\Highlight\Languages\DotEnv\Patterns;
+
+use Tempest\Highlight\IsPattern;
+use Tempest\Highlight\Pattern;
+use Tempest\Highlight\PatternTest;
+use Tempest\Highlight\Tokens\TokenType;
+use Tempest\Highlight\Tokens\TokenTypeEnum;
+
+#[PatternTest(input: 'FOO=bar', output: 'FOO')]
+final class DotEnvKeyPattern implements Pattern
+{
+    use IsPattern;
+
+    public function getPattern(): string
+    {
+        return '/(?<match>[\w].*)=/';
+    }
+
+    public function getTokenType(): TokenType
+    {
+        return TokenTypeEnum::KEYWORD;
+    }
+}

tests/Languages/DotEnv/DotEnvLanguageTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Languages\DotEnv;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Tempest\Highlight\Highlighter;
+
+final class DotEnvLanguageTest extends TestCase
+{
+
+    #[DataProvider('data')]
+    public function test_highlight(string $content, string $expected): void
+    {
+        $highlighter = new Highlighter();
+
+        $this->assertSame(
+            $expected,
+            $highlighter->parse($content, 'dotenv'),
+        );
+
+        $this->assertSame(
+            $expected,
+            $highlighter->parse($content, 'env'),
+        );
+    }
+
+    public static function data(): array
+    {
+        return [
+            [
+                <<<ENV
+                # Enable or disable discovery cache. Can be `true`, `partial` or `false`.
+                DISCOVERY_CACHE=false
+                
+                # Overwrite default log paths (null = default)
+                DEBUG_LOG_PATH=null
+                SERVER_LOG_PATH=null
+                ENV,
+                '<span class="hl-comment"># Enable or disable discovery cache. Can be `true`, `partial` or `false`.</span>
+<span class="hl-keyword">DISCOVERY_CACHE</span>=false
+
+<span class="hl-comment"># Overwrite default log paths (null = default)</span>
+<span class="hl-keyword">DEBUG_LOG_PATH</span>=null
+<span class="hl-keyword">SERVER_LOG_PATH</span>=null',
+            ]
+        ];
+    }
+}

tests/targets/test.md

@@ -1,5 +1,8 @@
-```php
-public function __construct(
-    private(set) Author $author,
-) {}
+```dotenv
+# Enable or disable discovery cache. Can be `true`, `partial` or `false`.
+DISCOVERY_CACHE=false
+
+# Overwrite default log paths (null = default)
+DEBUG_LOG_PATH=null
+SERVER_LOG_PATH=null
 ```