CARGO: Annotate basic docs in cargo.toml #1793

farodin91 · 2017-09-28T19:54:09Z

Fixes #1776
@matklad Any idea to fix the problem with the test?

matklad · 2017-09-29T14:42:52Z

src/main/resources/META-INF/plugin.xml

@@ -20,9 +20,10 @@
    <!-- please see https://confluence.jetbrains.com/display/IDEADEV/Plugin+Compatibility+with+IntelliJ+Platform+Products
         on how to target different products -->

-    <depends>com.intellij.modules.lang</depends>


Hm, I believe this is a required dependency?

I have no idea

matklad · 2017-09-29T14:42:59Z

src/main/resources/META-INF/plugin.xml

    <depends optional="true" config-file="idea-only.xml">com.intellij.modules.java</depends>
    <depends optional="true" config-file="clion-only.xml">com.intellij.modules.clion</depends>
+    <depends optional="true" config-file="clion-only.xml">com.intellij.modules.clion</depends>


Duplicated line?

matklad · 2017-09-29T14:47:11Z

Not sure what's up with tests, restarted the build.

kumbayo · 2017-09-29T15:08:15Z

build.gradle.kts

@@ -13,6 +13,7 @@ import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 buildscript {
    repositories {
        maven { setUrl("https://jitpack.io") }
+        maven { setUrl("http://dl.bintray.com/jetbrains/intellij-plugin-service") }


Is it possible to use https for this repository?

farodin91 · 2017-09-30T21:45:56Z

local error if i run the test

ERROR: Problems found loading plugins:<p/>Plugin "Rust" was not loaded: required plugin "org.toml.lang" not installed.<p/><br><a href="disable">Disable Rust</a><p/><a href="edit">Open plugin manager</a>
java.lang.Throwable
	at com.intellij.openapi.diagnostic.Logger.error(Logger.java:132)
	at com.intellij.ide.plugins.PluginManagerCore.prepareLoadingPluginsErrorMessage(PluginManagerCore.java:556)
	at com.intellij.ide.plugins.PluginManagerCore.initializePlugins(PluginManagerCore.java:1202)
	at com.intellij.ide.plugins.PluginManagerCore.initPlugins(PluginManagerCore.java:1362)
	at com.intellij.ide.plugins.PluginManagerCore.getPlugins(PluginManagerCore.java:122)
	at com.intellij.ide.plugins.PluginManagerCore.getPlugins(PluginManagerCore.java:116)
	at com.intellij.idea.IdeaApplication.getStarter(IdeaApplication.java:188)
	at com.intellij.idea.IdeaApplication.<init>(IdeaApplication.java:114)
	at com.intellij.openapi.application.impl.ApplicationImpl.<init>(ApplicationImpl.java:218)
	at com.intellij.openapi.application.ex.ApplicationManagerEx.createApplication(ApplicationManagerEx.java:45)
	at com.intellij.idea.CommandLineApplication.<init>(CommandLineApplication.java:45)
	at com.intellij.idea.CommandLineApplication.<init>(CommandLineApplication.java:38)
	at com.intellij.idea.IdeaTestApplication.<init>(IdeaTestApplication.java:32)
	at com.intellij.idea.IdeaTestApplication.getInstance(IdeaTestApplication.java:52)
	at com.intellij.idea.IdeaTestApplication.getInstance(IdeaTestApplication.java:46)
	at com.intellij.testFramework.LightPlatformTestCase.initApplication(LightPlatformTestCase.java:167)
	at com.intellij.testFramework.fixtures.impl.LightIdeaTestFixtureImpl.setUp(LightIdeaTestFixtureImpl.java:48)
	at com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.lambda$setUp$13(CodeInsightTestFixtureImpl.java:1157)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:27)
	at com.intellij.testFramework.EdtTestUtilKt.runInEdtAndWait(EdtTestUtil.kt:58)
	at com.intellij.testFramework.EdtTestUtil$Companion.runInEdtAndWait(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil.runInEdtAndWait(EdtTestUtil.kt)
	at com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.setUp(CodeInsightTestFixtureImpl.java:1156)
	at com.intellij.testFramework.fixtures.LightPlatformCodeInsightFixtureTestCase.setUp(LightPlatformCodeInsightFixtureTestCase.java:57)
	at com.intellij.testFramework.UsefulTestCase.defaultRunBare(UsefulTestCase.java:353)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:27)
	at com.intellij.testFramework.EdtTestUtilKt$runInEdtAndWait$2.run(EdtTestUtil.kt:62)
	at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:301)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:756)
	at java.awt.EventQueue.access$500(EventQueue.java:97)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.awt.EventQueue$3.run(EventQueue.java:703)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:80)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:726)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:345)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:201)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)

java.lang.AssertionError: Problems found loading plugins:<p/>Plugin "Rust" was not loaded: required plugin "org.toml.lang" not installed.<p/><br><a href="disable">Disable Rust</a><p/><a href="edit">Open plugin manager</a>

	at com.intellij.testFramework.LoggedErrorProcessor.processError(LoggedErrorProcessor.java:61)
	at com.intellij.testFramework.TestLogger.error(TestLogger.java:40)
	at com.intellij.openapi.diagnostic.Logger.error(Logger.java:132)
	at com.intellij.ide.plugins.PluginManagerCore.prepareLoadingPluginsErrorMessage(PluginManagerCore.java:556)
	at com.intellij.ide.plugins.PluginManagerCore.initializePlugins(PluginManagerCore.java:1202)
	at com.intellij.ide.plugins.PluginManagerCore.initPlugins(PluginManagerCore.java:1362)
	at com.intellij.ide.plugins.PluginManagerCore.getPlugins(PluginManagerCore.java:122)
	at com.intellij.ide.plugins.PluginManagerCore.getPlugins(PluginManagerCore.java:116)
	at com.intellij.idea.IdeaApplication.getStarter(IdeaApplication.java:188)
	at com.intellij.idea.IdeaApplication.<init>(IdeaApplication.java:114)
	at com.intellij.openapi.application.impl.ApplicationImpl.<init>(ApplicationImpl.java:218)
	at com.intellij.openapi.application.ex.ApplicationManagerEx.createApplication(ApplicationManagerEx.java:45)
	at com.intellij.idea.CommandLineApplication.<init>(CommandLineApplication.java:45)
	at com.intellij.idea.CommandLineApplication.<init>(CommandLineApplication.java:38)
	at com.intellij.idea.IdeaTestApplication.<init>(IdeaTestApplication.java:32)
	at com.intellij.idea.IdeaTestApplication.getInstance(IdeaTestApplication.java:52)
	at com.intellij.idea.IdeaTestApplication.getInstance(IdeaTestApplication.java:46)
	at com.intellij.testFramework.LightPlatformTestCase.initApplication(LightPlatformTestCase.java:167)
	at com.intellij.testFramework.fixtures.impl.LightIdeaTestFixtureImpl.setUp(LightIdeaTestFixtureImpl.java:48)
	at com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.lambda$setUp$13(CodeInsightTestFixtureImpl.java:1157)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:27)
	at com.intellij.testFramework.EdtTestUtilKt.runInEdtAndWait(EdtTestUtil.kt:58)
	at com.intellij.testFramework.EdtTestUtil$Companion.runInEdtAndWait(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil.runInEdtAndWait(EdtTestUtil.kt)
	at com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.setUp(CodeInsightTestFixtureImpl.java:1156)
	at com.intellij.testFramework.fixtures.LightPlatformCodeInsightFixtureTestCase.setUp(LightPlatformCodeInsightFixtureTestCase.java:57)
	at com.intellij.testFramework.UsefulTestCase.defaultRunBare(UsefulTestCase.java:353)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:29)
	at com.intellij.testFramework.EdtTestUtil$Companion$runInEdtAndWait$1.invoke(EdtTestUtil.kt:27)
	at com.intellij.testFramework.EdtTestUtilKt$runInEdtAndWait$2.run(EdtTestUtil.kt:62)
	at java.awt.event.InvocationEvent.dispatch(InvocationEvent.java:301)
	at java.awt.EventQueue.dispatchEventImpl(EventQueue.java:756)
	at java.awt.EventQueue.access$500(EventQueue.java:97)
	at java.awt.EventQueue$3.run(EventQueue.java:709)
	at java.awt.EventQueue$3.run(EventQueue.java:703)
	at java.security.AccessController.doPrivileged(Native Method)
	at java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(ProtectionDomain.java:80)
	at java.awt.EventQueue.dispatchEvent(EventQueue.java:726)
	at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:345)
	at java.awt.EventDispatchThread.pumpOneEventForFilters(EventDispatchThread.java:201)
	at java.awt.EventDispatchThread.pumpEventsForFilter(EventDispatchThread.java:116)
	at java.awt.EventDispatchThread.pumpEventsForHierarchy(EventDispatchThread.java:105)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:101)
	at java.awt.EventDispatchThread.pumpEvents(EventDispatchThread.java:93)
	at java.awt.EventDispatchThread.run(EventDispatchThread.java:82)
