fix(napi-derive): panic while creating type definition when Rust comment contains escape syntax

[Brooooooklyn]

• Close JSON parse fails while creating type definition when Rust comment contains escape syntax #2502

[Brooooooklyn]

• fix(napi-derive): panic while creating type definition when Rust comment contains escape syntax #2701 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[Brooooooklyn]

bugbot run

[cursor]

Bug: Unintended Newline Replacement in Documentation

The replace(/\\n/g, '\n') operation unconditionally replaces literal \n sequences with actual newlines in js_doc and def fields. This incorrectly transforms instances where developers intend to display the literal text \n in documentation comments or type definitions, rather than an actual newline.

cli/src/utils/typegen.ts#L145-L154

napi-rs/cli/src/utils/typegen.ts

Lines 145 to 154 in 3d5f00d

	// Convert escaped newlines back to actual newlines in js_doc fields
	if (parsed.js_doc) {
	parsed.js_doc = parsed.js_doc.replace(/\\n/g, '\n')
	}
	// Convert escaped newlines to actual newlines in def fields for struct/class/interface/type types
	// where \n represents method/field separators that should be actual newlines
	if (parsed.def) {
	parsed.def = parsed.def.replace(/\\n/g, '\n')
	}
	return parsed

Fix in Cursor

---

BugBot free trial expires on June 14, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