Add linter to check for unrendered references, e.g. @dataset:uthus...

sign-language-processing / sign-language-processing.github.io

Documentation and background of sign language processing

99 stars 9 forks source link

Add linter to check for unrendered references, e.g. @dataset:uthus... #64

Open cleong110 opened 3 weeks ago

cleong110 commented 3 weeks ago

if you want, you can write a linter for this that would run on push, either as:

check the source code: prevent any ,@ or , @ - which might have some edge cases

after building the HTML, check if it contains any of the bib keys in the HTML file.

Originally posted by @AmitMY in https://github.com/sign-language-processing/sign-language-processing.github.io/issues/62#issuecomment-2155376909

cleong110 commented 3 weeks ago

Relevant:

Here's an existing linter which we use for the project: https://github.com/sign-language-processing/sign-language-processing.github.io/blob/master/.github/workflows/format-bib.yml
Here's ChatGPT's suggestion: https://chatgpt.com/share/f49104b3-c9a5-4d96-850a-da8918c5dfbb, which basically boils down to writing a Python script and setting up a hook

cleong110 commented 2 weeks ago

Could try https://github.com/super-linter/super-linter