[jbosstools-issues] [JBoss JIRA] (JBIDE-12915) Kitchensink quickstart is missing .cheatsheet.xml

[Snjezana Peco (JIRA)]

    [ https://issues.jboss.org/browse/JBIDE-12915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12794158#comment-12794158 ] 

Snjezana Peco commented on JBIDE-12915:
---------------------------------------

I have updated the PR. Now, it uses the commands introduced by https://issues.jboss.org/browse/JBIDE-14333
This cheatsheet will work with a project example based on an archetype if you copy a project to the workspace and import it or rename the project.

The following are the main changes:

1) At the beginning of the cheatsheet, you will see the following command:

<command
  required="true"
  returns="currentProject"
  serialization="org.jboss.tools.project.examples.cheatsheet.getProjectForCheatsheet"/>

The command is obliged because it sets the currentProject variable.

After that, the currentProject variable is used instead of the hard-coded project name.
For instance:

<command
  required="true" serialization="org.jboss.tools.project.examples.cheatsheet.openFileInEditor(path=/${currentProject}/src/main/webapp/WEB-INF/templates/default.xhtml,fromLine=22,toLine=26
  
or

<action
  pluginId="org.jboss.tools.project.examples.cheatsheet"
  class="org.jboss.tools.project.examples.cheatsheet.actions.RunOnServer"
  param1="${currentProject}"/>
  
Within the action, it is possible to use a variable like  

param1="${currentProject}"

but is not possible to use a variable as

paramN="/${currentProject}/src/main/webapp/WEB-INF/templates/default.xhtml"

The currentProject variable in the paramN attribute won't be translated which means the openFileInEditor command must be used instead of the org.jboss.tools.project.examples.cheatsheet.actions.OpenFileInEditor action.

We also need to add the runOnServer and launchJUnitTest command.


                
> Kitchensink quickstart is missing .cheatsheet.xml
> -------------------------------------------------
>
>                 Key: JBIDE-12915
>                 URL: https://issues.jboss.org/browse/JBIDE-12915
>             Project: Tools (JBoss Tools)
>          Issue Type: Bug
>          Components: project-examples
>    Affects Versions: 4.0.0.Beta1
>            Reporter: Radim Hopp
>            Assignee: Snjezana Peco
>             Fix For: 4.0.0.CR1
>
>
> After importing Kitchensink example from section "JBoss Developer Framework Quickstarts" in JBoss Central, user is prompted to
> {noformat}Show '/jboss-as-kitchensink/.cheatsheet.xml' for further instructions{noformat}
> but /jboss-as-kitchensink/.cheatsheet.xml does not exist.
> Imported quickstart is named "kitchensink" instead of jboss-as-kitchensink and it has README.md instead of .cheatsheet.xml

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira