Skip to content

formatter: Return statement with JSDoc type cast gets extra outer parentheses #20183

@Dunqing

Description

@Dunqing

Input

Found in sveltejs/svelte repo.

File: packages/svelte/src/internal/client/dom/elements/attributes.js

function get_attributes(element) {
	return /** @type {Record<string | symbol, unknown>} * */ (
		// @ts-expect-error
		element.__attributes ??= {
			[IS_CUSTOM_ELEMENT]: element.nodeName.includes('-'),
			[IS_HTML]: element.namespaceURI === NAMESPACE_HTML
		}
	);
}

Config

{
  "useTabs": true,
  "singleQuote": true,
  "trailingComma": "none",
  "printWidth": 100
}

Oxfmt output

function get_attributes(element) {
	return (
		/** @type {Record<string | symbol, unknown>} * */ (
			// @ts-expect-error
			element.__attributes ??= {
				[IS_CUSTOM_ELEMENT]: element.nodeName.includes('-'),
				[IS_HTML]: element.namespaceURI === NAMESPACE_HTML
			}
		)
	);
}

Prettier output

Prettier version: 3.8.1

function get_attributes(element) {
	return /** @type {Record<string | symbol, unknown>} * */ (
		// @ts-expect-error
		element.__attributes ??= {
			[IS_CUSTOM_ELEMENT]: element.nodeName.includes('-'),
			[IS_HTML]: element.namespaceURI === NAMESPACE_HTML
		}
	);
}

Additional notes

Oxfmt wraps the return value in extra parentheses return ( ... ) when the returned expression is a JSDoc type cast. Prettier keeps return /** @type {X} */ ( ... ) without the extra outer parens.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions