• Stars
    star
    319
  • Rank 125,647 (Top 3 %)
  • Language
    F#
  • License
    Apache License 2.0
  • Created about 7 years ago
  • Updated 27 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

F# support in JetBrains Rider

F# language support in JetBrains Rider

JetBrains official project Join the chat at https://gitter.im/JetBrains/resharper-fsharp

F# support in Rider is implemented as a plugin made of two major components:

  • ReSharper.Host plugin (referred to as the backend) that adds F# support to ReSharper and is implemented in ReSharper.FSharp solution. ReSharper.Host is a modification of ReSharper used as a language service that the IntelliJ Platform interacts with. The backend is written in F# and C#.
  • IntelliJ Platform plugin for Rider (referred to as the frontend) that defines F# as a new IntelliJ Platform language but delegates most of the work to the backend. This part also adds F# Interactive support. The frontend is written in Kotlin and Java.

F# support in Rider makes use of open source software, most notably FSharp.Compiler.Service and Fantomas.

Building the plugin

Requirements

Optional

Building the plugin and launching Rider in a sandbox

  1. Install SDK and prepare backend plugin build using Gradle

    • if using IntelliJ IDEA:

      Open the rider-fsharp project in IntelliJ IDEA. When suggested to import Gradle projects, accept the suggestion: Gradle will download Rider SDK and set up all necessary dependencies. rider-fsharp uses the gradle-intellij-plugin Gradle plugin that downloads the IntelliJ Platform SDK, packs the F# plugin and installs it into a sandboxed IDE or its test shell, which allows testing the plugin in a separate environment.

      Open the Gradle tool window in IntelliJ IDEA (View | Tool Windows | Gradle), and execute the rider-fsharp/prepare task.

    • if using Gradle command line:

      $ cd ./rider-fsharp
      $ ./gradlew prepare
      
  2. Open ReSharper.FSharp.sln solution and build using the Debug configuration. The output assemblies are later copied to the frontend plugin directories by Gradle. (If you're seeing build errors in Rider, choose File | Settings | Build, Execution, Deployment | Toolset and Build, and in the Use MSBuild version drop-down, make sure that Rider uses MSBuild shipped with .NET Core SDK.)

  3. Launch Rider with the plugin installed

    • if using IntelliJ IDEA:

      Open the Gradle tool window in IntelliJ IDEA (View | Tool Windows | Gradle), and execute the intellij/runIde task. This will build the frontend, install the plugin to a sandbox, and launch Rider with the plugin.

    • if using Gradle command line:

      $ ./gradlew runIde
      

Installing to an existing Rider instance

  1. Build the Debug configuration in ReSharper.FSharp.sln.
  2. Execute the buildPlugin Gradle task.
  3. Install the plugin (rider-fsharp/build/distributions/*.zip) to your Rider installation from disk.

Contributing

We welcome contributions that address any F# plugin issues that are open in Rider's issue tracker. Some of these issues are marked as Up for grabs: we expect issues tagged this way to be easier addressed by external contributors as they are unlikely to require any changes outside the F# plugin. Note that some issues are marked as third-party problems, and addressing them requires fixes from FCS or other projects that this plugin depends on.

If you are willing to work on an issue, please leave a comment under the issue. Doing this will make sure that the team doesn't start working on the same issue, and help you get any necessary assistance.

New code is usually written in F#, except for the FSharp.Psi project that is written in C#.

As soon as you are done with changes in your fork, please open a pull request for review.

Note that the public CI server is not set up at this point but it's going to be available shortly.

We suggest that you read docs on the two SDKs that this plugin uses:

You can find some tips and tricks about the ReSharper.Host plugin (the backend) in the ReSharper.FSharp/docs folder of this repository.

Development notes

The main development branch is changed on each release (i.e. net212 correspond to 2021.2 development cycle), and builds from this branch are bundled with nightly Rider builds available via JetBrains Toolbox App.

By default, the project depends on nightly SDK builds, but a specific SDK version can be referenced in rider-fsharp/build.gradle if necessary.

Gradle downloads a newer SDK from time to time. To force an update, run the prepare --refresh-dependencies Gradle task.

To debug the backend, attach debugger to the ReSharper.Host process launched via the runIde Gradle task. To debug the frontend, start the runIde task in Debug mode.

Rider's JVM-based frontend and .NET-based backend communicate using RdProtocol with APIs available on both sides. For backend-frontend communication in plugins, RdProtocol should be used as well. Protocol model is defined in this file.

Running backend tests is not yet possible on macOS and Linux.

More Repositories

1

kotlin

The Kotlin Programming Language.
Kotlin
45,725
star
2

intellij-community

IntelliJ IDEA Community Edition & IntelliJ Platform
16,452
star
3

compose-multiplatform

Compose Multiplatform, a modern UI framework for Kotlin that makes building performant and beautiful user interfaces easy and enjoyable.
Kotlin
14,518
star
4

JetBrainsMono

JetBrains Mono โ€“ the free and open-source typeface for developers
Shell
10,126
star
5

ideavim

IdeaVim โ€“ A Vim engine for JetBrains IDEs
Kotlin
7,980
star
6

Exposed

Kotlin SQL Framework
Kotlin
7,824
star
7

kotlin-native

Kotlin/Native infrastructure
Kotlin
7,048
star
8

ring-ui

A collection of JetBrains Web UI components
TypeScript
3,549
star
9

kotlinconf-app

KotlinConf Schedule Application
Kotlin
2,822
star
10

intellij-platform-plugin-template

Template repository for creating plugins for IntelliJ Platform
Kotlin
2,736
star
11

skija

Java bindings for Skia
Java
2,601
star
12

create-react-kotlin-app

Create React apps using Kotlin with no build configuration
JavaScript
2,477
star
13

projector-docker

Run JetBrains IDEs remotely with Docker
Shell
2,209
star
14

intellij-plugins

Open-source plugins included in the distribution of IntelliJ IDEA Ultimate and other IDEs based on the IntelliJ Platform
Java
2,002
star
15

svg-sprite-loader

Webpack loader for creating SVG sprites.
JavaScript
1,998
star
16

skiko

Kotlin MPP bindings to Skia
Kotlin
1,669
star
17

compose-multiplatform-ios-android-template

Compose Multiplatform iOS+Android Application project template
Kotlin
1,563
star
18

MPS

JetBrains Meta programming System
JetBrains MPS
1,500
star
19

lets-plot

Multiplatform plotting library based on the Grammar of Graphics
Kotlin
1,434
star
20

kotlin-web-site

The Kotlin programming language website
JavaScript
1,406
star
21

gradle-intellij-plugin

Gradle plugin for building plugins for IntelliJ-based IDEs
Kotlin
1,365
star
22

phpstorm-stubs

PHP runtime & extensions header files for PhpStorm
PHP
1,295
star
23

kotlin-wrappers

Kotlin wrappers for popular JavaScript libraries
Kotlin
1,285
star
24

idea-gitignore

.ignore support plugin for IntelliJ IDEA
Kotlin
1,281
star
25

projector-server

Server-side library for running Swing applications remotely
Kotlin
1,224
star
26

resharper-unity

Unity support for both ReSharper and Rider
C#
1,195
star
27

intellij-sdk-docs

IntelliJ SDK Platform Documentation
Markdown
1,175
star
28

xodus

Transactional schema-less embedded database used by JetBrains YouTrack and JetBrains Hub.
Java
1,155
star
29

intellij-scala

Scala plugin for IntelliJ IDEA
Scala
1,137
star
30

kotless

Kotlin Serverless Framework
Kotlin
1,124
star
31

JetBrainsRuntime

Runtime environment based on OpenJDK for running IntelliJ Platform-based products on Windows, macOS, and Linux
Java
1,095
star
32

intellij-sdk-code-samples

Mirror of the IntelliJ SDK Docs Code Samples
Java
960
star
33

js-graphql-intellij-plugin

GraphQL language support for WebStorm, IntelliJ IDEA and other IDEs based on the IntelliJ Platform.
Java
875
star
34

android

Android Plugin for IntelliJ IDEA. This repository is a subset of https://git.jetbrains.org/?p=idea/android.git cut according to GitHub file size limitations.
Kotlin
863
star
35

projector-client

Common and client-related code for running Swing applications remotely
Kotlin
813
star
36

projector-installer

Install, configure and run JetBrains IDEs with Projector Server on Linux or in WSL
Python
809
star
37

Grammar-Kit

Grammar files support & parser/PSI generation for IntelliJ IDEA
Java
677
star
38

Arend

The Arend Proof Assistant
Java
676
star
39

jediterm

Pure Java Terminal Emulator. Works with SSH and PTY.
Java
611
star
40

compose-multiplatform-template

Compose Multiplatform Application project template
Kotlin
603
star
41

markdown

Markdown parser written in kotlin
Kotlin
590
star
42

amper

Amper - a build and project configuration tool with a focus on the user experience and the IDE support
Kotlin
588
star
43

jewel

An implementation of the IntelliJ look and feels in Compose for Desktop
Kotlin
556
star
44

Nitra

Public Nitra repository
Nemerle
549
star
45

lincheck

Framework for testing concurrent data structures
Kotlin
518
star
46

intellij-micropython

Plugin for MicroPython devices in PyCharm and IntelliJ
Python
475
star
47

kotlin-playground

Self-contained component to embed in websites for running Kotlin code
JavaScript
422
star
48

colorSchemeTool

Python
396
star
49

lets-plot-kotlin

Grammar of Graphics for Kotlin
Kotlin
389
star
50

Qodana

๐Ÿ“ Source repository of Qodana Help
389
star
51

rd

Reactive Distributed communication framework for .NET, Kotlin, C++. Inspired by Rider IDE.
C#
370
star
52

java-annotations

Annotations for JVM-based languages.
Java
362
star
53

compose-multiplatform-desktop-template

Compose Multiplatform Desktop Application project template
Kotlin
360
star
54

phpstorm-attributes

PhpStorm specific attributes
PHP
357
star
55

Unity3dRider

Unity JetBrains Rider integration
348
star
56

pty4j

Pty for Java
Java
335
star
57

godot-support

C#
315
star
58

phpstorm-workshop

Code for the PhpStorm workshop
PHP
287
star
59

awesome-pycharm

A curated list of resources for learning and using PyCharm, a Python IDE from JetBrains
271
star
60

web-types

JSON standard for documenting web component libraries for IDEs, documentation generators and other tools
TypeScript
270
star
61

meta-runner-power-pack

A set of Meta-runners for TeamCity
PowerShell
256
star
62

inspection-plugin

Gradle plugin to launch IDEA inspections
Kotlin
255
star
63

youtrack-mobile

A iOS and Android client for YouTrack
TypeScript
254
star
64

ideolog

Interactive viewer for '.log' files.
Kotlin
248
star
65

gradle-changelog-plugin

Plugin for parsing and managing the Changelog in a "keep a changelog" style.
Kotlin
247
star
66

qodana-action

โš™๏ธ Scan your Go, Java, Kotlin, PHP, Python, JavaScript, TypeScript, .NET projects at GitHub with Qodana. This repository contains Qodana for Azure, GitHub, CircleCI and Gradle
JavaScript
234
star
67

gradle-idea-ext-plugin

Plugin to store IJ settings in gradle script
Groovy
226
star
68

php-timeline

Notable events of PHP history
223
star
69

resharper-rider-samples

Simple interactive exercises to help learn ReSharper and Rider
C#
221
star
70

la-clojure

Clojure plugin for IntelliJ IDEA
Java
220
star
71

kotlin-compiler-server

Server for executing kotlin code
Kotlin
211
star
72

jdk8u_jdk

Java
209
star
73

jcef

A simple framework for embedding Chromium-based browsers into Java-based applications.
Java
206
star
74

pest-intellij

The official Pest Plugin for PhpStorm / IntelliJ IDEA
Kotlin
195
star
75

youtrack-workflows

YouTrack Custom Workflow Repository
JavaScript
194
star
76

psiviewer

PSI Viewer for IntelliJ IDEA plugin development
Java
175
star
77

svg-mixer

Node.js toolset for generating & transforming SVG images and sprites in modern way
JavaScript
173
star
78

compose-for-web-demos

Historical repository of early Compose for Web effort.
171
star
79

phpstorm-docker-images

Pre-configured Docker images used by PhpStorm team
Dockerfile
170
star
80

jetbrains_guide

JetBrains Guides where Developer Advocacy and the community share ideas.
CSS
168
star
81

kotlin-web-demo

Online mini-IDE for Kotlin
Kotlin
168
star
82

rider-efcore

Entity Framework Core UI plugin for JetBrains Rider
Kotlin
167
star
83

intellij-samples

Code that demonstrates various IntelliJ IDEA features
Java
164
star
84

intellij-plugin-verifier

Compatibility verification tool for IntelliJ Platform plugins
Kotlin
163
star
85

jdk8u_hotspot

C++
159
star
86

resharper-rider-plugin

https://www.jetbrains.com/help/resharper/sdk/
PowerShell
156
star
87

qodana-cli

๐Ÿ”ง JetBrains Qodanaโ€™s official command line tool
Go
154
star
88

teamcity-messages

Python Unit Test Reporting to TeamCity
Python
139
star
89

ruby-type-inference

Dynamic definitions and types provider for ruby static analysis
Kotlin
136
star
90

resharper-angularjs

ReSharper plugin for AngularJS support
JavaScript
134
star
91

golandtipsandtricks

This is an ever evolving repository for GoLand Tips&Tricks
Go
132
star
92

python-skeletons

The python-skeltons repo is deprecated: use PEP 484 and Typeshed instead
Python
132
star
93

educational-plugin

Educational plugin to learn and teach programming languages such as Kotlin, Java, Python, JavaScript, and others right inside of JetBrains IntelliJ Platform based IDEs.
Kotlin
131
star
94

phpstorm-phpstan-plugin

PHPStan plugin for PhpStorm
Java
131
star
95

clion-wsl

Shell
130
star
96

clion-remote

129
star
97

teamcity-docker-samples

TeamCity docker compose samples
Shell
128
star
98

phpstorm-psalm-plugin

Psalm plugin for PhpStorm
Java
126
star
99

jdk8u

Shell
123
star
100

YouTrackSharp

.NET Standard 2.0 Library to access YouTrack API.
C#
123
star