Use a fallback syntect syntax rather than a custom Rust parser in the license checker. #3434
Conversation
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
… license checker. The license checker uses the `syntect` crate to parse files wherever possible. `syntect` provides a number of syntax definitions for common language types. However, we have some files that `syntect` does not recognize. Currently, the license checker falls back to a hand-coded parser if it encounters a file type that `syntect` does not recognize. This PR removes that hand-coded parser, and replaces it with a fallback `syntect` syntax. This removes the duplicate parsing logic, replacing it with an easier-to-extend Sublime syntax definition file. This will make it easier to resolve tock#3417, as one of the file types that `syntect` does not recognize does not support line comments (linker scripts), and parsing block comments is harder than parsing line comments.
bradjc
approved these changes
May 10, 2023
hudson-ayers
approved these changes
May 12, 2023
|
bors r+ |
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page.
|
jrvanwhy
pushed a commit
to jrvanwhy/tock
that referenced
this pull request
May 24, 2023
PR tock#3434 had the side effect of adding support for files with CRLF line endings. Regardless, the consensus in tock#3417 was to switch the jlink files to Unix line endings, so this PR does that. It also adds license headers to the jlink files. I did have to tweak the fallback syntax a bit, to allow a line that only contains a `#` to be counted as a comment.
jrvanwhy
pushed a commit
to jrvanwhy/tock
that referenced
this pull request
Jun 6, 2023
PR tock#3434 had the side effect of adding support for files with CRLF line endings. Regardless, the consensus in tock#3417 was to switch the jlink files to Unix line endings, so this PR does that. It also adds license headers to the jlink files. I did have to tweak the fallback syntax a bit, to allow a line that only contains a `#` to be counted as a comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The license checker uses the
syntectcrate to parse files wherever possible.syntectprovides a number of syntax definitions for common language types. However, we have some files thatsyntectdoes not recognize. Currently, the license checker falls back to a hand-coded parser if it encounters a file type thatsyntectdoes not recognize. This PR removes that hand-coded parser, and replaces it with a fallbacksyntectsyntax. This removes the duplicate parsing logic, replacing it with an easier-to-extend Sublime syntax definition file.This will make it easier to resolve #3417, as one of the file types that
syntectdoes not recognize does not support line comments (linker scripts), and parsing block comments is harder than parsing line comments.