Caused by: java.lang.Throwable
	... 44 more


Process finished with exit code 255

matklad · 2017-10-01T13:59:03Z

build.gradle.kts

-    intellij { pluginName = "intellij-rust" }
+    intellij {
+        pluginName = "intellij-rust"
+        setPlugins("org.toml.lang:0.0.1.1759")


I think we should specify a path to Gradle subproject here, like project(':toml').

farodin91 · 2017-10-02T09:48:12Z

Changed, but this i didn't fix my problem.

matklad · 2017-10-02T15:12:34Z

@farodin91 looking into this, and I don't know what's going on here :( I think I had a similar (closed source) project with exactly this setup, and it did work there...

farodin91 · 2017-10-09T07:20:32Z

@matklad Any suggestions?

matklad · 2017-10-09T15:25:20Z

@farodin91 I think I've found a bug in intellij gradle plugin, will try to fix it soon.

matklad · 2017-10-09T16:01:30Z

The workaround to change :toml project name to :intellij-toml in settings.gralde and build.kts:

// settings.gradle
project(":toml").name = "intellij-toml"

// buil.dtks
project(":intelij-toml")

farodin91 · 2017-10-09T16:44:56Z

This breaks all for me.

farodin91 · 2017-10-09T17:18:30Z

All Toml types are unresolved

farodin91 · 2017-10-09T17:21:32Z

Found I copied with look into the code. ;)

farodin91 · 2017-10-09T17:26:06Z

Resolved

matklad · 2017-10-09T21:56:24Z

The fix for the gradle plugin: JetBrains/intellij-platform-gradle-plugin#238

farodin91 · 2017-10-10T09:25:47Z

@matklad merge conflicts fixed

farodin91 · 2017-10-19T09:48:25Z

@matklad Merge conflicts are fixed.

matklad · 2017-10-19T12:47:40Z

Looking good @farodin91

The gradle plugin is not released yet, but I think we can use snapshot versions for some time.

One thing I would like to do here though is to change <depends>org.toml.lang</depends> to <depends optional="true" config-file="with-toml-plugin.xml">org.toml.lang</depends>, so that the Rust plugin is able to function without TOML plugin installed. And perhaps we should create an org.rust.toml package for all code that depends on the TOML plugin.

farodin91 · 2017-10-19T16:37:15Z

@matklad fixed

farodin91 · 2017-10-24T11:24:40Z

@maklad resolved latest merge conflict

matklad · 2017-10-24T11:34:01Z

@farodin91 What about making dependency on the TOML plugin optional? #1793 (comment)

farodin91 · 2017-10-24T11:38:35Z

I rebased the false commit.

farodin91 · 2017-10-30T10:45:20Z

@matklad should I move this to linemarkers

matklad · 2017-11-03T14:42:55Z

@farodin91 I think this should all be moved to a top-level cargoToml package, like org.rust.cargoToml.

I am also still a bit uneasy about depending on the TOML plugin API, as they are not great at the moment, and changing them later will result in class cast exceptions. I'll try to make TOML APIs more stable.

matklad · 2017-11-03T18:05:28Z

Branch with a (hopefully :) ) better TOML plugin: https://github.com/intellij-rust/intellij-rust/tree/toml

farodin91 · 2017-11-04T10:17:18Z

@matklad Will wait until your PR is merged.

farodin91 · 2017-11-21T16:34:12Z

@matklad I try to fix all problems.

farodin91 · 2017-11-21T21:39:06Z

@matklad Inlinetable is longer a TomlValue

matklad · 2017-11-22T16:14:52Z

@matklad Inlinetable is longer a TomlValue

Ouch, that's a blunder from my side!

Fixed in: #2057.

Will make a toml plugin release later today.

matklad · 2017-11-23T07:46:35Z

The toml plugin is released and the dependency is updated.

farodin91 · 2017-11-24T11:03:04Z

@matklad You changed the build.gradle.kts but intellij is trying to use toml in versio 0.2.0.8 not 0.2.0.9

matklad · 2017-11-24T11:18:34Z

@matklad You changed the build.gradle.kts but intellij is trying to use toml in versio 0.2.0.8 not 0.2.0.9

Probably some issues with caches. Deleting ./build and ./deps may fix the issue.

farodin91 · 2017-11-24T14:47:42Z

@matklad Do you like to review?

matklad · 2017-11-24T14:50:42Z

src/main/kotlin/org/rust/toml/CargoCrateDocLineMarkerProvider.kt

+class CargoCrateDocLineMarkerProvider : LineMarkerProvider {
+    override fun getLineMarkerInfo(element: PsiElement): LineMarkerInfo<PsiElement>? = null
+
+    override fun collectSlowLineMarkers(elements: MutableList<PsiElement>, result: MutableCollection<LineMarkerInfo<PsiElement>>) {


Let's add an ABI check here, the same way it is done in CargoTomlCompletionContributor?

I added the same. Is this okay?

matklad · 2017-11-24T14:52:12Z

src/test/kotlin/org/rust/toml/CargoCrateDocLineMarkerProviderTest.kt

+    fun `test no link to doc`() = doTestByText("""
+        [dependencies]
+        hello_utils = { path = "hello_utils" }
+    """)


👍 great tests!

farodin91 · 2017-11-27T09:48:02Z

@matklad I have no idea. Why nightly crashes?

matklad · 2017-11-27T11:22:46Z

@farodin91 I think it's

org.rust.toml.CargoCrateDocLineMarkerProviderTest > test standard build FAILED

java.lang.AssertionError: Performance warning: LineMarker is supposed to be registered for leaf elements only, but got: TomlKeyValue (class org.toml.lang.psi.impl.TomlKeyValueImpl) instead. First child: TomlKey (class org.toml.lang.psi.impl.TomlKeyImpl)

Please see LineMarkerProvider#getLineMarkerInfo(PsiElement) javadoc for detailed explanations.

See how other lines markers were fixed recently.

farodin91 · 2017-11-27T12:28:06Z

@matklad Resolved ? Do you like to review?

matklad · 2017-11-27T13:39:06Z

src/main/kotlin/org/rust/toml/CargoCrateDocLineMarkerProvider.kt

+
+    private fun genLineMarkerInfo(element: PsiElement, name: String, version: String?): LineMarkerInfo<PsiElement>? {
+        val version = version ?: return null
+        val anchor = PsiTreeUtil.getDeepestFirst(element)


Hm, it's super non-obvious what element is returned here... Could we be somehow more specific?

I change this to fix the problem with the leaf.

Is this okay?

I think it's better to anchor on the specific toml element, instead of using just PsiElement. So, we probably want to annotate TomlKey child with type BARE_KEY:

Most definitely!

Fixes intellij-rust#1776

matklad · 2017-12-07T08:40:24Z

@bors r+

Thanks!

Undin · 2017-12-07T08:46:58Z

bors r=matklad

@matklad

1793: CARGO: Annotate basic docs in cargo.toml r=matklad a=farodin91 Fixes #1776 @matklad Any idea to fix the problem with the test?

bors · 2017-12-07T09:00:45Z

Build succeeded

matklad reviewed Sep 29, 2017

View reviewed changes

kumbayo reviewed Sep 29, 2017

View reviewed changes

farodin91 force-pushed the cargo-toml-ref branch from 4460377 to 5bddfe0 Compare September 30, 2017 21:44

matklad reviewed Oct 1, 2017

View reviewed changes

farodin91 force-pushed the cargo-toml-ref branch from 5bddfe0 to e939fc6 Compare October 2, 2017 09:45

matklad self-assigned this Oct 2, 2017

farodin91 force-pushed the cargo-toml-ref branch from e939fc6 to c020efc Compare October 9, 2017 17:25

farodin91 force-pushed the cargo-toml-ref branch from d80c5b0 to 97639b0 Compare October 19, 2017 09:48

farodin91 force-pushed the cargo-toml-ref branch from 97639b0 to bc6eb3d Compare October 19, 2017 16:36

farodin91 force-pushed the cargo-toml-ref branch from bc6eb3d to acb4d00 Compare October 24, 2017 11:23

farodin91 force-pushed the cargo-toml-ref branch from acb4d00 to 36f2494 Compare October 24, 2017 11:41

farodin91 force-pushed the cargo-toml-ref branch from 36f2494 to e361c12 Compare November 21, 2017 21:47

farodin91 force-pushed the cargo-toml-ref branch from e361c12 to 51e60dd Compare November 24, 2017 14:47

matklad reviewed Nov 24, 2017

View reviewed changes

farodin91 force-pushed the cargo-toml-ref branch 2 times, most recently from 2a34892 to ba2ccba Compare November 27, 2017 08:51

farodin91 force-pushed the cargo-toml-ref branch from ba2ccba to 3951110 Compare November 27, 2017 11:43

matklad reviewed Nov 27, 2017

View reviewed changes

farodin91 force-pushed the cargo-toml-ref branch from 3951110 to 8a28e8b Compare December 4, 2017 21:25

CARGO: Annotate basic docs in cargo.toml

5c4dc21

Fixes intellij-rust#1776

farodin91 force-pushed the cargo-toml-ref branch from 8a28e8b to 5c4dc21 Compare December 6, 2017 21:24

bors bot added a commit that referenced this pull request Dec 7, 2017

Merge #1793

539660f

1793: CARGO: Annotate basic docs in cargo.toml r=matklad a=farodin91 Fixes #1776 @matklad Any idea to fix the problem with the test?

bors bot merged commit 5c4dc21 into intellij-rust:master Dec 7, 2017

farodin91 deleted the cargo-toml-ref branch April 2, 2018 15:11

CARGO: Annotate basic docs in cargo.toml #1793

CARGO: Annotate basic docs in cargo.toml #1793

Conversation

farodin91 commented Sep 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matklad commented Sep 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farodin91 commented Sep 30, 2017

Choose a reason for hiding this comment

farodin91 commented Oct 2, 2017

matklad commented Oct 2, 2017

farodin91 commented Oct 9, 2017

matklad commented Oct 9, 2017

matklad commented Oct 9, 2017

farodin91 commented Oct 9, 2017

farodin91 commented Oct 9, 2017

farodin91 commented Oct 9, 2017

farodin91 commented Oct 9, 2017

matklad commented Oct 9, 2017

farodin91 commented Oct 10, 2017 • edited Loading

farodin91 commented Oct 19, 2017

matklad commented Oct 19, 2017

farodin91 commented Oct 19, 2017

farodin91 commented Oct 24, 2017

matklad commented Oct 24, 2017

farodin91 commented Oct 24, 2017

farodin91 commented Oct 30, 2017

matklad commented Nov 3, 2017

matklad commented Nov 3, 2017

farodin91 commented Nov 4, 2017

farodin91 commented Nov 21, 2017

farodin91 commented Nov 21, 2017

matklad commented Nov 22, 2017

matklad commented Nov 23, 2017

farodin91 commented Nov 24, 2017

matklad commented Nov 24, 2017

farodin91 commented Nov 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farodin91 commented Nov 27, 2017

matklad commented Nov 27, 2017

farodin91 commented Nov 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matklad commented Dec 7, 2017

Undin commented Dec 7, 2017

bors bot commented Dec 7, 2017

Build succeeded

farodin91 commented Oct 10, 2017 •

edited

Loading