[clutz-bot]

Adds a headless option to BuildOptions that omits the XML declaration (<?xml ...?>) and DOCTYPE from the output. Useful for embedding plist fragments.

Works in both Node.js (xmlbuilder) and browser (native) code paths.

Supersedes #159 — implements the alternative API suggested in the code review comments (implementation-agnostic BuildOptions property instead of exposing xmlbuilder-specific types).

Usage

import { build } from 'plist';

build({ foo: 'bar' }, { headless: true });
// <plist version="1.0">
//   <dict>
//     <key>foo</key>
//     <string>bar</string>
//   </dict>
// </plist>

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
plist-playground	Ready	Preview	Nov 6, 2026 7:41pm UTC

[changeset-bot]

🦋 Changeset detected

Latest commit: 1c4d557

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
plist	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[dnicolson]

This approach seems overly restrictive, as it only exposes the headless xmlbuilder create option. It’s also unclear what problem this is intended to solve.

The advantage of #159 is that it supports all xmlbuilder.CreateOptions settings while remaining a non-breaking change, since it only adds an optional parameter. It also enables use of the invalidCharReplacement option, which is not currently configurable.

[TooTallNate]

@dnicolson did you see this comment?

[dnicolson]

@TooTallNate I did, but it was largely contradicted by the next comment.

[dnicolson]

This headless option could be added on top of #181. This PR incorrectly passes headless to both xmlbuilder.create() and doc.end(), but the latter expects the type xmlbuilder.XMLToStringOptions.