Skip to content

ftkit header

Add the standard file-header template to Go files that are missing it.

Usage

bash
ftkit header

The command is also available under the alias h. It takes no arguments.

Hidden command

header is registered as a hidden command, so it does not appear in ftkit --help. It is invoked directly (and is what ftkit verify suggests running when Go files are missing their headers).

What it does

header walks the current directory tree and, for every .go file that does not already have the standard Fountain header comment and is not a generated file (Code generated ... DO NOT EDIT.), it renders the common header template (data/templates/common.header.tpl) and prepends it to the file.

The header is rendered with the same template data the rest of ftkit uses (author, copyright owner/website, dates, the file name, etc.), so the prepended block matches the project's conventions.

Files that already carry a header are left untouched, so the command is safe to run repeatedly.

Arguments and flags

header accepts no positional arguments (ExactArgs(0)) and has no flags.