Add transformTagName to the XMLBuilder

Open
#4 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
tooling

Research direction

Start at the XMLBuilder entry point and compare its tag-name handling with XMLParser's existing transformTagName option. Add the builder option so the example uppercases child tags, then verify the generated XML matches the documented output.

Written by the indexing model from the issue text.

Description

enhancement

XMLParser has option transformTagName, which allows to mutate tag names on parsing. Similar option would be very useful for XMLBuilder too.

Example usecase:

const builder = new XMLBuilder({
  arrayNodeName: 'book',
  transformTagName: (tag) => tag.toUpperCase()
})

const xml = builder.build([{ author: 'Joe Doe', title: 'Great book'}]);

would produce:

<book>
  <AUTHOR>Joe Doe</AUTHOR>
  <TITLE>Great book</TITLE>
</book>

Would you like to work on this issue?

  • Yes
  • No
Dominant language
JavaScript
Stars
22
Forks
9
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NaturalIntelligence/fast-xml-builder

All issues in NaturalIntelligence/fast-xml-builder

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.