-
-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #135 from kburton-dev/add-dockerfile-support
Add Dockerfile highlighting support
- Loading branch information
Showing
8 changed files
with
250 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile; | ||
|
||
use Tempest\Highlight\Languages\Base\BaseLanguage; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\ImageAliasKeywordPattern; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\ImageAliasNamePattern; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\ImageNamePattern; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\ImageTagPattern; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\KeywordPattern; | ||
|
||
class DockerfileLanguage extends BaseLanguage | ||
{ | ||
public function getName(): string | ||
{ | ||
return 'dockerfile'; | ||
} | ||
|
||
public function getAliases(): array | ||
{ | ||
return [ | ||
'docker', | ||
]; | ||
} | ||
|
||
public function getPatterns(): array | ||
{ | ||
return [ | ||
new KeywordPattern('ADD'), | ||
new KeywordPattern('ARG'), | ||
new KeywordPattern('CMD'), | ||
new KeywordPattern('COPY'), | ||
new KeywordPattern('ENTRYPOINT'), | ||
new KeywordPattern('ENV'), | ||
new KeywordPattern('EXPOSE'), | ||
new KeywordPattern('FROM'), | ||
new KeywordPattern('HEALTHCHECK'), | ||
new KeywordPattern('LABEL'), | ||
new KeywordPattern('MAINTAINER'), | ||
new KeywordPattern('ONBUILD'), | ||
new KeywordPattern('RUN'), | ||
new KeywordPattern('SHELL'), | ||
new KeywordPattern('STOPSIGNAL'), | ||
new KeywordPattern('USER'), | ||
new KeywordPattern('VOLUME'), | ||
new KeywordPattern('WORKDIR'), | ||
|
||
new ImageNamePattern(), | ||
new ImageAliasKeywordPattern(), | ||
new ImageAliasNamePattern(), | ||
new ImageTagPattern(), | ||
]; | ||
} | ||
} |
29 changes: 29 additions & 0 deletions
29
src/Languages/Dockerfile/Patterns/ImageAliasKeywordPattern.php
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile\Patterns; | ||
|
||
use Tempest\Highlight\IsPattern; | ||
use Tempest\Highlight\Pattern; | ||
use Tempest\Highlight\PatternTest; | ||
use Tempest\Highlight\Tokens\TokenTypeEnum; | ||
|
||
#[PatternTest(input: 'FROM php', output: null)] | ||
#[PatternTest(input: 'FROM php:8.1', output: null)] | ||
#[PatternTest(input: 'FROM php:8.1 AS stage-one', output: 'AS')] | ||
#[PatternTest(input: ' FROM php:8.1 AS stage-one ', output: 'AS')] | ||
final readonly class ImageAliasKeywordPattern implements Pattern | ||
{ | ||
use IsPattern; | ||
|
||
public function getPattern(): string | ||
{ | ||
return "/^[\s]*FROM[\s][\S]+[\s](?<match>AS)[\s][\S]+/m"; | ||
} | ||
|
||
public function getTokenType(): TokenTypeEnum | ||
{ | ||
return TokenTypeEnum::KEYWORD; | ||
} | ||
} |
29 changes: 29 additions & 0 deletions
29
src/Languages/Dockerfile/Patterns/ImageAliasNamePattern.php
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile\Patterns; | ||
|
||
use Tempest\Highlight\IsPattern; | ||
use Tempest\Highlight\Pattern; | ||
use Tempest\Highlight\PatternTest; | ||
use Tempest\Highlight\Tokens\TokenTypeEnum; | ||
|
||
#[PatternTest(input: 'FROM php', output: null)] | ||
#[PatternTest(input: 'FROM php:8.1', output: null)] | ||
#[PatternTest(input: 'FROM php:8.1 AS stage-one', output: 'stage-one')] | ||
#[PatternTest(input: ' FROM php:8.1 AS stage-one ', output: 'stage-one')] | ||
final readonly class ImageAliasNamePattern implements Pattern | ||
{ | ||
use IsPattern; | ||
|
||
public function getPattern(): string | ||
{ | ||
return "/^[\s]*FROM[\s][\S]+[\s]AS[\s](?<match>[\S]+)/m"; | ||
} | ||
|
||
public function getTokenType(): TokenTypeEnum | ||
{ | ||
return TokenTypeEnum::VALUE; | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile\Patterns; | ||
|
||
use Tempest\Highlight\IsPattern; | ||
use Tempest\Highlight\Pattern; | ||
use Tempest\Highlight\PatternTest; | ||
use Tempest\Highlight\Tokens\TokenTypeEnum; | ||
|
||
#[PatternTest(input: 'FROM php', output: 'php')] | ||
#[PatternTest(input: ' FROM php', output: 'php')] | ||
#[PatternTest(input: 'FROM php:8.1', output: 'php')] | ||
#[PatternTest(input: 'FROM php/cli:8.1', output: 'php/cli')] | ||
#[PatternTest(input: 'FROM php:8.1 AS stage-one', output: 'php')] | ||
|
||
final readonly class ImageNamePattern implements Pattern | ||
{ | ||
use IsPattern; | ||
|
||
public function getPattern(): string | ||
{ | ||
return "/^[\s]*FROM[\s](?<match>[\w\/]+)/m"; | ||
} | ||
|
||
public function getTokenType(): TokenTypeEnum | ||
{ | ||
return TokenTypeEnum::VALUE; | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile\Patterns; | ||
|
||
use Tempest\Highlight\IsPattern; | ||
use Tempest\Highlight\Pattern; | ||
use Tempest\Highlight\PatternTest; | ||
use Tempest\Highlight\Tokens\TokenTypeEnum; | ||
|
||
#[PatternTest(input: 'FROM php', output: null)] | ||
#[PatternTest(input: 'FROM php', output: null)] | ||
#[PatternTest(input: 'FROM php:8.1', output: '8.1')] | ||
#[PatternTest(input: 'FROM php/cli:8.1', output: '8.1')] | ||
#[PatternTest(input: 'FROM php:8.1 AS stage-one', output: '8.1')] | ||
|
||
final readonly class ImageTagPattern implements Pattern | ||
{ | ||
use IsPattern; | ||
|
||
public function getPattern(): string | ||
{ | ||
return "/^[\s]*FROM[\s][\w\/]+:(?<match>\S+)[\s]?/m"; | ||
} | ||
|
||
public function getTokenType(): TokenTypeEnum | ||
{ | ||
return TokenTypeEnum::VALUE; | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Languages\Dockerfile\Patterns; | ||
|
||
use Tempest\Highlight\IsPattern; | ||
use Tempest\Highlight\Pattern; | ||
use Tempest\Highlight\Tokens\TokenTypeEnum; | ||
|
||
final readonly class KeywordPattern implements Pattern | ||
{ | ||
use IsPattern; | ||
|
||
public function __construct(private string $keyword) | ||
{ | ||
} | ||
|
||
public function getPattern(): string | ||
{ | ||
return "/^[\s]*(?<match>{$this->keyword})[\s].*/m"; | ||
} | ||
|
||
public function getTokenType(): TokenTypeEnum | ||
{ | ||
return TokenTypeEnum::KEYWORD; | ||
} | ||
} |
44 changes: 44 additions & 0 deletions
44
tests/Languages/Dockerfile/Patterns/KeywordPatternTest.php
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 |
---|---|---|
@@ -0,0 +1,44 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace Tempest\Highlight\Tests\Languages\Dockerfile\Patterns; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Tempest\Highlight\Languages\Dockerfile\Patterns\KeywordPattern; | ||
use Tempest\Highlight\Tests\TestsPatterns; | ||
|
||
class KeywordPatternTest extends TestCase | ||
{ | ||
use TestsPatterns; | ||
|
||
public function test_pattern() | ||
{ | ||
$this->assertMatches( | ||
pattern: new KeywordPattern('FROM'), | ||
content: 'FROM image:tag', | ||
expected: 'FROM', | ||
); | ||
|
||
$this->assertMatches( | ||
pattern: new KeywordPattern('FROM'), | ||
content: 'FROM image:tag AS alias', | ||
expected: 'FROM', | ||
); | ||
|
||
$this->assertMatches( | ||
pattern: new KeywordPattern('FROM'), | ||
content: ' FROM image:tag AS alias', | ||
expected: 'FROM', | ||
); | ||
|
||
$this->assertMatches( | ||
pattern: new KeywordPattern('COPY'), | ||
content: <<<'DOCKERFILE' | ||
FROM image:tag | ||
COPY . /usr/share/nginx/html | ||
DOCKERFILE, | ||
expected: 'COPY', | ||
); | ||
} | ||
} |