What if we did something like this ``` val getValOrVarKeywor

Question

What if we did something like this ``` val getValOrVarKeyword Scoped lt PsiElement gt = Scoped value getValOrVarKeyword ```

raulraja · Answer

The Scope already supports nullable KtElement The scope should never be nullable because when a property is null it should render as a empty string and that is control by the Scope toString override

raulraja · Answer

Scopes are a way to destructure a template and tell it based on the `toString` method how to render

amanda.hinchman-dominguez · Answer

attempted editing above ^

raulraja · Answer

Even if a class has no annotations has a ` annotationEntries` scope that when rendered produces an empty string This is necessary so people can compose their templates safely without having to check for `null` inside the templates which will be rather cumbersome since template expressions are hard to read when they spawn more than one line and nullable types chaining tends to nest whenever you want to do something complex

amanda.hinchman-dominguez · Answer

< bloder> ^

raulraja · Answer

< amanda hinchman dominguez> I don t understand in which context that code appears you mean to have a scope reference another scope

raulraja · Answer

that function is fine if you don t plan on destructuring `valOrKeyword` with a template but if you do you would use there instead the actual concrete scope that gives you template powers

amanda.hinchman-dominguez · Answer

Possibly for example in `KtParameter` we probably want to know of the `valOrVar`

raulraja · Answer

``` val getValOrVarKeyword ValOrKeywordScope = ValOrKeywordScope value getValOrVarKeyword ```

raulraja · Answer

where `ValOrKeywordScope Scope lt KtVarOrKeywordWhatever gt `

amanda.hinchman-dominguez · Answer

Do we want to do that within the scope of `ParameterScope`

raulraja · Answer

whenever we can talk about about a more ocmplete scope of an element we want to use the most concrete Scope

raulraja · Answer

for example if a function is ever mentioned we always want to use FuncScope

amanda.hinchman-dominguez · Answer

see this example here <https github com JetBrains kotlin blob master compiler psi src org jetbrains kotlin psi KtNullableType java>

raulraja · Answer

if we have a quote scope for a KtParameter instead of using `Scope lt KtParameter gt ` we always want to use `ParameterScope` which already extends `Scope lt KtParameter gt `

amanda.hinchman-dominguez · Answer

^so we have that

amanda.hinchman-dominguez · Answer

but we want to be able to expose its properties some of which are `PsiElements`

amanda.hinchman-dominguez · Answer

Ah imran mentioned we don t have a need for that <https github com arrow kt arrow meta pull 100 discussion r344760427>

amanda.hinchman-dominguez · Answer

So as the answer to our original question Do we need to map PsiElement attributes to Scopes Is the answer no

raulraja · Answer

the answer is no because the actual function that gets passed to the user in the quote has two valuable pieces of design

raulraja · Answer

1 The receiver in that function and `this` pointer is the actual scope so you can access the entire scope without a prefix 2 The function receives an argument of the `KtElement` type as `it` giving you full access to the entire PSI api of that element including traversal properties and everything you need

raulraja · Answer

That is my opinion I think the sole purpose of scopes is to provide template destructuring capabilities and all methods in their API should be related to rendering properties but not conditional logic or other type of operations that belong in the PSI and that we don t have to worry about maintaining

amanda.hinchman-dominguez · Answer

Okay that s super helpful because we was trying to figure out what all we need to be doing

raulraja · Answer

We are meeting on Wednesday on our first weekly stand up that < paco> is organizing where we will organize everyone s work and goals for each week

bloder · Answer

Could we continue with splitting this cases in scopes then like ``` val getValOrVarKeyword ValOrVarKeywordScope = ValOrVarKeywordScope value getValOrVarKeyword ```

bloder · Answer

in my opinion that makes sense

raulraja · Answer

Yes I think the rule of thumb is Whenever you find an inner element inside a KtElement that is worth a custom scope then create the scope for that and use the custom scope instead of a generic Scope lt KtElement gt then repeat recursively for all elements in the tree

raulraja · Answer

because that gives users the power to receive rich scopes that they can further expand to solve the problems as they dig down the tree

raulraja · Answer

There is an equivalence in what you are doing and the other side

amanda.hinchman-dominguez · Answer

It may make sense to reorganize some of this then if we ll be reusing custom scopes throughout

raulraja · Answer

Scope is `KtElment gt Rendering`

raulraja · Answer

Element Scope is `Rendering gt KtElement`

raulraja · Answer

Where rendering is sources as Strings

raulraja · Answer

there is a DSL in Element Scope that is the inverse of what you are doing

raulraja · Answer

and as you improve the scopes in the quote that DSL can be improved to return most concrete scopes for specialized types

raulraja · Answer

for example when you do ``` fun function ```

raulraja · Answer

you should get a `FuncScope` instead of `Scope lt KtNamedFunction gt `

raulraja · Answer

same goes for all the rest in that DSL as the quotes improve so should the counterpart to match the new created scopes that replace current generic representations

amanda.hinchman-dominguez · Answer

ohh okay I see what s happening there now the goal is to replace all that eventually

raulraja · Answer

raulraja · Answer

replace any Scope lt KtElement gt for a specialized Scope for that element that allows template destructuring

raulraja · Answer

in that file

raulraja · Answer

For example this one about KtParameter is outdated now

raulraja · Answer

bloder · Answer

nice for me that makes a lot of sense and I m actually doing exactly that to `KtLoopExpression` `KtForExpression` I ll send you the implementation later < amanda hinchman dominguez> to see if I m missing or misunderstanding something

amanda.hinchman-dominguez · Answer

hahaha same

amanda.hinchman-dominguez · Answer

I think we can create sort of a checklist template in PRs for these kinds of tickets