https://github.com/yashiru/huff-stack-comments
A visual studio code extension that automatically generate the stack comments for Huff.
https://github.com/yashiru/huff-stack-comments
comments huff stack vscode
Last synced: 9 months ago
JSON representation
A visual studio code extension that automatically generate the stack comments for Huff.
- Host: GitHub
- URL: https://github.com/yashiru/huff-stack-comments
- Owner: Yashiru
- License: unlicense
- Created: 2023-03-25T08:36:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T09:09:58.000Z (over 2 years ago)
- Last Synced: 2023-10-17T02:24:44.382Z (over 2 years ago)
- Topics: comments, huff, stack, vscode
- Language: TypeScript
- Homepage:
- Size: 2.49 MB
- Stars: 21
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> **Note**
> Check out [huffr](https://github.com/Yashiru/huffr), a new way to generate huff stack comments.
# Huff stack comments - VsCode extension
This VsCode extension allows to generate automatically comments representing the evolution of the stack during the execution of a code written in [Huff](https://github.com/huff-language/huff-rs).
> **Warning**
> This is an educational project intended for educational purposes **only**.
> **Warning**
> This project is in constant development, it has bugs and malfunctions.
## Features
The following command generate the stack comments into the current Huff file.
```
huff-stack-comments.generate
```
To run it, use `ctrl+shift+p` or `cmd+shift+p` and find it by searching for `Huff: Generate stack comments`.
## Known Issues
You can find the known issues on the [github repository](https://github.com/Yashiru/huff-stack-comments/issues).
## Release Notes
### 0.1.0
TODO for the 0.1.0 first release.
---
## Contribute
### Clone the repository
``` bash
git clone https://github.com/Yashiru/huff-stack-comments.git
```
### Install dependancies
```bash
npm i
```
### Run tests
```bash
npm test
```
### Compile and try the extension in live
Open the cloned repository in Visual Studio Code and press `F5`.
### Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)