Merge pull request #49 from mp4096/nom-5

The Great Refactor: Migrate to nom 5 and Make Parsers Readable Again
mp4096 · Jun 10, 2019 · cdcb979 · cdcb979
2 parents e265e63 + c46ab5b
commit cdcb979
Show file tree

Hide file tree

Showing 12 changed files with 1,673 additions and 562 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,24 @@
 :warning: Before the 1.0 release, we only document minor releases here!
 
+# 0.5.0-beta
+[PR #49](https://github.com/mp4096/indentex/pull/49)
+
+### :warning: Breaking changes
+
+* No backslashes are now allowed in the command name part.
+
+| Indentex source  | Transpiled with `0.4.0`         | Transpiled with `0.5.0`     |
+|:-----------------|:--------------------------------|:----------------------------|
+| `# foo\bar: baz` | `\foo\bar{baz}`                 | `\foo\bar{baz}`             |
+| `# foo\bar:`     | `\begin{foo\bar}⏎\end{foo\bar}` | `\begin{foo}\bar⏎\end{foo}` |
+
+### Non-breaking changes
+
+* Migrated to nom 5
+* Changed parsing logic
+* Refactor code
+* Add unit tests
+
 # 0.4.0 (2017-02-18)
 Commit 2adba137618d72c0251ddedfbbe01cc076536ce7
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "indentex"
-version = "0.4.0"
+version = "0.5.0-beta"
 authors = ["Mikhail Pak <code@mp4096.com>", "Hans Kirchner <h.kirchner@tum.de>"]
 license = "MIT"
 description = "Transpiler for an indentation-based superset of LaTeX"
@@ -15,7 +15,7 @@ edition = "2018"
 clap = "^2.33.0"
 globset = "^0.4.2"
 ignore = "^0.4.7"
-nom = "^3.2.1"
+nom = "^5.0.0-beta2"
 rayon = "^1.0.2"
 
 
@@ -27,7 +27,7 @@ debug-assertions = false
 
 [package.metadata.deb]
 maintainer = "Mikhail Pak <code@mp4096.com>"
-copyright = "2016-2018, Mikhail Pak <code@mp4096.com>, Hans Kirchner <h.kirchner@tum.de>"
+copyright = "2016-2019, Mikhail Pak <code@mp4096.com>, Hans Kirchner <h.kirchner@tum.de>"
 license_file = ["LICENSE.md", "6"]
 extended_description = "A transpiler for an indentation-based superset of LaTeX."
 depends = "$auto"

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,8 +1,8 @@
 MIT License
 
-Copyright (c) 2016-2018 Mikhail Pak
+Copyright (c) 2016-2019 Mikhail Pak
 
-Copyright (c) 2016-2018 Hans Kirchner
+Copyright (c) 2016-2019 Hans Kirchner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ which can be used further in your toolchain, sent to a publisher or your colleag
 ## Installation
 
 ### From source
-Please install the latest stable Rust version (≥ 1.30).
+Indentex requires Rust 2018 edition. Please install the latest stable Rust version (≥ 1.31.1).
 
 ```sh
 cargo install --git https://github.com/mp4096/indentex/
@@ -30,8 +30,8 @@ cargo install --git https://github.com/mp4096/indentex/
 Type `indentex -h` for help:
 
 ```
-indentex 0.4.0
-Mikhail Pak <mikhail.pak@tum.de>:Hans Kirchner <h.kirchner@tum.de>
+indentex 0.5.0-beta
+Mikhail Pak <code@mp4096.com>:Hans Kirchner <h.kirchner@tum.de>
 Transpiler for an indentation-based superset of LaTeX
 
 USAGE:

diff --git a/src/helper_parsers.rs b/src/helper_parsers.rs
diff --git a/src/main.rs b/src/main.rs
@@ -1,13 +1,7 @@
-#[macro_use]
-extern crate nom;
-
-// Import helper macros before `parsers`
-#[macro_use]
-mod helper_parsers;
-
 mod error;
 mod file_utils;
 mod parsers;
+mod parsing_types;
 mod transpile;
 
 enum ReturnCode {