prettier-plugin-wolfram weekly downloads statistics

Wolfram Prettier Plugin — prettier-plugin-wolfram

Prettier formatting for Wolfram Language, powered by tree-sitter.

Install · CLI · Configuration · VS Code

The plugin parses Wolfram Language through a bundled tree-sitter WebAssembly grammar and prints the result with Prettier. It supports .wl, .wls, .wlt, .mt, and .m files. No Wolfram Engine or local kernel installation is required.

Not affiliated with the original prettier extension.

At A Glance

| Need | What this package provides |

| Prettier formatting | A Wolfram parser and printer for Prettier 3 projects. | | Editor support | A bundled VS Code extension with document, range, and format-on-save workflows. | | Diagnostics | Formatter-backed rule findings, line-width hints, and fixable style diffs. | | Zero dependencies | Parsing via a bundled tree-sitter WASM grammar; no Wolfram Engine required. |

Requirements

• Node.js • Prettier 3.x

Install

Install Prettier and the plugin in the project that contains your Wolfram source:

Add the plugin to your Prettier configuration for CLI use:

CLI Usage

Format a file to stdout:

Write changes back:

Check whether files would change:

Format a byte range with Prettier's standard range flags:

Range formatting expands to the top-level Wolfram expressions touched by the range. This avoids formatting incomplete fragments that the parser cannot parse on their own.

Formatting Features

• Formats Wolfram calls, lists, associations, prefix, postfix, infix, binary, ternary, compound, and leaf nodes produced by the tree-sitter grammar. • Applies specialized layouts to configurable block-style forms such as Module, With, Block, and DynamicModule. • Applies condition-first layout to configurable forms such as If and Switch. • Applies alternating condition/body layout to configurable case forms such as Which. • Wraps long string literals and flattens nested StringJoin[...] calls into a stable multiline StringJoin[...] layout when needed. • Preserves leading comments, trailing comments, multiline comments, and top-level comment blocks. • Aligns trailing documentation comments either automatically or at a configured column. • Preserves ordinary blank lines up to a configured cap and controls spacing between adjacent definitions, including separate Set and SetDelayed definition groups. • Optionally aligns Rule and RuleDelayed values in multiline argument, list, and association layouts. • Normalizes general infix x ~ f ~ y to f[x, y] unless the function head is listed in wolfram.preserveTildeInfixFunctions. • Leaves parse-error files and unsupported CST nodes as original source instead of printing internal parser details. • Produces idempotent output: a second format pass should not change the first pass result.

Prettier Configuration

Typical .prettierrc example:

Use Prettier's standard printWidth, tabWidth, useTabs, endOfLine, and related options for normal Prettier behavior. The options below are specific to this plugin.

| Option | Type | Default | Description |

| wolfram.newlinesBetweenDefinitions | integer | 1 | Blank lines inserted between adjacent top-level definitions such as Set, SetDelayed, TagSet, TagSetDelayed, UpSet, and UpSetDelayed. | | wolfram.newlinesBetweenSetDefinitions | integer | inherit | Blank lines inserted between adjacent Set-family definitions. | | wolfram.newlinesBetweenSetDelayedDefinitions | integer | inherit | Blank lines inserted between adjacent SetDelayed-family definitions. | | wolfram.newlinesBetweenSetAndSetDelayedDefinitions | integer | inherit | Blank lines inserted between mixed Set-family and SetDelayed-family definitions. | | wolfram.newlinesBetweenSameNameDefinitions | integer | 0 | Blank lines inserted between adjacent definitions that belong to the same symbol. | | wolfram.maxBlankLinesBetweenCode | integer | 1 | Maximum source blank lines preserved between non-definition code statements. | | wolfram.trailingNewline | boolean | false | Emits one trailing newline at the end of non-empty formatted files. | | wolfram.spaceAfterComma | boolean | true | Inserts a space after commas in argument lists, lists, and associations. | | wolfram.spaceAroundOperators | boolean | true | Inserts spaces around most infix, binary, and ternary operators. Operators that are normally tight, such as ::, ?, and ;;, stay tight. | | wolfram.alignRuleValues | boolean | false | Vertically aligns Rule and RuleDelayed values in multiline argument, list, and association layouts. | | wolfram.logicalOperatorsToFullForm | boolean | true | Rewrites overflowing logical infix chains, such as && and \|\|, as multiline function calls. | | wolfram.documentationCommentColumn | integer | 0 | Column for trailing documentation comments. 0 computes a column per contiguous block. | | wolfram.documentationCommentPadding | integer | 2 | Minimum spaces between code and an aligned trailing documentation comment when the column is computed automatically. | | wolfram.documentationCommentMarkers | boolean | false | Treats trailing comments beginning with .vsix.

For Marketplace pre-release publishing, use the workspace-safe publish wrapper:

The extension README with editor setup, settings, diagnostics, and file association behavior lives at vscode-extension/README.md.

Publishing To npm

Log in:

Preview package contents:

Publish:

Verify:

Description from the npm listing.