Format-JavaScript

August 3, 2026 ยท View on GitHub

SYNOPSIS

Cmdlet that formats JavaScript code using JsBeautifier.

SYNTAX

Content (Default)

Format-JavaScript -Content <string> [-OutputFile <string>] [-IndentSize <uint>] [-IndentChar <char>] [-IndentWithTabs <bool>] [-PreserveNewlines <bool>] [-MaxPreserveNewlines <float>] [-JslintHappy <bool>] [-BraceStyle <BraceStyle>] [-KeepArrayIndentation <bool>] [-KeepFunctionIndentation <bool>] [-EvalCode <bool>] [-WrapLineLength <int>] [-SplitLongStringLiterals] [-MaxStringLiteralLength <int>] [-BreakChainedMethods <bool>] [<CommonParameters>]

File

Format-JavaScript -Path <string> [-OutputFile <string>] [-IndentSize <uint>] [-IndentChar <char>] [-IndentWithTabs <bool>] [-PreserveNewlines <bool>] [-MaxPreserveNewlines <float>] [-JslintHappy <bool>] [-BraceStyle <BraceStyle>] [-KeepArrayIndentation <bool>] [-KeepFunctionIndentation <bool>] [-EvalCode <bool>] [-WrapLineLength <int>] [-SplitLongStringLiterals] [-MaxStringLiteralLength <int>] [-BreakChainedMethods <bool>] [<CommonParameters>]

DESCRIPTION

Cmdlet that formats JavaScript code using JsBeautifier.

EXAMPLES

EXAMPLE 1

Format-JavaScript -Path script.js

PARAMETERS

-BraceStyle

Brace formatting style.

Type: BraceStyle
Parameter Sets: Content, File
Aliases: None
Possible values: Expand, Collapse, EndExpand

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BreakChainedMethods

Break chained methods.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Content

JavaScript code to format.

Type: String
Parameter Sets: Content
Aliases: FileContent
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue, ByPropertyName)
Accept wildcard characters: False

-EvalCode

Preserve eval code.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IndentChar

Indentation character.

Type: Char
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IndentSize

Number of spaces for indentation.

Type: UInt32
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IndentWithTabs

Use tabs for indentation.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-JslintHappy

Enable jslint-happy formatting.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeepArrayIndentation

Keep array indentation.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeepFunctionIndentation

Keep function indentation.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxPreserveNewlines

Maximum number of consecutive newlines to preserve.

Type: Single
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MaxStringLiteralLength

Maximum raw content length for each string literal chunk. Use 0 for the formatter default.

Type: Int32
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutputFile

Optional path to write the formatted JavaScript.

Type: String
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Path to a JavaScript file to format.

Type: String
Parameter Sets: File
Aliases: File
Possible values:

Required: True
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PreserveNewlines

Preserve existing newlines.

Type: Boolean
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SplitLongStringLiterals

Split long quoted string literals into concatenated chunks.

Type: SwitchParameter
Parameter Sets: Content, File
Aliases: SplitLongLine, SplitLongString
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WrapLineLength

Line length at which formatter may wrap before the next token. Use 0 to disable token wrapping.

Type: Int32
Parameter Sets: Content, File
Aliases: None
Possible values:

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • System.String

OUTPUTS

  • System.String
  • None