https://github.com/transmissions11/headers-vy
Generate perfect Vyper compatible code headers every time.
https://github.com/transmissions11/headers-vy
Last synced: about 1 year ago
JSON representation
Generate perfect Vyper compatible code headers every time.
- Host: GitHub
- URL: https://github.com/transmissions11/headers-vy
- Owner: transmissions11
- Created: 2022-07-30T07:30:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-30T07:37:52.000Z (almost 4 years ago)
- Last Synced: 2025-04-04T09:09:35.826Z (about 1 year ago)
- Language: Rust
- Size: 2.93 KB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# headers-vy
Generate perfect _Vyper-compatible_ code headers every time.
## Build
You need Rust and Cargo installed on your machine. See the installation guide
[here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
Then clone the repo and install the CLI globally like this:
```sh
cargo install --path .
```
## Usage
```sh
λ ./headers-vy "testing 123"
```
```sh
################################################################
# TESTING 123 #
################################################################
```
It will also copy the header to your clipboard automatically.
### With VSCode
Set your global [`tasks.json`](https://stackoverflow.com/questions/41046494/making-global-tasks-in-vs-code) like so to add the command as task:
```json
{
"version": "2.0.0",
"tasks": [
{
"label": "Generate Vyper Header",
"type": "shell",
"command": "headers-vy ${input:header}",
"presentation": {
"reveal": "never"
}
}
],
"inputs": [
{
"id": "header",
"description": "Header",
"type": "promptString"
}
]
}
```
To really speed-up your workflow, you can even add a keybind for the task in [`keybindings.json`](https://code.visualstudio.com/docs/getstarted/keybindings):
```json
[
{
"key": "CMD+y",
"command": "workbench.action.tasks.runTask",
"args": "Generate Vyper Header"
}
]
```
This will copy the generated header to your clipboard.
## Credits
Forked from [`headers`](https://github.com/transmissions11/headers).