Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vladyslav-burylov committed Dec 9, 2020
1 parent 254fd70 commit 28138ba
Show file tree
Hide file tree
Showing 12 changed files with 35 additions and 54 deletions.
18 changes: 1 addition & 17 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,6 @@ indent_size = 4
indent_style = space
indent_size = 2

[*.{json,props}]
indent_style = space
indent_size = 2

[*.js]
indent_style = space
indent_size = 4

[*.config.js]
indent_style = space
indent_size = 2

[*.{cshtml,html,razor}]
indent_style = space
indent_size = 2

[*.{css,scss,sass}]
[*.{json,props,xml}]
indent_style = space
indent_size = 2
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## 2020.3.1

- Updated plugin description/documentation

## 2020.3.0

- Support for Rider 2020.3
Expand Down
48 changes: 15 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,17 @@

[![License](https://img.shields.io/github/license/vladyslav-burylov/resharper-testlinker2)](LICENSE)

Test Linker 2 collects link data between types (i.e., production and test code) based on various mechanisms and provides various features based on that. For your convenience, Test Linker 2 automatically takes base/derived types into account when meaningful.
Test Linker 2 collects link data between types (i.e., production and test code)
based on various mechanisms and provides various features based on that.
For your convenience, Test Linker 2 automatically takes base/derived types into
account when meaningful.

## WARNING
#Z# Features

This fork of the archieved [TestLinker plugin](https://github.com/matkoch/resharper-testlinker) originally developed by Matthias Koch was created for personal use and does not guaranteed to be supported.
- Adds hotkey for quick switching between tests/code
- Synchronizes test/production classes renames

### Building Locally

- Please go though https://github.com/JetBrains/resharper-rider-plugin
- Once initial setup is done, plugin can be build using:

```bash
./gradlew :buildPlugin
```

## Navigation

<img src=misc/Demon_Navigate.gif />

- [Goto Related Files](https://www.jetbrains.com/help/resharper/2016.1/Navigation_and_Search__Go_to_Related_Files.html) is extended with navigation points to production/test classes.
- New shortcut `ReSharper_GotoAllLinkedTypes` (assignable via keyboard options) that jumps between linked types. In case of multiple linked types, a dedicated popup menu is shown, which can also be displayed in [Find Results](https://www.jetbrains.com/help/resharper/2016.1/Reference__Windows__Find_Results_Window.html) window.

## Test Creation

<img src=misc/Demo_Create.gif />

- Create production/test class if they don't exist
- Requires at least one matching pair of test and production class in the project

## Test Execution

- Tests can be executed from their linked production code. This feature automatically integrates with the shortcuts for executing unit tests in *run*, *debug*, *profile*, and *cover* mode.
<img src="misc/Demo.gif" alt="demo video"/>

## Configuration

Expand All @@ -42,10 +21,13 @@ Link data is currently maintained via:
- **Derived names**, as with `Calculator` and `CalculatorTest`. Pre-/Postfixes can be configured in the options page.
- **Usages of TypeofAttributes**, as in `[Subject (typeof (FirstComponent), typeof(SecondComponent)]`, which are applied to test classes. This custom attribute is especially useful for integration test and can be configured through the options page.

### Rider
<img src="misc/OptionsPage.png" alt="options page screenshot"/>

<img src=misc/OptionsPage-Rider.png width=600px />
## Building Locally

### ReSharper
- Please go though https://github.com/JetBrains/resharper-rider-plugin
- Once initial setup is done, plugin can be build using:

<img src=misc/OptionsPage.png width=600px />
```bash
./gradlew :buildPlugin
```
3 changes: 3 additions & 0 deletions TestLinker2.sln
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ ProjectSection(SolutionItems) = preProject
CHANGELOG.md = CHANGELOG.md
gradle.properties = gradle.properties
src\dotnet\Directory.Build.props = src\dotnet\Directory.Build.props
.editorconfig = .editorconfig
.gitattributes = .gitattributes
.gitignore = .gitignore
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "rider", "rider", "{0D2E1B08-01C7-4E9E-A398-5045BD79BE1C}"
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
DotnetPluginId=ReSharperPlugin.TestLinker2
DotnetSolution=TestLinker2.sln
RiderPluginId=testlinker2
PluginVersion=2020.3.0
PluginVersion=2020.3.1

BuildConfiguration=Debug

Expand Down
Binary file added misc/Demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed misc/Demo_Create.gif
Binary file not shown.
Binary file removed misc/Demon_Navigate.gif
Binary file not shown.
Binary file removed misc/ExtensionManager.png
Binary file not shown.
Binary file removed misc/OptionsPage-Rider.png
Binary file not shown.
Binary file modified misc/OptionsPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 11 additions & 3 deletions src/rider/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<idea-plugin require-restart="true">
<id>testlinker2-rider</id>
<name>Test Linker 2</name>
<id>testlinker2-rider</id>
<version>_PLACEHOLDER_</version>
<vendor url="https://github.com/vladyslav-burylov/resharper-testlinker2">Vladyslav Burylov</vendor>
<idea-version since-build="_PLACEHOLDER_" until-build="_PLACEHOLDER_" />

<depends>com.intellij.modules.rider</depends>
<idea-version since-build="_PLACEHOLDER_" until-build="_PLACEHOLDER_" />

<actions>
<action id="GotoLinkedTypes2" class="com.jetbrains.rider.plugins.testlinker2.GotoLinkedTypes2Action"
Expand All @@ -14,9 +15,16 @@
</action>
</actions>

<change-notes>Initial release of the plugin.</change-notes>

<description>
<![CDATA[
<p>Semantically linking production and test code. This is fork of TestLinker plugin.</p>
<ul>
<li>Adds hotkey for quick switching between tests/code</li>
<li>Synchronizes test/production classes renames</li>
</ul>
<br/>
See <a href="https://github.com/vladyslav-burylov/resharper-testlinker2/blob/master/README.md">documentation</a> for more details, please.
]]>
</description>

Expand Down

0 comments on commit 28138ba

Please sign in to comment.