https://github.com/skiptools/skip-xml
https://github.com/skiptools/skip-xml
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/skiptools/skip-xml
- Owner: skiptools
- License: other
- Created: 2023-08-21T21:26:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-28T02:38:06.000Z (over 1 year ago)
- Last Synced: 2025-06-05T20:06:51.413Z (about 1 year ago)
- Language: Swift
- Size: 116 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.LGPL
Awesome Lists containing this project
README
SkipXML is a Skip framework that provides an XML Document parser.
On Swift/iOS it is implemented using `Foundation.XMLParser` and `Foundation.XMLParserDelegate`,
and on the Kotlin/Android side it uses `org.xml.sax.XMLReader` and `org.xml.sax.helpers.DefaultHandler`.
Documents are parsed into in-memory `XMLNode` structures as follows:
```swift
import SkipXML
func parseXML(data: Data) throws -> String {
let node = try XMLNode.parse(data: data, options: [.processNamespaces])
return node.xmlString() // returns the XML document as a string
}
```
## Building
This project is a Swift Package Manager module that uses the
[Skip](https://skip.tools) plugin to transpile Swift into Kotlin.
Building the module requires that Skip be installed using
[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
This will also install the necessary build prerequisites:
Kotlin, Gradle, and the Android build tools.
## Testing
The module can be tested using the standard `swift test` command
or by running the test target for the macOS destination in Xcode,
which will run the Swift tests as well as the transpiled
Kotlin JUnit tests in the Robolectric Android simulation environment.
Parity testing can be performed with `skip test`,
which will output a table of the test results for both platforms.
## License
This software is licensed under the
[GNU Lesser General Public License v3.0](https://spdx.org/licenses/LGPL-3.0-only.html),
with the following
[linking exception](https://spdx.org/licenses/LGPL-3.0-linking-exception.html)
to clarify that distribution to restricted environments (e.g., app stores)
is permitted:
> This software is licensed under the LGPL3, included below.
> As a special exception to the GNU Lesser General Public License version 3
> ("LGPL3"), the copyright holders of this Library give you permission to
> convey to a third party a Combined Work that links statically or dynamically
> to this Library without providing any Minimal Corresponding Source or
> Minimal Application Code as set out in 4d or providing the installation
> information set out in section 4e, provided that you comply with the other
> provisions of LGPL3 and provided that you meet, for the Application the
> terms and conditions of the license(s) which apply to the Application.
> Except as stated in this special exception, the provisions of LGPL3 will
> continue to comply in full to this Library. If you modify this Library, you
> may apply this exception to your version of this Library, but you are not
> obliged to do so. If you do not wish to do so, delete this exception
> statement from your version. This exception does not (and cannot) modify any
> license terms which apply to the Application, with which you must still
> comply.