Making CloudSlang plugin public from cloudslang-idea-plugin, revision a…

…0864d0

.gitignore

@@ -0,0 +1,2 @@
+*.iml
+/.idea/

LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

README.md

@@ -1,2 +1,167 @@
-# cs-intellij-plugin
-IntelliJ IDEA plugin for CLoudSlang
+<a href="http://cloudslang.io/">
+    <img src="https://camo.githubusercontent.com/ece898cfb3a9cc55353e7ab5d9014cc314af0234/687474703a2f2f692e696d6775722e636f6d2f696849353630562e706e67" alt="CloudSlang logo" title="CloudSlang" align="right" height="60"/>
+</a>
+
+CloudSlang Plugin for IntelliJ  
+================================
+
+  <br/>
+This repository contains an IntelliJ plugin that provides support for [CloudSlang](http://cloudslang.io/) in *IntelliJ IDEA* IDE.  
+
+![CloudSlang Plugin demo](/screenshots/plugin-overview.png)
+
+
+##Table of Contents
+
+1. [Features](#features)  
+2. [Installation](#installation)  
+3. [Getting Started](#getting-started)
+4. [Contribution Guidelines](#contribution-guidelines)
+  1. [Environment Setup](#environment-setup)
+  2. [Run and Debug the Code](#run-and-debug-the-code)
+  3. [Package and Deploy the Plugin](#package-and-deploy-the-plugin)
+
+
+##Features
+
+* CloudSlang file type support (.sl, .sl.yaml, .sl.yml, .prop.sl)
+* Live templates (e.g: flow, operation, input, output, step, for, java_action etc.)
+* Completion support for CloudSlang keywords
+* Syntax highlighting
+* CloudSlang file validation and error highlighting
+
+
+##Installation
+
+1. Download the plugin from this link: ftp://mydwbld0006g.hpeswlab.net/CDP/cloudslang-idea-plugin.zip.  
+2. Install the CloudSlang IntelliJ Plugin in IntelliJ using the __Plugin Installation Wizard__ from __File > Settings > Plugins > Install Plugin From Disk...__.  
+3. In the __Choose Plugin File__ dialog, located the __coudslan-idea-plugin.zip__ file, downloaded at step 1, select it, and press __OK__.  
+4. Click __Apply__ button of the __Settings__ dialog.
+
+> Following the system prompt that appears, restart IntelliJ IDEA to activate the installed plugin, or postpone it, at your choice.
+
+
+##Getting Started
+
+This is a short tutorial showing how to start developing CloudSlang content.
+
+#####1. Create a new Project 
+
+From the **New Project** dialog, select the type of project you desire, for example, **Java Project**.
+
+![CloudSlang File Type](/screenshots/new-project.png)
+
+<br/>
+#####2. Create a namespace
+
+Under the new project, create a structure of directories for items grouping:
+
+![CloudSlang File Type](/screenshots/new-namespace.png)
+
+You can notice the following directory structure under your project:
+
+![CloudSlang File Type](/screenshots/new-namespace-structure.png)
+
+<br/>    
+#####3. Create a new CloudSlang file 
+
+Under the **base** directory, create a new file with one of the following extenssions: **.sl, .sl.yaml, .sl.yml, .prop.sl**  
+When a file with one of these extensions is created, a CloudSlang icon is associated to it:
+
+![CloudSlang File Type](/screenshots/file-type.png)
+
+> By default, empty CloudSlang files are marked as invalid. 
+
+<br/>    
+#####4. Create a new CloudSlang flow from a live template
+
+Open the __first_flow.sl__ file and place the cursor inside the editor.  
+
+You can insert a **flow** template in two ways:  
+* Press __Ctrl + J__ to display a list of all available live templates. You can navigate up and down inside this list and select the desired template, that will be extended in the editor.  
+
+![CloudSlang File Type](/screenshots/all-live-templates.png)
+
+* Start typing the _flow_ word and the template will appear in the suggestions list
+
+![CloudSlang File Type](/screenshots/live-template-example.png)
+
+> You can always identify CloudSlang templates in the suggestions list by the **CloudSlang Template** description at right.
+
+After the template is expended in IntellJ, you may be required to provide values for some input fields. You can navigate between input fields by pressing __Tab__. 
+
+![CloudSlang File Type](/screenshots/template-input-fields.png)
+
+<br />
+#####5. Use completion support for CloudSlang keywords
+
+You can easily modify the flow using CloudSlang keywords support. Whenever you start typing, a suggestion list with CloudSlang keywords will appear:
+
+![CloudSlang File Type](/screenshots/completion-example.png)
+
+To see the complete list of CloudSlang keywords, press **Ctrl + Space**
+
+> In order to differentiate between keywords and live templates in the suggestions list, note that keywords have a small CloudSlang icon at left, while live templates have the **CloudSlang Template** description at right 
+
+<br />
+#####5. Use error highlighting to ensure that your flow is correct
+
+Errors are marked with a red underline inside files. Hover over the underlined item to see the error messages:
+
+![CloudSlang File Type](/screenshots/error-highlighting.png)
+
+<br />
+
+##Contribution Guidelines
+
+###Environment Setup
+
+These are the prerequisite steps that you have to follow to successfully set up your development environment:  
+
+1. Clone this reposiotry using a Git client.  
+
+2. Open IntelliJ and configure IntelliJ Platform SDK as described in the [Intellij SDK DevGuide] (http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/setting_up_environment.html).  
+*__Cloning IntelliJ CE edition Source Code is optional.__*  
+
+3. In IntelliJ, navigate to __File > New > Project__  
+
+4. From the __New Project__ dialog, select __IntelliJ Platform Plugin__ as the type of the project and set the __Project SDK__ to the one configured in __step 2__.  
+![plugin](/screenshots/dev/new-plugin.png)
+
+5. Click __Next__  
+
+6. In the __Project location__ textbox, copy the absolute path of the repository cloned at __step 1__. 
+![plugin](/screenshots/dev/open-plugin.png)
+
+7. Click __Finish__. The __cloudslang-intellij-plugin__ sources will be imported into your IDE.  
+
+8. CloudSlang IntelliJ Plugin depends on YAML plugin, delivered with IntelliJ. In order to be able to compile the code, you have to import the YAML plugin to your SDK classpath. Navigate to __File > Project Structure > SDKs__.  
+
+9. Select your IntelliJ SDK from the list of available SDKs.  
+
+10. Make sure the __Classpath__ tab is selected. Add a new jar to sdk classpath.  
+![plugin](/screenshots/dev/add-to-sdk.png)  
+
+12. Select the following jar and add it to classpath: __*IntelliJ_Installation_Dir*/plugins/yaml/lib/yaml.jar__  
+
+13. CloudSlang IntelliJ Plugin depends on CloudSlang compiler. To be able to compile the code you have to add cloudslang-compiler to classpath. Navigate to __File > Project Structure > Libraries__.  
+
+14. Locate the __lib__ directory inside __cloudslang-idea-plugin__ and add it to the classpath.  
+**You can add the entire lib folder to the classpath, you don't have to manually add each jar from inside.**
+
+Now, you should be able to successfully compile and run the code.
+<br />
+
+
+###Run and Debug the Code
+
+The [Running and Debugging Plugins](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/running_and_debugging_a_plugin.html) section from __IntelliJ SDK DevGuide__ provides all information you need to debug and run the plugin.
+<br />
+
+
+###Package and Deploy the Plugin
+
+Read the [Deploy a  Plugin](http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/deploying_plugin.html) section from __IntelliJ SDK DevGuide__.  
+> You can also install the plugin using the __Plugin installation wizard__ from IntelliJ. Navigate to __File > Settings > Plugins > Install Plugin from disk...__
+
+