feat: add transform option

[hansottowirtz]

Motivation

My use case is as follows:

function Wrapper({ node, children }) {
  const [show, setShow] = useState(false)
  
  return <>
    {show && children}
    <button onClick={() => setShow(s => !s)}>Toggle</button>
  </>
}

domToReact(nodes, {
  transform(node, reactNode) {
    return <Wrapper node={node}>{reactNode}</Wrapper>
  }
})

I want to wrap every element in a Wrapper. I don't think this is possible with replace as it "replaces" the elements, not wraps them, and I can't easily "pass through" the subtree.

If you think this PR is worth considering I will follow up with tests and extra documentation.

Checklist:

• Conventional Commits
• Tests
• Documentation
• Types

[remarkablemark]

@hansottowirtz Thanks for opening this PR! Do you mind amending your commit message so it passes commitlint?

git commit --amend -m "feat: add transform option"

Also, could you add tests and documentation?

[remarkablemark]

Looks good! Could you also document this option in README.md?

[codecov]

Codecov Report

Merging #987 (e76bf9a) into master (3c9c777) will not change coverage.
The diff coverage is 100.00%.

❗ Current head e76bf9a differs from pull request most recent head 259eca1. Consider uploading reports for the commit 259eca1 to get more accurate results

@@            Coverage Diff            @@
##            master      #987   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          174       177    +3     
  Branches        58        60    +2     
=========================================
+ Hits           174       177    +3     

Impacted Files	Coverage Δ
lib/dom-to-react.js	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[hansottowirtz]

Sorry for the many pushes, if I need to write more tests or documentation let me know :) I changed the order of arguments as well (reactNode, node, index) and added the index.

[remarkablemark]

Thanks for addressing the comments. I left a few more minor/nitpick comments.

[remarkablemark]

LGTM

[remarkablemark]

Release:

• chore(master): release 4.1.0 #988 (comment)