github.com/beevik/etree

Changes

• Improve efficiency of Element.Text and Element.Tail.

Changes

• Improve efficiency of Element.Text and Element.Tail.

Breaking changes

• To address a security issue, it was necessary to add a MaxDepth option to
  ReadSettings to limit the depth of XML trees during parsing. A generous
  default value of 1024 was chosen to avoid breaking most existing code.
  However, if your code is processing XML hierarchies with a depth greater
  than 1024, you will need to assign your Document a ReadSettings that has
  a MaxDepth set to a higher value.

Security Fixes

• Limited the depth of XML trees processed by all ReadFrom functions during
  parsing.
• Fixed a CompilePath index-out-of-range panic that could be caused by a
  missing path filter key.
• Sanitized the contents of XML text, comment, ProcInst and Directive tokens
  provided by the user.

Breaking changes

• To address a security issue, it was necessary to add a MaxDepth option to ReadSettings to limit the depth of XML trees during parsing. A generous default value of 1024 was chosen to avoid breaking most existing code. However, if your code is processing XML hierarchies with a depth greater than 1024, you will need to assign your Document a ReadSettings that has a MaxDepth set to a higher value.

Security Fixes

• Limited the depth of XML trees processed by all ReadFrom functions during parsing.
• Fixed a CompilePath index-out-of-range panic that could be caused by a missing path filter key.
• Sanitized the contents of XML text, comment, ProcInst and Directive tokens provided by the user.

Changes

• Added new iterator versions of existing functions that return slices of Element pointers: ChildElementsSeq, SelectElementsSeq, FindElementsSeq, and FindElementsPathSeq.
• Improved performance of functions that return a single element.
• Because of its use of iterators, this package now requires go 1.23 or later.

Changes

• Added new iterator versions of existing functions that return slices of Element pointers: ChildElementsSeq, SelectElementsSeq, FindElementsSeq, and FindElementsPathSeq.
• Improved performance of functions that return a single element.
• Because of its use of iterators, this package now requires go 1.23 or later.

Fixes

• Fixed a bug in InsertChildAt.

Fixes

• Fixed a bug in InsertChildAt.

Changes

• Added Element function CreateChild, which calls a continuation function
  after creating and adding a child element.

Fixes

• Removed a potential conflict between two ReadSettings values. When
  AttrSingleQuote is true, CanonicalAttrVal is forced to be false.

Changes

• Added Element function CreateChild, which calls a continuation function after creating and adding a child element.

Fixes

• Removed a potential conflict between two ReadSettings values. When AttrSingleQuote is true, CanonicalAttrVal is forced to be false.

Updates

• Minimal go version updated to 1.21.
• Default-initialized CharsetReader causes same result as NewDocument().
• When reading an XML document, attributes are parsed more efficiently.

Changes

• Minimal go version updated to 1.21.
• Default-initialized CharsetReader causes same result as NewDocument().
• When reading an XML document, attributes are parsed more efficiently.

New Features

• Add AutoClose option to ReadSettings.
• Add ValidateInput to ReadSettings.
• Add NotNil function to Element.
• Add NextSibling and PrevSibling functions to Element.

New Features

• Add AutoClose option to ReadSettings.
• Add ValidateInput to ReadSettings.
• Add NotNil function to Element.
• Add NextSibling and PrevSibling functions to Element.

New Features

• Add support for double-quotes in filter path queries.
• Add PreserveDuplicateAttrs to ReadSettings.
• Add ReindexChildren to Element.

Full Changelog: v1.2.0...v1.3.0

New Features

• Add support for double-quotes in filter path queries.
• Add PreserveDuplicateAttrs to ReadSettings.
• Add ReindexChildren to Element.

New Features

• Add the ability to write XML fragments using Token WriteTo functions.
• Add the ability to re-indent an XML element as though it were the root of the document.
• Add a ReadSettings option to preserve CDATA blocks when reading an XML document.

