implemented the remarks from @pascalberger

added a page for IntelliSense and refactored the other pages into one.
cake-build · Dec 25, 2020 · d6cf146 · d6cf146
1 parent cf0ac44
commit d6cf146
Show file tree

Hide file tree

Showing 7 changed files with 164 additions and 54 deletions.
diff --git a/input/docs/integrations/editors/rider/index.cshtml b/input/docs/integrations/editors/rider/index.cshtml
@@ -1,4 +1,4 @@
-Order: 40
+Order: 20
 Title: Rider
 Description: Extensions and supported features for JetBrains Rider
 RedirectFrom: docs/editors/rider
@@ -7,21 +7,28 @@ RedirectFrom: docs/editors/rider
 <div>
     DOT NOT MERGE <br />
     DOT NOT MERGE <br />
-    DOT NOT MERGE -- The following link (.../marketplace) needs to be replaced with the correct link to the plugin in the marketplace<br />
+    DOT NOT MERGE -- The following 3 links (.../marketplace) needs to be replaced with the correct link to the plugin in the marketplace<br />
     DOT NOT MERGE <br />
     DOT NOT MERGE <br />
 
     The <a href="https://plugins.jetbrains.com/marketplace" target="_blank">Cake plugin for Rider </a>
     brings the following features to JetBrains Rider:
     <ul>
-        <li><a href="/docs/integrations/editors/rider/tasks-window">Cake script and tasks recognition</a> in a tool window</li>
         <li><a href="/docs/integrations/editors/rider/run-configurations">Run configurations</a></li>
     </ul>
 </div>
 
 <h1>Installation & configuration</h1>
 
-See <a href="https://plugins.jetbrains.com/marketplace" target="_blank">Cake plugin for Rider</a> for instructions how to install and configure the plugin.
+<p>
+    See <a href="https://plugins.jetbrains.com/marketplace" target="_blank">Cake plugin for Rider</a> for instructions how to install and configure the plugin.
+</p>
+
+<div class="alert alert-info">
+    <p>
+        The <a href="https://plugins.jetbrains.com/marketplace" target="_blank">Cake plugin for Rider</a> supports Rider version 2019.3 and newer.
+    </p>
+</div>
 
 <h1>Child pages</h1>
 

diff --git a/input/docs/integrations/editors/rider/intellisense.md b/input/docs/integrations/editors/rider/intellisense.md
@@ -0,0 +1,38 @@
+Order: 20
+Title: IntelliSense in Rider
+Description: Support for IntelliSense
+---
+
+# Enabling IntelliSense
+
+To enable IntelliSense support in Rider follow these steps:
+
+<ul class="nav nav-tabs">
+    <li class="active"><a data-toggle="tab" href="#tool2">Cake .NET Tool</a></li>
+    <li><a data-toggle="tab" href="#frosting2">Cake Frosting</a></li>
+    <li><a data-toggle="tab" href="#netfx2">Cake runner for .NET Framework</a></li>
+    <li><a data-toggle="tab" href="#core2">Cake runner for .NET Core</a></li>
+</ul>
+
+<div class="tab-content">
+    <div id="tool2" class="tab-pane fade in active">
+        <p>
+            There is currently no support for Intellisense in <code>.cake</code> script files within Rider.
+        </p>
+    </div>
+    <div id="frosting2" class="tab-pane fade">
+        <p>
+            <a href="/docs/running-builds/runners/cake-frosting">Cake Frosting</a> projects have all features of a .NET Console application, including IntelliSense.
+        </p>
+    </div>
+    <div id="netfx2" class="tab-pane fade">
+        <p>
+            There is currently no support for Intellisense in <code>.cake</code> script files within Rider.
+        </p>
+    </div>
+    <div id="core2" class="tab-pane fade">
+        <p>
+            There is currently no support for Intellisense in <code>.cake</code> script files within Rider.
+        </p>
+    </div>
+</div>
diff --git a/input/docs/integrations/editors/rider/run-configurations.md b/input/docs/integrations/editors/rider/run-configurations.md
@@ -3,13 +3,123 @@ Title: Run configurations
 Description: Run configurations for Cake tasks
 ---
 
