broxus / intellij-t-sol

Everscale-Solidity plugin for IntelliJ

T-Sol (Threaded Solidity) plugin for JetBrains IDEs

T-Sol (short for Threaded Solidity) JetBrains IDEs plugin is designed to make writing TVM-based smart contracts more comfortable and faster. It is based on Sergey Tselovalnikov's original Solidity plugin (kudos!) and features syntax prompts and autofilling while writing code. The plugin is also open-source and was released under the MIT license.

T-Sol proposes Threaded Solidity, the new name for TVM-based Solidity and works with files with the .tsol extension, making it easier to navigate between EVM and TVM smart contract files, which previously had the same .sol extension.

Features

• Syntax highlighting
• Code completion
• File templates
• Goto declaration
• Find usages
• Code formatting

Supporting the plugin

You can support the development by clicking ★ on GitHub and rating it on the plugin page.

Reporting an issue

Please attach the screenshot for every issue if possible. It will make the issue much clearer and easier to understand.

Build

./gradlew buildPlugin

Run

./gradlew runIdea

Contribute

Contributions are always welcome!

intellij-t-sol's Issues

not support assembly

// SPDX-License-Identifier: UNLICENSED
pragma ever-solidity >= 0.71.0;

function _add(uint a, uint b) assembly pure returns (uint) {
  "ADD",
}

contract App {
  function add(uint a, uint b) external pure returns (uint) {
    return _add(a, b);
  }
}

';', , , Identifier, externalMsg, functionID, inline, internalMsg, returns or '{' expected, got 'assembly'

Can not pass non-optional variable as optional param to function

https://github.com/tonlabs/TON-Solidity-Compiler/blob/master/API.md#optionaltype

Some function specifiers are not highlighted

Function specifiers inline, externalMsg, internalMsg are not highlighted (in fact highlighted as function modifier and it makes it very confusing)

Fix project structure visualization

Now it looks like this:

Expected:

Plugin disabling due to the fail of underlying `com.intellij.diagram` plugin

Issue

After a certain idle period IDE outputted the following error:

The restart of IDE caused intellij-t-sol plugin to disable as well.

Expected behavior

• Fixed interaction with diagram plugin to avoid its failures
• Fail of underlying plugins doesn't affect the work of intellij-t-sol one

Now returns uint256 instead of uint32

Imports suggestion should be shown

AST is broken when the line wasn't completed

Now if we want to have autosuggest we need to complete the current line with ;. If we didn't do this, we would have unexpected behavior such as this

And behavior with ;

Allow using integers with arbitrary bit size

Solidity ABI allows the use of integers with arbitrary bit width (up to 256 bits). However, the plugin doesn't seem to be able to recognize such integers as a built-in type. It would be nice to have all built-in types covered completely.

Add expression analyze

Need to inspect assign expressions and etc.

Lexer issue for mapping type inside decode function of TvmSlice

Problems with function input types resolving

import {DateTime as DateTimeLib} from "../../libraries/DateTime.tsol";

struct DateTime {
    uint16 year;
    uint8 month;
    uint8 day;
    uint8 hour;
    uint8 minute;
}

struct DateTimeInterval {
    DateTime from;
    DateTime to;
}

