FullConfig | pretty-ts-imports (a.k.a. primp)

Interface describing a full-fledged config.

Hierarchy

Required<Config>
- FullConfig

Implemented by

ConfigHandler

Index

Properties

formatting

formatting: Required<FormattingOptions>

Formatting options will every option.

require

require: Record<string, string>

An object containing custom compare functions. Use the key for the function name and the value for the path of compare function relative to the config file.

To make sure the functions do work correctly, they should implement either ImportCompareFunction, ImportElementCompareFunction or SeparateByFunction and export their function as default.

see: ../../examples/compare_functions/imports/dotJSFirst.ts

separateBy

separateBy: string[]

Names of group by functions to determine where to put a separator line. Only one line around every group is possible, therefore the order is not important.

Note: the names need to be exact with the function names.

sortImportElements

sortImportElements: string[]

Names of the compare functions in every import in order of execution. Primp will run through these to sort all import elements.

Note: the names need to be exact with the function names.

sortImports

sortImports: string[]

Names of the compare functions in order of execution. Primp will run through these to sort all imports.

Note: The names need to be exact with function names.