README
¶
How does TypeScript formatting work?
To format code you need to have a formatting context and a SourceFile. The formatting context contains
all user settings like tab size, newline character, etc.
The end result of formatting is represented by TextChange objects which hold the new string content, and the text to replace it with.
Internals
Most of the exposed APIs internally are Format* and they all set up and configure FormatSpan which could be considered the root call for formatting. Span in this case refers to the range of
the sourcefile which should be formatted.
The formatSpan then uses a scanner (either with or without JSX support) which starts at the highest node the covers the span of text and recurses down through the node's children.
As it recurses, processNode is called on the children setting the indentation is decided and passed
through into each of that node's children.
The meat of formatting decisions is made via processPair, the pair here being the current node and the previous node. processPair which mutates the formatting context to represent the current place in the scanner and requests a set of rules which can be applied to the items via createRulesMap.
There are a lot of rules, which you can find in rules.ts each one has a left and right reference to nodes or token ranges and note of what action should be applied by the formatter.
Where is this used?
The formatter is used mainly from any language service operation that inserts or modifies code. The formatter is not exported publicly, and so all usage can only come through the language server.
Documentation
¶
Index ¶
- func FindFirstNonWhitespaceColumn(startPos int, endPos int, sourceFile *ast.SourceFile, ...) int
- func FormatDocument(ctx context.Context, sourceFile *ast.SourceFile) []core.TextChange
- func FormatNodeGivenIndentation(ctx context.Context, node *ast.Node, file *ast.SourceFile, ...) []core.TextChange
- func FormatOnClosingCurly(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
- func FormatOnEnter(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
- func FormatOnOpeningCurly(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
- func FormatOnSemicolon(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
- func FormatSelection(ctx context.Context, sourceFile *ast.SourceFile, start int, end int) []core.TextChange
- func FormatSpan(ctx context.Context, span core.TextRange, file *ast.SourceFile, ...) []core.TextChange
- func GetContainingList(node *ast.Node, sourceFile *ast.SourceFile) *ast.NodeList
- func GetFormatCodeSettingsFromContext(ctx context.Context) lsutil.FormatCodeSettings
- func GetIndentation(position int, sourceFile *ast.SourceFile, options lsutil.FormatCodeSettings, ...) int
- func GetIndentationForNode(n *ast.Node, ignoreActualIndentationRange *core.TextRange, ...) int
- func GetLineStartPositionForPosition(position int, sourceFile *ast.SourceFile) int
- func GetNewLineOrDefaultFromContext(ctx context.Context) string
- func NodeWillIndentChild(settings lsutil.FormatCodeSettings, parent *ast.Node, child *ast.Node, ...) bool
- func ShouldIndentChildNode(settings lsutil.FormatCodeSettings, parent *ast.Node, child *ast.Node, ...) bool
- func WithFormatCodeSettings(ctx context.Context, options lsutil.FormatCodeSettings, newLine string) context.Context
- type FormatRequestKind
- type FormattingContext
- func (this *FormattingContext) ContextNodeAllOnSameLine() bool
- func (this *FormattingContext) ContextNodeBlockIsOnOneLine() bool
- func (this *FormattingContext) NextNodeAllOnSameLine() bool
- func (this *FormattingContext) NextNodeBlockIsOnOneLine() bool
- func (this *FormattingContext) TokensAreOnSameLine() bool
- func (this *FormattingContext) UpdateContext(cur TextRangeWithKind, curParent *ast.Node, next TextRangeWithKind, ...)
- type LineAction
- type RulesPosition
- type TextRangeWithKind
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FindFirstNonWhitespaceColumn ¶
func FindFirstNonWhitespaceColumn(startPos int, endPos int, sourceFile *ast.SourceFile, options lsutil.FormatCodeSettings) int
func FormatDocument ¶
func FormatDocument(ctx context.Context, sourceFile *ast.SourceFile) []core.TextChange
func FormatNodeGivenIndentation ¶
func FormatNodeGivenIndentation(ctx context.Context, node *ast.Node, file *ast.SourceFile, languageVariant core.LanguageVariant, initialIndentation int, delta int) []core.TextChange
func FormatOnClosingCurly ¶
func FormatOnClosingCurly(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
func FormatOnEnter ¶
func FormatOnEnter(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
func FormatOnOpeningCurly ¶
func FormatOnOpeningCurly(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
func FormatOnSemicolon ¶
func FormatOnSemicolon(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange
func FormatSelection ¶
func FormatSelection(ctx context.Context, sourceFile *ast.SourceFile, start int, end int) []core.TextChange
func FormatSpan ¶
func FormatSpan(ctx context.Context, span core.TextRange, file *ast.SourceFile, kind FormatRequestKind) []core.TextChange
func GetContainingList ¶
func GetFormatCodeSettingsFromContext ¶
func GetFormatCodeSettingsFromContext(ctx context.Context) lsutil.FormatCodeSettings
func GetIndentation ¶
func GetIndentation(position int, sourceFile *ast.SourceFile, options lsutil.FormatCodeSettings, assumeNewLineBeforeCloseBrace bool) int
GetIndentation computes the expected indentation for a position in a source file. This is the Go port of SmartIndenter.getIndentation from TypeScript.
func GetIndentationForNode ¶
func GetIndentationForNode(n *ast.Node, ignoreActualIndentationRange *core.TextRange, sourceFile *ast.SourceFile, options lsutil.FormatCodeSettings) int
func GetLineStartPositionForPosition ¶
func GetLineStartPositionForPosition(position int, sourceFile *ast.SourceFile) int
func NodeWillIndentChild ¶
func NodeWillIndentChild(settings lsutil.FormatCodeSettings, parent *ast.Node, child *ast.Node, sourceFile *ast.SourceFile, indentByDefault bool) bool
func ShouldIndentChildNode ¶
func ShouldIndentChildNode(settings lsutil.FormatCodeSettings, parent *ast.Node, child *ast.Node, sourceFile *ast.SourceFile, isNextChildArg ...bool) bool
* * True when the parent node should indent the given child by an explicit rule. * @param isNextChild If true, we are judging indent of a hypothetical child *after* this one, not the current child.
func WithFormatCodeSettings ¶
Types ¶
type FormatRequestKind ¶
type FormatRequestKind int
const ( FormatRequestKindFormatDocument FormatRequestKind = iota FormatRequestKindFormatSelection FormatRequestKindFormatOnEnter FormatRequestKindFormatOnSemicolon FormatRequestKindFormatOnOpeningCurlyBrace FormatRequestKindFormatOnClosingCurlyBrace )
type FormattingContext ¶
type FormattingContext struct {
SourceFile *ast.SourceFile
FormattingRequestKind FormatRequestKind
Options lsutil.FormatCodeSettings
// contains filtered or unexported fields
}
func NewFormattingContext ¶
func NewFormattingContext(file *ast.SourceFile, kind FormatRequestKind, options lsutil.FormatCodeSettings) *FormattingContext
func (*FormattingContext) ContextNodeAllOnSameLine ¶
func (this *FormattingContext) ContextNodeAllOnSameLine() bool
func (*FormattingContext) ContextNodeBlockIsOnOneLine ¶
func (this *FormattingContext) ContextNodeBlockIsOnOneLine() bool
func (*FormattingContext) NextNodeAllOnSameLine ¶
func (this *FormattingContext) NextNodeAllOnSameLine() bool
func (*FormattingContext) NextNodeBlockIsOnOneLine ¶
func (this *FormattingContext) NextNodeBlockIsOnOneLine() bool
func (*FormattingContext) TokensAreOnSameLine ¶
func (this *FormattingContext) TokensAreOnSameLine() bool
func (*FormattingContext) UpdateContext ¶
func (this *FormattingContext) UpdateContext(cur TextRangeWithKind, curParent *ast.Node, next TextRangeWithKind, nextParent *ast.Node, commonParent *ast.Node)
type LineAction ¶
type LineAction int
const ( LineActionNone LineAction = iota LineActionLineAdded LineActionLineRemoved )
type RulesPosition ¶
type RulesPosition int
const ( RulesPositionStopRulesSpecific RulesPosition = 0 RulesPositionStopRulesAny RulesPosition = maskBitSize * 1 RulesPositionContextRulesSpecific RulesPosition = maskBitSize * 2 RulesPositionContextRulesAny RulesPosition = maskBitSize * 3 RulesPositionNoContextRulesSpecific RulesPosition = maskBitSize * 4 RulesPositionNoContextRulesAny RulesPosition = maskBitSize * 5 )
type TextRangeWithKind ¶
func NewTextRangeWithKind ¶
func NewTextRangeWithKind(pos int, end int, kind ast.Kind) TextRangeWithKind
Source Files