Skip to content

Commit e51650d

Browse files
committed
feat(docs): Improve the blueprint page
1 parent 05078b4 commit e51650d

File tree

3 files changed

+56
-18
lines changed

3 files changed

+56
-18
lines changed

docs/tutorial/blueprint.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Using Misti with Blueprint
22

3-
[Blueprint](https://github.com/ton-org/blueprint) is a development environment for writing, testing, and deploying TON smart contracts.
3+
[Blueprint](https://github.com/ton-org/blueprint/) is a platform to compile, test, and deploy contracts on the TON blockchain. It is quite similar to Hardhat and Truffle for Ethereum.
44

5-
Misti can be used in Blueprint projects by leveraging the [`blueprint-misti`](https://github.com/nowarp/blueprint-misti) plugin.
5+
There is a [blueprint-misti](https://github.com/nowarp/blueprint-misti) plugin that can be added to a Blueprint configuration. It adds the `blueprint misti` command, which runs the static analyzer over the selected Blueprint project.
66

7-
## Getting started
7+
This page describes how to use it.
88

9-
Add the plugin and the recent version of Tact to the `package.json` of your Blueprint project by running:
9+
## Getting Started
10+
11+
1. [Install Soufflé](https://souffle-lang.github.io/install) to use all detectors provided by Misti.
12+
13+
2. Add this plugin as a dependency of your Blueprint project:
1014
```bash
1115
yarn add @tact-lang/compiler
1216
yarn add @nowarp/blueprint-misti
1317
```
1418

15-
Then, add this configuration to `blueprint.config.ts`:
19+
3. Add this configuration to `blueprint.config.ts`:
1620
```ts
1721
import { MistiPlugin } from '@nowarp/blueprint-misti';
1822
export const config = {
@@ -22,10 +26,25 @@ export const config = {
2226
};
2327
```
2428

25-
Now, try to run Misti:
29+
## Usage
30+
31+
Run the following command:
32+
```bash
33+
yarn blueprint misti
34+
```
35+
36+
It will run the analysis of the available project, if there is one, or show an interactive window to select a project:
37+
38+
![img](/img/blueprint-select-project.png)
39+
40+
You could also pass the [supported CLI options](./cli.md) for Misti, for example:
41+
```bash
42+
yarn blueprint misti --all-detectors
43+
```
44+
45+
Or you can even pass the path to the contract directly:
2646
```bash
27-
yarn blueprint misti ./path/to/tact.config.json
47+
yarn blueprint misti path/to/my/contract.tact
2848
```
2949

30-
## Resources
31-
For more information, please refer to the README of the [`blueprint-misti`](https://github.com/nowarp/blueprint-misti) project. If you have any problems, feel free to reach out to us in the [Misti discussion group](https://t.me/misti_dev).
50+
If you have any problems, feel free to reach out to us in the [Misti discussion group](https://t.me/misti_dev).
11.2 KB
Loading
Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# Using Misti with Blueprint
22

3-
[Blueprint](https://github.com/ton-org/blueprint) is a development environment for writing, testing, and deploying TON smart contracts.
3+
[Blueprint](https://github.com/ton-org/blueprint/) is a platform to compile, test, and deploy contracts on the TON blockchain. It is quite similar to Hardhat and Truffle for Ethereum.
44

5-
Misti can be used in Blueprint projects by leveraging the [`blueprint-misti`](https://github.com/nowarp/blueprint-misti) plugin.
5+
There is a [blueprint-misti](https://github.com/nowarp/blueprint-misti) plugin that can be added to a Blueprint configuration. It adds the `blueprint misti` command, which runs the static analyzer over the selected Blueprint project.
66

7-
## Getting started
7+
This page describes how to use it.
88

9-
Add the plugin and the recent version of Tact to the `package.json` of your Blueprint project by running:
9+
## Getting Started
10+
11+
1. [Install Soufflé](https://souffle-lang.github.io/install) to use all detectors provided by Misti.
12+
13+
2. Add this plugin as a dependency of your Blueprint project:
1014
```bash
1115
yarn add @tact-lang/compiler
1216
yarn add @nowarp/blueprint-misti
1317
```
1418

15-
Then, add this configuration to `blueprint.config.ts`:
19+
3. Add this configuration to `blueprint.config.ts`:
1620
```ts
1721
import { MistiPlugin } from '@nowarp/blueprint-misti';
1822
export const config = {
@@ -22,10 +26,25 @@ export const config = {
2226
};
2327
```
2428

25-
Now, try to run Misti:
29+
## Usage
30+
31+
Run the following command:
32+
```bash
33+
yarn blueprint misti
34+
```
35+
36+
It will run the analysis of the available project, if there is one, or show an interactive window to select a project:
37+
38+
![img](/img/blueprint-select-project.png)
39+
40+
You could also pass the [supported CLI options](./cli.md) for Misti, for example:
41+
```bash
42+
yarn blueprint misti --all-detectors
43+
```
44+
45+
Or you can even pass the path to the contract directly:
2646
```bash
27-
yarn blueprint misti ./path/to/tact.config.json
47+
yarn blueprint misti path/to/my/contract.tact
2848
```
2949

30-
## Resources
31-
For more information, please refer to the README of the [`blueprint-misti`](https://github.com/nowarp/blueprint-misti) project. If you have any problems, feel free to reach out to us in the [Misti discussion group](https://t.me/misti_dev).
50+
If you have any problems, feel free to reach out to us in the [Misti discussion group](https://t.me/misti_dev).

0 commit comments

Comments
 (0)