Feature Suggestions: allow "_comment" in {%- schema -%} attributes
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 11.9k
- Forks
- 1.5k
- Avg merge
- 17h 55m
- Merged PRs (30d)
- 3
Description
So {%- schema -%} can get very bloated and hard to read, even with proper "id"s and since it's just JSON there is no native possibility to comment it.
Therefor I suggest to allow something like "_comment" as attribute within schema:
{
"_comment": "-- NEWSLETTER SETTINGS --",
"type": "header",
"content": "t:sections.footer.settings.newsletter.settings_header.content",
"info": "t:sections.footer.settings.newsletter.settings_header.info"
},
{
"type": "checkbox",
"id": "newsletter_enable",
"default": true,
"label": "t:sections.footer.settings.newsletter.enable.label"
},
{ "...": "..." }
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementation that parses or validates {%- schema -%} attributes, since the issue names no files or tests. Determine how a _comment attribute should be handled without changing the resulting schema, and define completion as accepted schema input with the comment serving only as readable annotation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- web-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100