EditorConfigProperties

EditorConfigProperties = object

Defined in: properties.ts:9

The properties EditorConfig defines, with their spec spellings resolved to values a program can act on.

Every field is optional: an unset property means the file said nothing about it, which is different from setting it off. "unset" in the source also lands here as absent, since that is exactly what it means.

Properties

charset?

readonly optional charset?: string

Defined in: properties.ts:23

charset.

---

endOfLine?

readonly optional endOfLine?: "lf" | "crlf" | "cr"

Defined in: properties.ts:20

end_of_line.

---

indentSize?

readonly optional indentSize?: number | "tab"

Defined in: properties.ts:14

indent_size; "tab" defers to tabWidth.

---

indentStyle?

readonly optional indentStyle?: "tab" | "space"

Defined in: properties.ts:11

indent_style.

---

insertFinalNewline?

readonly optional insertFinalNewline?: boolean

Defined in: properties.ts:29

insert_final_newline.

---

maxLineLength?

readonly optional maxLineLength?: number | "off"

Defined in: properties.ts:32

max_line_length; "off" where the spec allows disabling it.

---

tabWidth?

readonly optional tabWidth?: number

Defined in: properties.ts:17

tab_width. Defaults to indent_size when that is a number.

---

trimTrailingWhitespace?

readonly optional trimTrailingWhitespace?: boolean

Defined in: properties.ts:26

trim_trailing_whitespace.

---

unknown?

readonly optional unknown?: Readonly<Record<string, string>>

Defined in: properties.ts:35

Properties the spec does not define, preserved with their raw values.