Home

Awesome

vheader

[!Important] I found out after that Transmissions11 also made one for Vyper.

Generate perfect Vyper code headers every time.

Forked from transmissions11/headers

[!Note] There is also a version of this built in python (to be installed with pip)

Build

You need Rust and Cargo installed on your machine. See the installation guide here.

Then clone the repo and install the CLI globally like this:

cargo install --path .

Usage

vheader "external functions"

# ------------------------------------------------------------------
#                       EXTERNAL FUNCTIONS
# ------------------------------------------------------------------

It will also copy the header to your clipboard automatically.

With VSCode

Set your global tasks.json like so to add the command as task:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Generate Header",
      "type": "shell",
      "command": "vheader ${input:header}",
      "presentation": {
        "reveal": "never"
      },
      "problemMatcher": []
    }
  ],
  "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:

[
  {
    "key": "CMD+h",
    "command": "workbench.action.tasks.runTask",
    "args": "Generate Header"
  }
]

This will copy the generated header to your clipboard.

Credits