Contract A {
    function _dateTimeToTimestamp(DateTime dt) internal pure returns (uint32) {
        return uint32(DateTimeLib.timestampFromDateTime(dt.year, dt.month, dt.day, dt.hour, dt.minute, 0));
    }

   function _addMarketWeekends(DateTimeInterval _new_weekend) internal {
        uint32 _new_weekend_start = _dateTimeToTimestamp(_new_weekend.from);
        uint32 _new_weekend_end = _dateTimeToTimestamp(_new_weekend.to);
   }

I get Argument of type 'DateTime' is not assignable to parameter of type 'DateTime' when calling _dateTimeToTimestamp from _addMarketWeekends

Gray out unused items

Existing behavior

Any code piece, independent of whether it is being used or not, is displayed as active and used.

Expected behavior

Gray out unused imports, variables, structures, constants, functions, abstract contracts, interfaces, etc.

address.makeAddrStd() with inline args

address = address.makeAddrStd(0, 0);

Results in Argument of type 'uint8' is not assignable to parameter of type 'int8'
Which is ok for compiler, because 0 is constructed as int8 here (type is inherited from usage)

Standard functions valueToGas() and gasToValue() are marked as undefined

Here is the example:

Use inline code refactoring instead of popups

Current behavior

• User presses Shift+F6 on the desired word
• Popup appears showing refactoring options
  
• User inputs new name and clicks OK to finalize the refactoring

Expected behavior

• User presses Shift+F6 on the desired word
• IDE enters the dynamic refactoring mode and highlights the word and all its mentions in the code
• User changes the word and presses ENTER to finalize
  
• OR user presses ESC to cancel editing

We need to support refactoring fetures of IDE

1. When the file name going to rename we need to suggest changing the contract name
   
2. When the file was renamed or moved we need to update imports inside files that depend on this file

Types from tuple mismatch when passing them to function

'.', ';', <storage location> or global expected, got '('

'.', ';', <storage location> or global expected, got '('
<constant variable declaration>, <contract definition>, <expression>, <function definition>, <function invocation>, enum, error, import, pragma, struct, type or using expected, got ';'

Natspec comments starting from `/**` break syntax highlighting

Summary

When inputting comments in a block NatSpec (i.e., starting from /**), syntax highlighting breaks for all functions that lay below it.

Steps to reproduce

• Create a function declaration
• Create NatSpec block /**...*/
• Syntax highlighting breaks

Note

The bug is unstable: in certain conditions, it doesn't cause a breaking effect. Typically, the functions added to the end of the contract are affected instead of the ones in the middle.

Lexer issue with optional params inside abi.decode

Add the possibility to show diagram of the contract

`Structure` pane displays the wrong content when another item is single-clicked in file tree

How to reproduce

1. Open a file (ArrayHelper.tsol in this example) for editing in IDE
2. Select the Structure pane to see elements in it
   
3. Now, switch back to Project pane and single-click on any other file in the file tree (e.g., locklift.config.ts)
   
4. Go back to Structure pane to see that it now displays the contents of the locklift.config.ts file instead of ArrayHelper.tsol
   
5. Click in the editing area to see that Structure pane went back to normal

Expected behavior

Structure pane always displays the contents of the currently edited file

Adding of pragma ignoreIntOverflow ruins parser

T-Sol parser rules await "pragma pragma_name identifier" but "pragma ignoreIntOverflow" doesn't have identifier.

Tsol doesn't allow public & static reversed order

T-sol allows:
address public static _owner;
But reverse syntax is not allowed and parser fails:
address static public _owner;
Compiler allows such syntax, so it should be supported.

Opening a file with absolute path in IDE

If i'm compiled contracts i'm give error:
.......Unknown exception during compilation: boost::filesystem::canonical: No such file or directory [generic:2]: "/abstract/OrderBase.tsol
Because abstract/OrderBase.tsol it error, must be:./abstract/OrderBase.tsol

Library methods are not displayed when `using` keyword is applied to a type

How to reproduce

1. Create a simple extension library (e.g. ArrayHelper)
   
2. In the contract, apply this library to a type (e.g., uint[])
   
3. After typing dot after a uint array variable, the expected methods are not displayed:
   

Expected behavior

All applicable extension methods are shown.

Formatter issues

1. JSON
   Before running the format
   

After running the format

The formatted result should look like this :

2. After running format imports should be sorted
   

When using vector(<Some Type>) plugin loses type information.

When I use a variable of struct type, I have information about its methods like unpack();

struct Limits {uint l; uint r;}
Limits l = Limits(0, res.length - 1);
l.unpack();

If I acquire the same type from vector, plugin loses type info:

vector(Limits) s;
s.pop().unpack(); // shows error

Here's the full image:

Setting --libPath is problematic with this plugin

As you may know, solc has options for settting --lib-path. It's a good choice for adding common (or foreign) libs between projects. I didn't found how I can use it with t-sol plugin.
The problem is that --lib-path can't be in subdirectories of contract's tsol file. And if something is not part of tsol location subdirs (and path to import is not absolute) plugin will not see it.
It's perfectly ok, not a bug or wrong logic, but perhaps we can have a little setting in a plugin to set a custom additional path that will be indexed.

Sort import definitions after applying the suggested import

Current behavior

After applying the suggested import in IDE (Alt+Enter), the new definition is added to the end of the imports list:

Expected behavior

The imports list is automatically sorted after adding a new entry:

Incorrect `tx` namespace entries

The only suggested parameter is unpack:

This namespace should contain timestamp and storageFee instead https://github.com/tonlabs/TON-Solidity-Compiler/blob/master/API.md#tx-namespace

Autocompletion for `pragma AbiHeader`

There is a set of predefined and widely used headers (time, expire, pubkey). It would be nice to have an autocompletion and some kind of docs for them.

Interface sub-structures autocomplete not working in some cases

Example:
function some_funtion(ISomeInterface.SomeStructure variable) external {

Here SomeStructure is not advised by IDE and you need to type it manually

Modifiers from contracts defined in node modules are not detected

Here reserve() function is defined in Reservable contract. IDE marks it as undefined

Add SPDX License suggestions

Existing behavior

T-Sol allows indication of the applicable SPDX code for the license used:

However, no auto-suggest for available licenses is available at the moment.

Expected behavior

1. Upon entering the // SPDX-License-Identifier: automatically suggest the list of SPDX license codes with dynamic filtering upon typing
2. Analyze the most frequently used license code throughout the codebase of the project and, if the license code of the current file differs, suggest either (a) updating it to the most frequently used or (b) applying the license code from this file to other files in the project
3. If SPDX code is specified anywhere in the source code tree, recommend adding it to all missing files.

The function parameter placeholder should be shown

And the same behavior for destructuring tuples

Plugin doesn't see any structures that the interface contains

Need to add possibility for changing color scheme for json

Like this

Auto import create over pragmas

If writing inheritance of abstract contract autocomposition add import to abstract contract over pragmas.

<constant variable declaration>, <contract definition>, <expression>, <function definition>, <function invocation>, enum, error, import, pragma, stringLiteral, struct, type or using expected, got ';'

<constant variable declaration>, <contract definition>, <expression>, <function definition>, <function invocation>, enum, error, import, pragma, stringLiteral, struct, type or using expected, got ';'

Support type arguments in built-in functions

Current behavior

The plugin cannot recognize the nested type of the optional parameter passed to the function and, consequently, does not see its members.

Expected behavior

Plugin correctly identifies the nested type and provides proper hints and suggestions.

Need to add 'implement all members' feature

Like this

Wrong suggestions of contract members when it acts as a function argument

When we use contract (or interface) variable in a local scope, its ok

But if we will try it inside function invocation, it will start to suggest everything ;(

Broken lookup for libraries renamed on import

import {DateTime as DateTimeLib} from "./libraries/DateTime.tsol";

...
DateTimeLib.doSomething();
...

1. DateTimeLib will not be autocompleted in code
2. doSometing() wont be advised by IDE