Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/f34nk/tidy_ex
Elixir binding to the granddaddy of HTML tools
https://github.com/f34nk/tidy_ex
elixir html-par html-ren html-repair html5
Last synced: about 2 months ago
JSON representation
Elixir binding to the granddaddy of HTML tools
- Host: GitHub
- URL: https://github.com/f34nk/tidy_ex
- Owner: f34nk
- License: lgpl-2.1
- Created: 2018-04-26T12:59:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-14T11:10:16.000Z (4 months ago)
- Last Synced: 2024-04-15T11:36:46.810Z (2 months ago)
- Topics: elixir, html-par, html-ren, html-repair, html5
- Language: C
- Homepage: http://www.html-tidy.org/
- Size: 868 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-elixir - tidy_ex - Elixir binding to the granddaddy of HTML tools [http://www.html-tidy.org](http://www.html-tidy.org). (HTML)
- freaking_awesome_elixir - C - Elixir binding to the granddaddy of HTML tools [http://www.html-tidy.org](http://www.html-tidy.org). (HTML)
- fucking-awesome-elixir - tidy_ex - Elixir binding to the granddaddy of HTML tools [http://www.html-tidy.org](http://www.html-tidy.org). (HTML)
README
# This project is not maintained anymore.
[](https://travis-ci.org/f34nk/tidy_ex)
[](https://hex.pm/packages/tidy_ex)
[](https://hex.pm/packages/tidy_ex)
# TidyEx
TidyEx corrects and cleans up HTML content by fixing markup errors.
Elixir/Erlang bindings for htacg's **tidy-html5**
>The granddaddy of HTML tools, with support for modern standards [http://www.html-tidy.org](http://www.html-tidy.org)
- [tidy-html5](https://github.com/htacg/tidy-html5)
The binding is implemented as a **C-Node** following the excellent example in Overbryd's package **nodex**. If you want to learn how to set up bindings to C/C++, you should definitely check it out.
- [nodex](https://github.com/Overbryd/nodex)
- distributed Elixir
- save binding with C-Nodes
>C-Nodes are external os-processes that communicate with the Erlang VM through erlang messaging. That way you can implement native code and call into it from Elixir in a safe predictable way. The Erlang VM stays unaffected by crashes of the external process.
## Example
For more examples please checkout [tests](https://github.com/f34nk/tidy_ex/tree/master/test).
```elixir
test "can parse broken html" do
result = TidyEx.parse("
HelloWorld")
assert result == "HelloWorld
"
end
test "can clean and repair broken html" do
result = TidyEx.clean_and_repair("
HelloWorld")
assert result == "HelloWorld
"
end
test "can run diagnostics on invalid html" do
result = TidyEx.run_diagnostics("Hello World")
assert result == "line 1 column 1 - Error: is not recognized!\nThis document has errors that must be fixed before\nusing HTML Tidy to generate a tidied up version."
end
```
## Installation
Available on [hex](https://hex.pm/packages/tidy_ex).
```elixir
def deps do
[
{:tidy_ex, "~> 0.1.0-dev"}
]
end
```
## Target dependencies
```
cmake 3.x
erlang-dev
erlang-xmerl
erlang-parsetools
```
## Compile and test
```
mix deps.get
mix compile
mix test
```
## Cloning
```
git clone [email protected]:f34nk/tidy_ex.git
cd tidy_ex
```
All binding targets are added as submodules in the `target/` folder.
```
git submodule update --init --recursive --remote
mix deps.get
mix compile
mix test
mix test.target
```
Cleanup
```
mix clean
```
## Roadmap
See [CHANGELOG](https://github.com/f34nk/tidy_ex/blob/master/CHANGELOG.md).
- [ ] Bindings
- [x] Call as C-Node
- [ ] Call as dirty-nif
- [ ] Tests
- [ ] Call as C-Node
- [ ] Call as dirty-nif
- [x] Target tests
- [x] Feature tests
- [x] Package test
- [ ] Features
- [x] Set tidy-html5 options
- [x] Serialize any string with valid or broken html
- [x] Clean and repair
- [x] Run diagnostics
- [ ] Documentation
- [x] Publish as hex package
## Icon Credit
Broom by faisalovers from the Noun Project