Skip to content

Commit 8058e5b

Browse files
committed
docs: 📝 readme
1 parent c2b7119 commit 8058e5b

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
# VSCode Solidity Inspector • [![license](https://img.shields.io/badge/MIT-brown.svg?label=license)](https://github.com/PraneshASP/vscode-solidity-inspector/blob/main/LICENSE)
44

5-
An extension for VSCode editor to inspect the Solidity smartcontracts and generate yul/asm outputs to inspect what's happening under-the-hood. Read 0age's [tweet](https://twitter.com/z0age/status/1578443876615929857), it is the inspiration for this extension.
5+
An extension for VSCode editor that offers multiple utilities to work with the Solidity smart-contracts.
66

7-
> Note: This extension is not tested across multiple platforms yet.Only the contracts under foundry project are supported for now.
7+
> Note: This extension is not tested across multiple platforms yet. Only the contracts under foundry project are supported for now.
88
99
---
1010

1111
## Motivation:
1212

13-
0age 👑 dropped the optimization alpha in his [tweet](https://twitter.com/z0age/status/1578443876615929857) and when I tried it out for the first time I thought it was really a cool trick. The tweet has the configuration only for hardhat projects. But forge helps to do the same thing in a single command. So I thought instead of typing out the command for each contract in the CLI, it would be handy for the buildooors if there's an extension to inspect solidity contracts and generate low-level code for the contracts. The o/p generated is very useful for gas optimizations.
13+
0age 👑 dropped the optimization alpha in his [tweet](https://twitter.com/z0age/status/1578443876615929857) and when I tried it out for the first time I thought it was really a cool trick. The tweet has the configuration only for hardhat projects. But forge helps to do the same thing in a single command. So I thought instead of typing out the command for each contract in the CLI, it would be handy for the buildooors if there's an extension to inspect solidity contracts and generate low-level code for the contracts. The o/p generated is very useful for gas optimizations. Later I started adding more features to this extension.
1414

1515
TL;DR, this is my first VSCode extension, so feel free to provide feedback as I know that there's a plenty of room for improvements, as always^^
1616

@@ -24,6 +24,7 @@ TL;DR, this is my first VSCode extension, so feel free to provide feedback as I
2424
- Generate and view Foundry deployment report in a clean and concise table format.
2525
- Syntax highlighting of for `.tree` files.
2626
- Generate foundry test stub using [bulloak](https://github.com/alexfertel/bulloak)'s `scaffold` command.
27+
- Auto-complete path suggestions for importing files and dependencies (with forge remappings support).
2728

2829
---
2930

@@ -69,6 +70,15 @@ https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/cfaf987e
6970

7071
https://github.com/PraneshASP/vscode-solidity-inspector/assets/42379522/2a3d591b-bc80-46cc-88c9-7e4faa0bb043
7172

73+
---
74+
75+
#### File import auto-complete suggestions (with forge remappings support):
76+
77+
> [!TIP]
78+
> If you have updated your remappings.txt file, you can press `CMD+CTRL+X` to refresh remappings.
79+
80+
![](./assets/auto-import.gif)
81+
7282

7383
---
7484

assets/auto-import.gif

3.2 MB
Loading

0 commit comments

Comments
 (0)