Skip to content

Documentation for using IntelliJ and Metals #11535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 10, 2021
Merged

Documentation for using IntelliJ and Metals #11535

merged 3 commits into from
Mar 10, 2021

Conversation

lrytz
Copy link
Member

@lrytz lrytz commented Feb 25, 2021

and two small fixes for the bsp export of the dotty project

@lrytz
Copy link
Member Author

lrytz commented Feb 25, 2021

I personally think the bloop plugin should not be added to the build since not everyone is going to use it, so I would drop the last commit. I left it for discussion.

@sjrd
Copy link
Member

sjrd commented Feb 25, 2021

I personally think the bloop plugin should not be added to the build since not everyone is going to use it, so I would drop the last commit. I left it for discussion.

We use the following beauty in Scala.js to set bloopGenerate without depending on sbt-bloop:
https://github.com/scala-js/scala-js/blob/46d094daa1576969fdd4948bf7a7571d9db1b156/project/NoIDEExport.scala

Copy link
Member

@adpi2 adpi2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lrytz for pushing this! Now that we have Scala 3 support in Metals and IntelliJ, it's good to use them in the dotty repo.

I've made a few minor suggestions, but otherwise it LGTM.

Co-authored-by: Adrien Piquerez <[email protected]>
@lrytz
Copy link
Member Author

lrytz commented Mar 2, 2021

Thanks @adpi2, added your suggestions.

@adpi2 adpi2 merged commit 8f5e088 into scala:master Mar 10, 2021
In order to import a project into IntelliJ there are two possibilities:
- Use the built-in feature to import sbt builds
- Use IntelliJ's support for the
[Build Server Protocol (BSP)](https://www.jetbrains.com/help/idea/bsp-support.html)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@romanowski the bullet list is not rendered (https://dotty.epfl.ch/docs/usage/ide-support.html) - is that expected? Would be great if the rendering in scaladoc was the same as the preview on GitHub.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that this is a bug in Flexmark, empty line above is needed to render it properly. PR with fix is here: #11701

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Worth a report at flexmark? I understand the situation about markdown standards and specifications is complicated, but...

https://github.com/vsch/flexmark-java#markdown-processor-emulation

flexmark is by default commonmark compliant

https://spec.commonmark.org/0.29/#example-273

no blank line is needed to separate a paragraph from a following list

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It needs a bit more investigation on our side to make sure that Felexmark is to blame, @BarkingBad should take a look soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants