Scala support #399

SCdF · 2021-12-17T16:28:08Z

Basic Scala support. Tested with Scala 2.x syntax, idk enough about 3.x to know how it fares.

Relies on: cursorless-dev/vscode-parse-tree#16

SCdF · 2021-12-17T16:28:43Z

(putting this out there so people know it's happening, also because I can't run tests locally in WSL so this gives me CI)

src/test/suite/fixtures/recorded/languages/scala/takeClass.yml

src/languages/scala.ts

SCdF · 2021-12-21T11:38:00Z

Also @pokey I'm guessing the tests are failing ("do not support plaintext") is because the version of vscode-parse-tree that's out there doesn't yet support scala?

listing out every place where code has to change to add a new language

pokey

Really good stuff! Left some inline comments. Also, it would be great to see the following tests:

Tests for "type" where the mark is not in the type itself. I don't know scala enough to say what situations would be comprehensive, but here are a couple that jump out at me:
- Have the mark in the value / body of a function and say "clear type" to see that it clears the return type of the function
- Have the mark in the name of a function call argument and say "clear type" to see that it clears the type of the function call argument
Similarly, tests for "value" where the mark is not in the value itself, eg it's in the name / type of the argument or assignment
A check for "condition" where the mark is not in the condition itself
"take round" with a document like so: "(hello)", and cursor in the middle of hello to check that the text fragment extractor is working

src/languages/scala.ts

pokey · 2021-12-23T16:32:23Z

src/languages/scala.ts

+  // Pulled from the complete list that isn't implemented above
+
+  // collectionItem: "???"
+  // collectionKey: "???",


Don't you want to support "AL" -> "Alabama" expressions? For these, "key" would be "AL", "value" would be "Alabama", and "item" would be the pair.

collectionItem is also supposed to include list elements, tho since those are just function calls you would basically use an argument matcher and check that the parent is a List. For fancy stuff like this, you might check out the Clojure implementation. That one took tons of custom matchers to get working

I think I'd have to write something custom for that: ("AL" -> "Alabama") comes out as:

arguments: (arguments [1, 19] - [1, 38] (infix_expression [1, 20] - [1, 37] left: (string [1, 20] - [1, 24]) operator: (operator_identifier [1, 25] - [1, 27]) right: (string [1, 28] - [1, 37]))))))))

So I'd need to take the left or right of an operator, when that operator === '->'

Yeah that looks like it should be doable, but a bit custom. I think I'd be ok with shipping without it for now but filing an issue to capture all the missing things. I believe cursorless will generate a helpful message so that users can just see it hasn't been implemented yet

btw I'd capture your example here into the follow-up issue for remaining scala features; it's quite helpful

pokey · 2021-12-23T16:32:49Z

src/languages/scala.ts

+  // regularExpression: "???",
+
+  // attribute: "???",
+  // xmlElement: "???",


Doesn't scala support inline html elements?

It does (well, XML), but it's deprecated and will be dropped in 3.x, to be replaced with string formatting (I think, I don't know much about 3.x). I'm not sure how much people use it. The tree sitter implemention also errors with it.

src/test/suite/fixtures/recorded/languages/scala/chuckTypeLook.yml

src/test/suite/fixtures/recorded/languages/scala/chuckTypeRed.yml

src/test/suite/fixtures/recorded/languages/scala/chuckTypeRed2.yml

src/test/suite/fixtures/recorded/languages/scala/chuckTypeSun2.yml

docs/contributing/adding-a-new-language.md

src/test/runTest.ts

Testing when the mark is on the name of the value.

For marks which aren't the condition itself

SCdF · 2022-01-06T14:30:37Z

On types, given:

class Example(foo: String) {
  def str(bar: String): String = foo + bar
}

We get:

(compilation_unit [0, 0] - [3, 0]
  (class_definition [0, 0] - [2, 1]
    name: (identifier [0, 6] - [0, 13])
    class_parameters: (class_parameters [0, 13] - [0, 26]
      (class_parameter [0, 14] - [0, 25]
        name: (identifier [0, 14] - [0, 17])
        type: (type_identifier [0, 19] - [0, 25])))
    body: (template_body [0, 27] - [2, 1]
      (function_definition [1, 2] - [1, 42]
        name: (identifier [1, 6] - [1, 9])
        parameters: (parameters [1, 9] - [1, 22]
          (parameter [1, 10] - [1, 21]
            name: (identifier [1, 10] - [1, 13])
            type: (type_identifier [1, 15] - [1, 21])))
        return_type: (type_identifier [1, 24] - [1, 30])
        body: (infix_expression [1, 33] - [1, 42]
          left: (identifier [1, 33] - [1, 36])
          operator: (operator_identifier [1, 37] - [1, 38])
          right: (identifier [1, 39] - [1, 42]))))))

From what you're saying it looks like we want to walk up the tree to find a sibling type, and take the parent. For example, if your cursor was in class_parameter.name (foo) and you said "take type" it should find class_parameter.type (String) and then match class_parameter (foo: String)?

How would I write this? And how would I merge this with the leading matcher I'm already using that I obviously do not want to use in this case.

SCdF · 2022-01-06T14:30:44Z

On "take round", this does not work ("TypeError: Cannot read property 'endPosition' of undefined"). Any hints as to how to fix this?

SCdF · 2022-01-06T14:31:07Z

(value and condition work fine, and I added tests)

pokey · 2022-01-06T14:35:40Z

On types, given:
class Example(foo: String) {
  def str(bar: String): String = foo + bar
}
We get:
(compilation_unit [0, 0] - [3, 0]
  (class_definition [0, 0] - [2, 1]
    name: (identifier [0, 6] - [0, 13])
    class_parameters: (class_parameters [0, 13] - [0, 26]
      (class_parameter [0, 14] - [0, 25]
        name: (identifier [0, 14] - [0, 17])
        type: (type_identifier [0, 19] - [0, 25])))
    body: (template_body [0, 27] - [2, 1]
      (function_definition [1, 2] - [1, 42]
        name: (identifier [1, 6] - [1, 9])
        parameters: (parameters [1, 9] - [1, 22]
          (parameter [1, 10] - [1, 21]
            name: (identifier [1, 10] - [1, 13])
            type: (type_identifier [1, 15] - [1, 21])))
        return_type: (type_identifier [1, 24] - [1, 30])
        body: (infix_expression [1, 33] - [1, 42]
          left: (identifier [1, 33] - [1, 36])
          operator: (operator_identifier [1, 37] - [1, 38])
          right: (identifier [1, 39] - [1, 42]))))))
From what you're saying it looks like we want to walk up the tree to find a sibling type, and take the parent. For example, if your cursor was in class_parameter.name (foo) and you said "take type" it should find class_parameter.type (String) and then match class_parameter (foo: String)?

How would I write this? And how would I merge this with the leading matcher I'm already using that I obviously do not want to use in this case.

Pretty sure you can just define a pattern matcher "*[type]"

pokey · 2022-01-06T14:36:32Z

On "take round", this does not work ("TypeError: Cannot read property 'endPosition' of undefined"). Any hints as to how to fix this?

Yeah probably scala isn't creating child nodes for quotes. I'd try to steal Java's text fragment extractor

You can now grab types when the mark is not in the type itself

SCdF · 2022-01-06T15:21:16Z

OK I added code / tests for types, and used the hacked text fragment extractor and it looks to work correctly

I'm not sure we can ever truly detect these. At least in the current tree sitter implementation they are eg just infix expressions, just like lots of other things

src/languages/scala.ts

For when the mark is not directly on the type

SCdF · 2022-01-08T15:17:17Z

Raised #434 to talk about / track pattern matching

pokey

This looks great! 👏👏

src/languages/scala.ts

pokey · 2022-01-08T15:09:13Z

src/languages/scala.ts

+  // Cursorless terminology not yet supported in this Scala implementation
+  /*
+    lists and maps basic definition are just function calls to constructors, eg List(1,2,3,4)
+    These types are also basically arbitrary, so we can't really hard-code them


Why can't we hard-code them? Not saying you need to do it in this PR, but this comment implies that we can't do it, whereas I thought we were just punting

They are just classes, not a syntax / language construct like [] in JS or whatever. Scala comes with a bunch of them but people will also use other random libraries as well.

Interesting. Almost feels like we need LSP support for this one? Let's just call it out in the missing language features issue and discuss there

pokey · 2022-01-08T15:09:54Z

src/languages/scala.ts

+  // Pulled from the complete list that isn't implemented above
+
+  // collectionItem: "???"
+  // collectionKey: "???",


btw I'd capture your example here into the follow-up issue for remaining scala features; it's quite helpful

…o scala

scala support: initial commit

c329560

className should work here

26ac29c

pokey reviewed Dec 17, 2021

View reviewed changes

src/test/suite/fixtures/recorded/languages/scala/takeClass.yml Outdated Show resolved Hide resolved

SCdF added 4 commits December 17, 2021 17:03

class, className, ifStatement, string, comment

08b602d

Merge branch 'main' into scala

f24eb6c

very basic list and call support

d83fcdf

class changes to support traits and test case classes

4d580a8

pokey reviewed Dec 21, 2021

View reviewed changes

src/languages/scala.ts Outdated Show resolved Hide resolved

(some) lambdas, maps, interpolated strings

04ae183

SCdF added 8 commits December 21, 2021 12:37

argument and parameter support

7b9d03e

names, functions and function names

c3bf94a

basic types (no generic specific work yet)

22b9d50

basic value support

2ae25db

conditions

8f032d5

cleaning up temp work

c738eee

doc changes

6c99cca

listing out every place where code has to change to add a new language

adding fn names

54b59fa

SCdF marked this pull request as ready for review December 21, 2021 14:46

SCdF and others added 3 commits December 21, 2021 14:57

Merge remote-tracking branch 'upstream/main' into scala

12e69bf

Fix scala language id missing

b56c559

Merge branch 'main' into scala

0bfcfc1

pokey reviewed Dec 23, 2021

View reviewed changes

src/test/runTest.ts Show resolved Hide resolved

SCdF added 2 commits January 6, 2022 14:21

more matching values tests

5f6f9ce

Testing when the mark is on the name of the value.

More condition tests

065d064

For marks which aren't the condition itself

SCdF added 2 commits January 6, 2022 15:12

Dropping list and map, improving types

f4b8b8c

You can now grab types when the mark is not in the type itself

paired delimiters

db2f0b6

Dropping comment about partial functions

4fa8085

I'm not sure we can ever truly detect these. At least in the current tree sitter implementation they are eg just infix expressions, just like lots of other things

pokey reviewed Jan 6, 2022

View reviewed changes

src/languages/scala.ts Outdated Show resolved Hide resolved

SCdF and others added 5 commits January 7, 2022 15:54

cleaning up types

f47a418

More type tests

3dee158

For when the mark is not directly on the type

Fixing up types

491dff6

cleaned up notes

7df7ac5

Merge branch 'main' into scala

f35bfb8

pokey approved these changes Jan 8, 2022

View reviewed changes

SCdF added 2 commits January 8, 2022 16:25

clarifying our type matching strategy

8ac2acb

Merge branch 'scala' of https://github.com/SCdF/cursorless-vscode int…

f83f8ea

…o scala

pokey approved these changes Jan 8, 2022

View reviewed changes

Merge branch 'main' into scala

1f53671

pokey merged commit 8e7f101 into cursorless-dev:main Jan 8, 2022

pokey mentioned this pull request Jan 9, 2022

Advanced Scala support #437

Open

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scala support #399

Scala support #399

SCdF commented Dec 17, 2021 •

edited

Loading

SCdF commented Dec 17, 2021

SCdF commented Dec 21, 2021

pokey left a comment •

edited

Loading

pokey Dec 23, 2021

SCdF Jan 6, 2022

pokey Jan 6, 2022

pokey Jan 8, 2022

pokey Dec 23, 2021

SCdF Jan 6, 2022

SCdF commented Jan 6, 2022

SCdF commented Jan 6, 2022

SCdF commented Jan 6, 2022

pokey commented Jan 6, 2022

pokey commented Jan 6, 2022

SCdF commented Jan 6, 2022

SCdF commented Jan 8, 2022

pokey left a comment

pokey Jan 8, 2022

SCdF Jan 8, 2022

pokey Jan 8, 2022

pokey Jan 8, 2022

Scala support #399

Scala support #399

Conversation

SCdF commented Dec 17, 2021 • edited Loading

SCdF commented Dec 17, 2021

SCdF commented Dec 21, 2021

pokey left a comment • edited Loading

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

Choose a reason for hiding this comment

SCdF commented Jan 6, 2022

SCdF commented Jan 6, 2022

SCdF commented Jan 6, 2022

pokey commented Jan 6, 2022

pokey commented Jan 6, 2022

SCdF commented Jan 6, 2022

SCdF commented Jan 8, 2022

pokey left a 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

SCdF commented Dec 17, 2021 •

edited

Loading

pokey left a comment •

edited

Loading