A file template is added for a Jenkins Jelly View #112
Conversation
There was a problem hiding this comment.
Thank you @julieheard ! With a few corrections, I think it will be a good improvement to the plugin.
In addition to inline comments, I think the filename needs to be changed. It is not used for the file created from the template, but it is used in IntelliJ UI so needs to be more descriptive. I'm not sure which would be the best, here are some ideas Stapler View.jelly.ft or maybe "Stapler Jelly View.jelly.ft` since there can also be Groovy views.
@timja can you give your two cents? Is this template a good starting point for Jelly Views? What would be a good name for it?
|
|
||
| <?jelly escape-by-default='true'?> | ||
| <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form" > | ||
| <f:section title="${%Put Section Name Here}"> |
There was a problem hiding this comment.
why are we adding a section by default, lots of config pages won't need that, e.g. if they are included in another one
There was a problem hiding this comment.
The guide suggests creating a template based on a file and then exporting the result and adding to a plugin. I'm guessing this template is based on config view with a section.
Are there multiple type of views each with different boilerplate?
What's the current process for creating a view? What would ideal one look like?
There was a problem hiding this comment.
just an empty jelly file I think with the form and layout namespaces imported as they are the most common ones
There was a problem hiding this comment.
This template is based on config view with a section. Is the plan to have several different templates? In which case we can have templates with sections and templates without any sections.
There was a problem hiding this comment.
based off of https://plugins.jetbrains.com/docs/intellij/providing-file-templates.html#file-templates-categories I don't think it should include section, just an empty jelly file should be fine
There was a problem hiding this comment.
Well... /lib/form namespace is a Jenkins thing. Jelly is not popular but still has some use elsewhere.
ServiceNow Jelly tags < ServiceNow seems to be using it. Hence, I suggested an extra qualifier in the name. Maybe it should be "Jenkins Jelly View", not Stapler.
Maybe I am overthinking. ServiceNow seems to have a built-in editor, so it might be unlikely that any SNOW developer will discover this plugin because IntelliJ says that it supports *.jelly extension. Even if they do, they'll probably see the plugin name and avoid installing it anyway. 🤷
There was a problem hiding this comment.
OK. What do we agree on?
- Remove
f:sectiontag - Rename the file to
Jenkins Jelly view.jelly.ft
Pretty sure we agreed on 1. Did I get the 2 right?
There was a problem hiding this comment.
@julieheard please do the above two actions and I will merge the PR. Thank you!
There was a problem hiding this comment.
Both changes done
Ok, agreed Co-authored-by: Denys Digtiar <duemir@gmail.com>
Looks good to me Co-authored-by: Denys Digtiar <duemir@gmail.com>
removed help link
duemir
changed the title
duemir
changed the title
Link to relevant pull requests, esp. upstream and downstream changesEnsure you have provided tests - that demonstrates feature works or fixes the issueI have followed the tutorials here https://plugins.jetbrains.com/docs/intellij/providing-file-templates.html to start making file templates. This is for issue here - #41