-# Run configurations
+In order to use the run configurations you must have Cake installed on your machine or in your solution.
+
+<ul class="nav nav-tabs">
+    <li class="active"><a data-toggle="tab" href="#tool">Cake .NET Tool</a></li>
+    <li><a data-toggle="tab" href="#frosting">Cake Frosting</a></li>
+    <li><a data-toggle="tab" href="#netfx">Cake runner for .NET Framework</a></li>
+    <li><a data-toggle="tab" href="#core">Cake runner for .NET Core</a></li>
+</ul>
+
+<div class="tab-content">
+    <div id="tool" class="tab-pane fade in active">
+        <p>
+            To use Cake .NET Tool it needs to be installed globally:
+        </p>
+        <pre><code class="language-cmd hljs">dotnet tool install --global Cake.Tool</code></pre>
+        <p>
+            This is the default setup in Cake for Rider.
+        </p>
+    </div>
+    <div id="frosting" class="tab-pane fade">
+        <p>
+            There is currently no support for run configurations for Cake Frosting.
+        </p>
+    </div>
+    <div id="netfx" class="tab-pane fade">
+        <p>
+            Install Cake using any of the following options:
+        </p>
+        <ul>
+            <li>
+                <p>
+                    On Windows using <a href="https://chocolatey.org/">Chocolatey to install it globally</a>:
+                </p>
+                <pre><code class="language-cmd hljs">choco install cake.portable</code></pre>
+            </li>
+            <li>
+                <p>
+                    Use a <a href="/docs/running-builds/runners/cake-runner-for-dotnet-framework#bootstrapping-for-cake-runner-for.net-framework">bootstrapper</a>.
+                </p>
+                <p>
+                    This requires to setup the bootstrapper(s) under <a href="#runner-settings">settings</a>
+                </p>
+            </li>
+        </ul>
+    </div>
+    <div id="core" class="tab-pane fade">
+        <p>
+            There is currently no support for task runner for Cake runner for .NET Core.
+        </p>
+    </div>
+</div>
+
+## Supported runners
+
+| Runner                           | Supported                                       | Remarks                                            |
+|----------------------------------|-------------------------------------------------|----------------------------------------------------|
+| [Cake .NET Tool]                 | <i class="fa fa-check" style="color:green"></i> |                                                    |
+| [Cake Frosting]                  | <i class="fa fa-times" style="color:red"></i>   |                                                    |
+| [Cake runner for .NET Framework] | <i class="fa fa-check" style="color:green"></i> |                                                    |
+| [Cake runner for .NET Core]      | <i class="fa fa-times" style="color:red"></i>   |                                                    |
+
+[Cake .NET Tool]: dotnet-tool
+[Cake Frosting]: cake-frosting
+[Cake runner for .NET Framework]: cake-runner-for-dotnet-framework
+[Cake runner for .NET Core]: cake-runner-for-dotnet-core
+
+# Creating run configurations
 
 It is possible to have Cake tasks as run configurations:
 
 ![Run configurations](/assets/img/cake-rider/docs/runConfigurations.png){.img-responsive}
 
+Currently only run configurations are supported. Debug configurations are not supported.
+
 The configurations can either be created from an existing Cake task, 
-using the [tool window](./tasks-window) or created manually using the run configuration editor:
+using the [tool window](#cake-tasks-tool-window) or created manually using the run [configuration editor](#editing-run-configurations).
+
+# Editing run configurations
+
+An editor for run configurations is available:
+
+![Run configuration editor](/assets/img/cake-rider/docs/runConfiguration-editor.png){.img-responsive}
+
+# Cake tasks tool window
+
+The Cake tasks tool window lists all Cake scripts and their tasks:
+
+![Cake Tasks tool window](/assets/img/cake-rider/docs/toolWindow.png){.img-responsive}
+
+Using a double click on a task will run that task immediately:
+
+![Cake Tasks tool window](/assets/img/cake-rider/docs/cake-run.png){.img-responsive}
+
+Alternatively, the buttons at the top of the tool window can be used to either run the task immediately,
+or create a new [run configuration](#creating-run-configurations).
+
+# Settings regarding the run configurations
+
+There are multiple configuration settings available under File -> Settings -> Build, Execution, Deployment -> Cake.
+
+All settings are project - specific and stored in the `.idea` folder. To share settings across developers, make sure to put `CakeRider.xml` under source control.
+
+## Generic settings
+
+* *Cake file extension*  
+  This setting is used to find all Cake files and display them in the tool window.  
+  Default: `cake`
+* *Task Regex*  
+  This regular expression is used to parse tasks from the Cake files.  
+  Default: `Task\s*?\(\s*?"(.*?)"\s*?\)`
+* *Verbosity*  
+  This is the default verbosity to use, when running a task directly from the tool window or when creating a new run configuration.  
+  Default: `normal`
+
+## Runner settings
+
+Allows to define the runner to use. 
+Different runners for different operating systems can be set by defining a regular expression which is matched against the system property `os.name`.
 
-![Run configuration editor](/assets/img/cake-rider/docs/runConfiguration-editor.png){.img-responsive}
+Default value is `dotnet-cake` and `dotnet-cake.exe` for Windows.
diff --git a/input/docs/integrations/editors/rider/settings.md b/input/docs/integrations/editors/rider/settings.md
diff --git a/input/docs/integrations/editors/rider/tasks-window.md b/input/docs/integrations/editors/rider/tasks-window.md
diff --git a/input/docs/integrations/editors/visualstudio/index.cshtml b/input/docs/integrations/editors/visualstudio/index.cshtml
@@ -1,4 +1,4 @@
-Order: 30
+Order: 40
 Title: Visual Studio
 Description: Extensions and supported features for Visual Studio
 RedirectFrom: docs/editors/visualstudio

diff --git a/input/docs/integrations/editors/vscode/index.cshtml b/input/docs/integrations/editors/vscode/index.cshtml
@@ -1,4 +1,4 @@
-Order: 20
+Order: 30
 Title: Visual Studio Code
 Description: Extensions and supported features for Visual Studio Code
 RedirectFrom: docs/editors/vscode