New Features

• Add the ability to write XML fragments using Token WriteTo functions.
• Add the ability to re-indent an XML element as though it were the root of the document.
• Add a ReadSettings option to preserve CDATA blocks when reading and XML document.

New Features

• Add the ability to preserve whitespace in leaf elements during indent.
• Add the ability to suppress a document-trailing newline during indent.
• Add choice of XML attribute quoting style (single-quote or double-quote).

Removed Features

• Removed the CDATA preservation change introduced in v1.1.3. It was implemented in a way that broke the ability to process XML documents encoded using non-UTF8 character sets.

New Features

• Add the ability to preserve whitespace in leaf elements during indent.
• Add the ability to suppress a document-trailing newline during indent.
• Add choice of XML attribute quoting style (single-quote or double-quote).

Removed Features

• Removed the CDATA preservation change introduced in v1.1.3. It was implemented in a way that broke the ability to process XML documents encoded using non-UTF8 character sets.

• XML reads now preserve CDATA sections instead of converting them to standard character data.

• Fixed a path parsing bug.
• The Element.Text function now handles comments embedded between character data spans.

• Updated go version in go.mod to 1.20

New Features

• New attribute helpers.
  • Added the Element.SortAttrs method, which lexicographically sorts an element's attributes by key.
• New ReadSettings properties.
  • Added Entity for the support of custom entity maps.
• New WriteSettings properties.
  • Added UseCRLF to allow the output of CR-LF newlines instead of the default LF newlines. This is useful on Windows systems.
• Additional support for text and CDATA sections.
  • The Element.Text method now returns the concatenation of all consecutive character data tokens immediately following an element's opening tag.
  • Added Element.SetCData to replace the character data immediately following an element's opening tag with a CDATA section.
  • Added Element.CreateCData to create and add a CDATA section child CharData token to an element.
  • Added Element.CreateText to create and add a child text CharData token to an element.
  • Added NewCData to create a parentless CDATA section CharData token.
  • Added NewText to create a parentless text CharData token.
  • Added CharData.IsCData to detect if the token contains a CDATA section.
  • Added CharData.IsWhitespace to detect if the token contains whitespace inserted by one of the document Indent functions.
  • Modified Element.SetText so that it replaces a run of consecutive character data tokens following the element's opening tag (instead of just the first one).
• New "tail text" support.
  • Added the Element.Tail method, which returns the text immediately following an element's closing tag.
  • Added the Element.SetTail method, which modifies the text immediately following an element's closing tag.
• New element child insertion and removal methods.
  • Added the Element.InsertChildAt method, which inserts a new child token before the specified child token index.
  • Added the Element.RemoveChildAt method, which removes the child token at the specified child token index.
• New element and attribute queries.
  • Added the Element.Index method, which returns the element's index within its parent element's child token list.
  • Added the Element.NamespaceURI method to return the namespace URI associated with an element.
  • Added the Attr.NamespaceURI method to return the namespace URI associated with an element.
  • Added the Attr.Element method to return the element that an attribute belongs to.
• New Path filter functions.
  • Added [local-name()='val'] to keep elements whose unprefixed tag matches the desired value.
  • Added [name()='val'] to keep elements whose full tag matches the desired value.
  • Added [namespace-prefix()='val'] to keep elements whose namespace prefix matches the desired value.
  • Added [namespace-uri()='val'] to keep elements whose namespace URI matches the desired value.

Bug Fixes

• A default XML CharSetReader is now used to prevent failed parsing of XML documents using certain encodings. (Issue).
• All characters are now properly escaped according to XML parsing rules. (Issue).
• The Document.Indent and Document.IndentTabs functions no longer insert empty string CharData tokens.

Deprecated

• Element
  • The InsertChild method is deprecated. Use InsertChildAt instead.
  • The CreateCharData method is deprecated. Use CreateText instead.
• CharData
  • The NewCharData method is deprecated. Use NewText instead.