-
-
Notifications
You must be signed in to change notification settings - Fork 38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Dockerfile highlighting support #135
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
18cdf88
Add Dockerfile highlighting support
kburton-dev 4ff1533
Use multi-line modifier when matching based on start of line
kburton-dev 6bfc9f8
Add image tag highlighting support
kburton-dev e9409db
Run CS Fixer
kburton-dev cd9156b
Add alias for dockerfile
kburton-dev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,49 @@ | ||
<?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 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', | ||
); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be
dockerfile
? Maybe adddocker
as an alias as well?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had the same thought as you regarding the alias. And ChatGPT would also describe it this way, so I think
dockerfile
anddocker
will be enough.