-
Notifications
You must be signed in to change notification settings - Fork 0
Improve JS/TS comment filtering #81
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
Merged
+1,529
−578
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ed9cbbc
Improve JS/TS comments filter.
Vladyslav-Kuksiuk 3d292f1
Improve interpolation comments filtering.
Vladyslav-Kuksiuk 0a55d83
Improve readability.
Vladyslav-Kuksiuk 1edecc8
Improve tests.
Vladyslav-Kuksiuk 627bee9
Improve readability.
Vladyslav-Kuksiuk b85a657
Add trial block comment skipping.
Vladyslav-Kuksiuk b7a67b1
Improve nested template comments filtering.
Vladyslav-Kuksiuk ca44a67
Divide test files.
Vladyslav-Kuksiuk 22844c9
Merge remote-tracking branch 'refs/remotes/origin/master' into improv…
Vladyslav-Kuksiuk 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 hidden or 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,83 @@ | ||
| // Copyright 2026, TeamDev. All rights reserved. | ||
| // | ||
| // Redistribution and use in source and/or binary forms, with or without | ||
| // modification, must retain the above copyright notice and the following | ||
| // disclaimer. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| package commentfilter_test | ||
|
|
||
| import ( | ||
| . "embed-code/embed-code-go/embedding/commentfilter" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| ) | ||
|
|
||
| var _ = Describe("C and C++", func() { | ||
| It("should strip all comments without treating literals as comments", func() { | ||
| lines := []string{ | ||
| "// header comment", | ||
| "#include <stdio.h>", | ||
| "", | ||
| "/* block comment */", | ||
| "const char slash = '/';", | ||
| "const char* url = \"http://example.org\";", | ||
| "int create() { return 1; } // inline comment", | ||
| } | ||
|
|
||
| expected := []string{ | ||
| "#include <stdio.h>", | ||
| "", | ||
| "const char slash = '/';", | ||
| "const char* url = \"http://example.org\";", | ||
| "int create() { return 1; } ", | ||
| } | ||
|
|
||
| assertFiltered("sample.cpp", RetainNone, lines, expected) | ||
| }) | ||
|
|
||
| It("should keep inline comments", func() { | ||
| lines := []string{ | ||
| "// header comment", | ||
| "int create();", | ||
| "/* block comment */", | ||
| "int count(); // inline comment", | ||
| } | ||
|
|
||
| expected := []string{ | ||
| "// header comment", | ||
| "int create();", | ||
| "int count(); // inline comment", | ||
| } | ||
|
|
||
| assertFiltered("sample.cpp", RetainInline, lines, expected) | ||
| }) | ||
|
|
||
| It("should keep block comments", func() { | ||
| lines := []string{ | ||
| "// header comment", | ||
| "int create();", | ||
| "/* block comment */", | ||
| "int count(); // inline comment", | ||
| } | ||
|
|
||
| expected := []string{ | ||
| "int create();", | ||
| "/* block comment */", | ||
| "int count(); ", | ||
| } | ||
|
|
||
| assertFiltered("sample.hpp", RetainBlock, lines, expected) | ||
| }) | ||
| }) |
This file contains hidden or 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 hidden or 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,57 @@ | ||
| // Copyright 2026, TeamDev. All rights reserved. | ||
| // | ||
| // Redistribution and use in source and/or binary forms, with or without | ||
| // modification, must retain the above copyright notice and the following | ||
| // disclaimer. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
|
|
||
| package commentfilter_test | ||
|
|
||
| import ( | ||
| . "embed-code/embed-code-go/embedding/commentfilter" | ||
|
|
||
| . "github.com/onsi/ginkgo/v2" | ||
| ) | ||
|
|
||
| var _ = Describe("C#", func() { | ||
| It("should keep XML documentation comments", func() { | ||
| lines := []string{ | ||
| "/// <summary>Creates a value.</summary>", | ||
| "// implementation note", | ||
| "public string Create() => \"// literal\";", | ||
| } | ||
|
|
||
| expected := []string{ | ||
| "/// <summary>Creates a value.</summary>", | ||
| "public string Create() => \"// literal\";", | ||
| } | ||
|
|
||
| assertFiltered("Api.cs", RetainDocumentation, lines, expected) | ||
| }) | ||
|
|
||
| It("should keep inline comments", func() { | ||
| lines := []string{ | ||
| "/// <summary>Creates a value.</summary>", | ||
| "// implementation note", | ||
| "public string Create() => \"// literal\";", | ||
| } | ||
|
|
||
| expected := []string{ | ||
| "// implementation note", | ||
| "public string Create() => \"// literal\";", | ||
| } | ||
|
|
||
| assertFiltered("Api.cs", RetainInline, lines, expected) | ||
| }) | ||
| }) |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.