Skip to content

feat: Support anonymous custom elements when pretty printing DOM #1319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2024
Merged

feat: Support anonymous custom elements when pretty printing DOM #1319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73ecce5
Support anonymous custom elements
KonnorRogers Jun 19, 2024
8206426
fix multiple registration warning
KonnorRogers Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions src/DOMElementFilter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,24 +158,30 @@ const FRAGMENT_NODE = 11

const ELEMENT_REGEXP = /^((HTML|SVG)\w*)?Element$/

const isCustomElement = (val: any) => {
const {tagName} = val
return Boolean(
(typeof tagName === 'string' && tagName.includes('-')) ||
(typeof val.hasAttribute === 'function' && val.hasAttribute('is')),
)
}

const testNode = (val: any) => {
const constructorName = val.constructor.name
const {nodeType, tagName} = val
const isCustomElement =
(typeof tagName === 'string' && tagName.includes('-')) ||
(typeof val.hasAttribute === 'function' && val.hasAttribute('is'))

const {nodeType} = val

return (
(nodeType === ELEMENT_NODE &&
(ELEMENT_REGEXP.test(constructorName) || isCustomElement)) ||
(ELEMENT_REGEXP.test(constructorName) || isCustomElement(val))) ||
(nodeType === TEXT_NODE && constructorName === 'Text') ||
(nodeType === COMMENT_NODE && constructorName === 'Comment') ||
(nodeType === FRAGMENT_NODE && constructorName === 'DocumentFragment')
)
}

export const test: NewPlugin['test'] = (val: any) =>
val?.constructor?.name && testNode(val)
(val?.constructor?.name || isCustomElement(val)) && testNode(val)

type HandledType = Element | Text | Comment | DocumentFragment

Expand All @@ -195,7 +201,8 @@ export default function createDOMElementFilter(
filterNode: (node: Node) => boolean,
): NewPlugin {
return {
test: (val: any) => val?.constructor?.name && testNode(val),
test: (val: any) =>
(val?.constructor?.name || isCustomElement(val)) && testNode(val),
serialize: (
node: HandledType,
config: Config,
Expand Down
31 changes: 31 additions & 0 deletions src/__tests__/pretty-dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,34 @@ test('prettyDOM supports a COLORS environment variable', () => {
process.env.COLORS = 'true'
expect(prettyDOM(container)).toEqual(withColors)
})

test('prettyDOM supports named custom elements', () => {
window.customElements.define(
'my-element-1',
class MyElement extends HTMLElement {},
)

const {container} = render('<my-element-1>Hello World!</my-element-1>')

expect(prettyDOM(container)).toMatchInlineSnapshot(`
<div>
<my-element-1>
Hello World!
</my-element-1>
</div>
`)
})

test('prettyDOM supports anonymous custom elements', () => {
window.customElements.define('my-element-2', class extends HTMLElement {})

const {container} = render('<my-element-2>Hello World!</my-element-2>')

expect(prettyDOM(container)).toMatchInlineSnapshot(`
<div>
<my-element-2>
Hello World!
</my-element-2>
</div>
`)
})
Loading