Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.85 KB

README-DEVELOP.md

File metadata and controls

112 lines (76 loc) · 3.85 KB
Raw

Table of Contents

Perhaps you want to help work on this project? Or run from the github repository?

Prerequisites...

You need to have installed

There are a number of nodejs packages are needed, like typescript, but you can get those via yarn, which is described in a below section.

How to run code in this github repository

Clone the repository:

$ git clone https://github.com/tact-lang/vscode-tact
Cloning into 'vscode-tact'...
...
$ cd vscode-tact

Install dependent npm packages:

$ yarn

Running

If you just want to run the code, on the top there is a "Debug" menu item and under that, the second item is "Start Without Debugging", which is also bound the key sequence Ctrl-F5.

After that, the VSCode window should turn from blue to orange and another window will pop up. In this window you will have the vscode extension installed and enabled.

If you edit a Tact file, which is a file ending in .tact and looks like this:

  import "@stdlib/deploy";

  message Add {
    amount: Int as uint32;
  }

  contract SampleTactContract with Deployable {

    owner: Address;
    counter: Int as uint32;

    init(owner: Address) {
        self.owner = owner;
        self.counter = 0;
    }

    fun add(v: Int) {
        
        // Check sender
        let ctx: Context = context();
        require(ctx.sender == self.owner, "Invalid sender");
        
        // Update counter
        self.counter = (self.counter + v);
    }

    receive(msg: Add) {
        self.add(msg.amount);
    }

    receive("increment") {
        self.add(1);
    }

    get fun counter(): Int {
        return self.counter;
    }
  }

This when rendered inside be colorized. If the all appear in the same color then the language extension mechanism is not working and there is probably something wrong in the extension. Look in the other VSCode window with the orange frame for what might be wrong.

Addig new elements to parser

Add new markup to ./src/parser/tact.pegjs and then run this command

npm run rebuildparser

Debugging

You may want to extend this code of may find a problem and want to debug what is going wrong. For this, you start off from the "Debug" menu using the first item on the list "Start Debugging" which is also bound to the function key F5. As before the window will go orange a popup menu bar will appear at the top.

NOTE: It may happen that after the window goes orange, another and VSCode window with the blue, the "play button" may go from a the parallel bars to "pause" back to "play". When that happens you may also be stopped in bootstrap-fork.js at some nonsensical like like line 9 which has no code on it. If this happens (and it may happen several times for each .tact file loaded) just hit the play button to make sure it goes back to the parallel bars. You have 10 seconds from the time this button goes from "Pause" to "Play" to hit the "Play" button. Otherwise in the other VSCode you will get a popup message that reads:

Extension host did not start in 10 seconds, it might be stopped on the first line and needs a debugger to continue.

See also: