Skip to content

Add option to ignore attributes #49

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

Open

dchacke wants to merge 4 commits into Teamwork:master

from dchacke:ignore-attributes

Open

Add option to ignore attributes #49

Changes from 1 commit

Commits

Show all changes

Select commit Hold shift + click to select a range

Add option to ignore attributes

dchacke Sep 23, 2025

Add new ignoreAttributes option to Readme

dchacke Sep 23, 2025

Fix pretty and lint

dchacke Sep 23, 2025

Improve placing of ignoreAttributes throughout code

dchacke Sep 23, 2025

File filter

Filter by extension

Conversations

Jump to

Jump to file

Failed to load files.

Loading

Diff view

Diff view

Add new ignoreAttributes option to Readme

Loading branch information

dchacke committed Sep 23, 2025

commit 76f88b256e96f585f6f85a935c40f5491c7725e1

1 change: 1 addition & 0 deletions README.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,6 +36,7 @@ Changes to attributes of structural elements are treated as modifications (`vdd-
		- `modifiedClass: string = 'vdd-modified'` The class used for annotating content modifications.
		- `removedClass: string = 'vdd-removed'` The class used for annotating content removals.
		- `skipModified: boolean = false` If `true`, then formatting changes are NOT wrapped in `<ins class="vdd-modified">` and modified structural elements are NOT annotated with the `vdd-modified` class.
	- `ignoreAttributes: boolean = false` If `true`, then attribute names and values are ignored when comparing nodes.
		- `skipChildren: (node: Node): boolean \| undefined` Indicates if the child nodes of the specified `node` should be ignored. It is useful for ignoring child nodes of an element representing some embedded content, which should not be compared. Return `undefined` for the default behaviour.
		- `skipSelf: (node: Node): boolean \| undefined` Indicates if the specified `node` should be ignored. Even if the `node` is ignored, its child nodes will still be processed, unless `skipChildNodes` says they should also be ignored. Ignored elements whose child nodes are processed are treated as formatting elements. Return `undefined` for the default behaviour.
		- `diffText: (oldText: string, newText: string): Diff[]` A function to use for diffing serialized representations of DOM nodes, where each DOM element is represented by a single character from the Private Use Area of the Basic Multilingual Unicode Plane. The default implementation is case sensitive and inteligently merges related changes to make the result more user friendly. See the source code for more details, especially if you want to implement a custom `diffText` function.