Avoid linting typst colors #854
Closed
Conversation
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
Typst LSPs such as `tinymist` can be set up to automatically generate a PDF of a `.typ` file on save, which can lead to random PDFs being generated when editing/adding test files to `harper-typst`.
Contributors who work on Windows might accidentally commit newly created files with CRLF line endings, later causing noisy diffs when Linux developers work on the same files and they do not have `core.autocrlf = true`. However nowadays, most text editors work with LF line endings just fine on windows, so there's no need for this incompatibility. Add an `.editorconfig` file which causes the text editor to create new files using LF from the get-go instead of CRLF (VSCode needs https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig in order to conform). Add a `.gitattributes` file to tell git to always checkout files using LF as line ending. Normalize line endings throughout the codebase using `git add --renormalize .`. https://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/ https://docs.github.com/en/get-started/git-basics/configuring-git-to-handle-line-endings
|
Hey @grantlemons, would you mind taking a look at this? I'm not as well-versed in the Typst spec. |
grantlemons
added a commit
to grantlemons/harper
that referenced
this pull request
Mar 8, 2025
grantlemons
added a commit
to grantlemons/harper
that referenced
this pull request
Mar 8, 2025
grantlemons
added a commit
to grantlemons/harper
that referenced
this pull request
Mar 8, 2025
|
Well I guess I'm going to close this PR in favor of that one. Would have appreciated a review, though, so I can make better contributions in the future, here. @elijah-potter feel free to cherry-pick the first 2 commits if they are useful to you. |
|
@alex-tdrn Ahh so sorry that I just kinda took this over, for some reason I thought this was an issue not a PR! |
No worries then! I like your solution more anyway, seems easier to extend with more special cases in the future 👍 |
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.
Issues
#849
Description
Avoid linting typst calls to
color.rgb("...")/rgb("...")since they represent hex codes. Accomplish this by ignoring any call to thergbglobal function and any member access to thecolorglobal module. A typst user could theoretically shadow thecolormodule and/or thergbglobal function with their own implementation and add string parameters that represent text that should be checked for grammar/typos, but surely no reasonable user would do that.If this is seen as a good strategy, I think it could be used to tackle #846 as well as other such "do not check the string parameter of this specific function since it is not prose" cases.
I have also added 2 extra unrelated commits to make life a bit easier for contributors who:
How Has This Been Tested?
I have added a test file and I have built and tested harper with this change on personal typst projects that use the
rgbfunction.Checklist