organic/Cargo.toml

[package]
name = "organic"
version = "0.1.4"
authors = ["Tom Alexander <tom@fizz.buzz>"]
description = "An org-mode parser."
edition = "2021"
license = "0BSD"
repository = "https://code.fizz.buzz/talexander/organic"
readme = "README.md"
keywords = ["emacs", "org-mode"]
categories = ["parsing"]
resolver = "2"
include = [
  "LICENSE",
  "**/*.rs",
  "Cargo.toml"
]

[lib]
name = "organic"
path = "src/lib.rs"

[[bin]]
# This bin exists for development purposes only. The real target of this crate is the library.
name = "parse"
path = "src/main.rs"

[dependencies]
nom = "7.1.1"
opentelemetry = { version = "0.20.0", optional = true, default-features = false, features = ["trace", "rt-tokio"] }
opentelemetry-otlp = { version = "0.13.0", optional = true }
opentelemetry-semantic-conventions = { version = "0.12.0", optional = true }
tokio = { version = "1.30.0", optional = true, default-features = false, features = ["rt", "rt-multi-thread"] }
tracing = { version = "0.1.37", optional = true }
tracing-opentelemetry = { version = "0.20.0", optional = true }
tracing-subscriber = { version = "0.3.17", optional = true, features = ["env-filter"] }

[build-dependencies]
walkdir = "2.3.3"

[features]
default = []
compare = []
tracing = ["dep:opentelemetry", "dep:opentelemetry-otlp", "dep:opentelemetry-semantic-conventions", "dep:tokio", "dep:tracing", "dep:tracing-opentelemetry", "dep:tracing-subscriber"]

# Optimized build for any sort of release.
[profile.release-lto]
inherits = "release"
lto = true
strip = "symbols"

# Profile for performance testing with the "perf" tool. Notably keeps debug enabled and does not strip symbols to make reading the perf output easier.
[profile.perf]
inherits = "release"
lto = true
debug = true
Initial setup for the parser. 2022-07-16 03:26:49 +00:00			`[package]`
Fix package name. 2023-07-14 02:32:56 +00:00			`name = "organic"`
Publish version 0.1.4. 2023-08-30 03:28:17 +00:00			`version = "0.1.4"`
Add metadata for publishing crate. 2023-07-28 00:57:29 +00:00			`authors = ["Tom Alexander <tom@fizz.buzz>"]`
			`description = "An org-mode parser."`
Initial setup for the parser. 2022-07-16 03:26:49 +00:00			`edition = "2021"`
Add a license. 2022-07-17 22:45:51 +00:00			`license = "0BSD"`
Add metadata for publishing crate. 2023-07-28 00:57:29 +00:00			`repository = "https://code.fizz.buzz/talexander/organic"`
Bump version to 0.1.2 and change README to markdown. crates.io does not support org-mode for README files so I am changing this to markdown. 2023-08-11 04:00:49 +00:00			`readme = "README.md"`
Add metadata for publishing crate. 2023-07-28 00:57:29 +00:00			`keywords = ["emacs", "org-mode"]`
Fix package category. 2023-07-28 01:19:36 +00:00			`categories = ["parsing"]`
Disable all the old tracing stuff. 2023-08-11 00:01:00 +00:00			`resolver = "2"`
Explicitly list which files to include in the cargo package. We are including a bunch of files that are not needed for running the rust code. This excludes them to be a better citizen to both crates.io and all users of this package. 2023-08-11 04:11:54 +00:00			`include = [`
			`"LICENSE",`
			`"*/.rs",`
Publish version 0.1.4. 2023-08-30 03:28:17 +00:00			`"Cargo.toml"`
Explicitly list which files to include in the cargo package. We are including a bunch of files that are not needed for running the rust code. This excludes them to be a better citizen to both crates.io and all users of this package. 2023-08-11 04:11:54 +00:00			`]`
Initial setup for the parser. 2022-07-16 03:26:49 +00:00
Hook the integration tests into rust's test framework. Instead of using a hacked-together shell script, use rust's test framework to do the comparison. 2023-04-19 02:38:18 +00:00			`[lib]`
			`name = "organic"`
			`path = "src/lib.rs"`

