Skip to main content
Version: Next (2.x)

FileOptions

Options for generated files.

Properties

PropertyTypeDefault valueDescription

addHeader?

(name, content, tag) => string

undefined

Add custom header at the beginning of the file.

disableGenerationNoticeHeader?

boolean

false

Disable generation notice at the beginning of the file.

disableOverwrite?

boolean

false

Disallow overwriting the file.

enableLintHeaders?

boolean | FileLintOptions

false

Enable lint disabling headers at the beginning of the file. Can be either a boolean to enable all supported lint headers or an object to enable specific ones.

transformContent?

(name, content, tag) => string | Promise<string>

undefined

Edit the content of the file before writing it.