Skip to content
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

[CI]: Consider More Detailed JinJa2 Template Linting and Checking #2698

Open
BethanyG opened this issue Oct 27, 2021 · 1 comment
Open

[CI]: Consider More Detailed JinJa2 Template Linting and Checking #2698

BethanyG opened this issue Oct 27, 2021 · 1 comment
Labels
discussion 💬 smolder🍲 Lower-priority and/or future idea

Comments

@BethanyG
Copy link
Member

After doing numerous JinJa2 template PRs and test file regeneration (and getting caught by a nasty indentation bug), it feels like we could benefit from setting up some linting rules and checks for JinJa2 templates that are a bit more detailed and custom. Right now, we check that the files will produce test files that can be linted by Black, but we don't really do much additional validation.

Marking this as a discussion, since I haven't formed many more thoughts that that around this issue. But I anticipate both more contributors and more changes to templates going forward, so thought I'd make a note here of what I have found so far:

curlylint
Jinjalint

@BethanyG BethanyG added discussion 💬 smolder🍲 Lower-priority and/or future idea labels Oct 27, 2021
@github-actions
Copy link
Contributor

🤖   🤖

Hi! 👋🏽 👋 Welcome to the Exercism Python Repo!

Thank you for opening an issue! 🐍  🌈 ✨


  •   If you are requesting support, we will be along shortly to help. (generally within 72 hours, often more quickly).
  •   Found a problem with tests, exercises or something else??  🎉
      We'll take a look as soon as we can & identify what work is needed to fix it. (generally within 72 hours).

​           - If you'd also like to make a PR to fix the issue after discussing it,
             We  💙  PRs that follow our Exercism & Track contributing guidelines!

  •   Here because of an obvious (and small set of) spelling, grammar, or punctuation issues with one exercise,
      concept, or Python document?? 🌟 Please feel free to submit a PR, linking to this issue. 🎉

​        ❗ Please do not run checks on the whole repo & submit a bunch of PRs.
              This creates longer review cycles & exhausts reviewers energy & time.
              It may also conflict with ongoing changes from other contributors.
              For anything complicated or ambiguous, let's discuss things -- we will likely welcome a PR from you.

​        ❗ Please keep in mind that inserting only blank lines, making a closing bracket drop to the next line, changing a word
              to a synonym without obvious reason, adding trailing space that's not a EOL for the very end of text files,
              and other "changes just to change things" are not considered helpful, and will likely be closed by reviewers.


💙  While you are here... If you decide to help out with other open issues, you have our gratitude 🙌 🙌🏽.
Anything tagged with [help wanted] and without [Claimed] is up for grabs.
Comment on the issue and we will reserve it for you. 🌈 ✨

Here to suggest a feature or new exercise?? Hooray! 🎉   Please keep in mind Chesterton's Fence.
Thoughtful suggestions will likely result faster & more enthusiastic responses from maintainers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion 💬 smolder🍲 Lower-priority and/or future idea
Projects
None yet
Development

No branches or pull requests

1 participant