Add the binary back in because we need it for generating jaeger traces. 2023-04-19 22:12:53 +00:00			`[[bin]]`
Remove all the old references to "toy language" This is a relic from the early development days in this repo. When I first started this repo, it was a clean-slate playground to test ideas for solving the road blocks I hit with my previous attempt at an org-mode parser. To keep things simple, I originally only had a very basic set of syntax rules that only vaguely looked similar to org-mode. Once I had things figured out, I kept developing in this repo, morphing it into a full org-mode parser. A couple of references to those early days still remained, and this patch should get rid of the last of them. 2023-08-10 22:51:16 +00:00			`# This bin exists for development purposes only. The real target of this crate is the library.`
Handle org-mode documents passed as args. We were running into issues where the documents grew too large for being passed as a string to emacs, and we need to handle #+setupfile so we need to start handling org-mode documents as files and not just as anonymous streams of text. The anonymous stream of text handling will remain because the automated tests use it. 2023-09-02 16:15:57 +00:00			`name = "parse"`
Add the binary back in because we need it for generating jaeger traces. 2023-04-19 22:12:53 +00:00			`path = "src/main.rs"`

Initial setup for the parser. 2022-07-16 03:26:49 +00:00			`[dependencies]`
			`nom = "7.1.1"`
New, updated opentelemetry tracing exporter. 2023-08-11 01:22:06 +00:00			`opentelemetry = { version = "0.20.0", optional = true, default-features = false, features = ["trace", "rt-tokio"] }`
			`opentelemetry-otlp = { version = "0.13.0", optional = true }`
			`opentelemetry-semantic-conventions = { version = "0.12.0", optional = true }`
			`tokio = { version = "1.30.0", optional = true, default-features = false, features = ["rt", "rt-multi-thread"] }`
Disable all the old tracing stuff. 2023-08-11 00:01:00 +00:00			`tracing = { version = "0.1.37", optional = true }`
New, updated opentelemetry tracing exporter. 2023-08-11 01:22:06 +00:00			`tracing-opentelemetry = { version = "0.20.0", optional = true }`
			`tracing-subscriber = { version = "0.3.17", optional = true, features = ["env-filter"] }`
Initial setup for the parser. 2022-07-16 03:26:49 +00:00
Hook the integration tests into rust's test framework. Instead of using a hacked-together shell script, use rust's test framework to do the comparison. 2023-04-19 02:38:18 +00:00			`[build-dependencies]`
			`walkdir = "2.3.3"`

Initial setup for the parser. 2022-07-16 03:26:49 +00:00			`[features]`
Publish version 0.1.3. 2023-08-30 03:03:20 +00:00			`default = []`
Add a feature for compare. 2023-04-10 17:38:31 +00:00			`compare = []`
New, updated opentelemetry tracing exporter. 2023-08-11 01:22:06 +00:00			`tracing = ["dep:opentelemetry", "dep:opentelemetry-otlp", "dep:opentelemetry-semantic-conventions", "dep:tokio", "dep:tracing", "dep:tracing-opentelemetry", "dep:tracing-subscriber"]`
Optimize the release build. This shaved a 7MB binary down to 2MB. 2023-04-19 04:22:25 +00:00
Add a script for testing organic parse times. This is not meant to produce publishable or comparable benchmarks. Such a script would have to run many iterations with the input already loaded into memory, proper prioritization via nice/ionice, and have a warm-up phase. This is just automating a basic test I am frequently running to compare parse times when investigating performance issues. 2023-08-27 20:51:44 +00:00			`# Optimized build for any sort of release.`
Add scripts for running perf and callgrind. 2023-08-21 05:26:52 +00:00			`[profile.release-lto]`
			`inherits = "release"`
Optimize the release build. This shaved a 7MB binary down to 2MB. 2023-04-19 04:22:25 +00:00			`lto = true`
			`strip = "symbols"`
Add scripts for running perf and callgrind. 2023-08-21 05:26:52 +00:00
Add a script for testing organic parse times. This is not meant to produce publishable or comparable benchmarks. Such a script would have to run many iterations with the input already loaded into memory, proper prioritization via nice/ionice, and have a warm-up phase. This is just automating a basic test I am frequently running to compare parse times when investigating performance issues. 2023-08-27 20:51:44 +00:00			`# Profile for performance testing with the "perf" tool. Notably keeps debug enabled and does not strip symbols to make reading the perf output easier.`
Add scripts for running perf and callgrind. 2023-08-21 05:26:52 +00:00			`[profile.perf]`
			`inherits = "release"`
			`lto = true`
			`debug = true`