#parser #yaml #sqlite #wurst #pom

app wurstdoktor

A wurst to yaml parser for public sourcecode documentation

2 unstable releases

✓ Uses Rust 2018 edition

0.2.0 Jul 11, 2019
0.1.0 Jul 4, 2019

#106 in Parser implementations

9 downloads per month

MIT/Apache

90KB
1.5K SLoC

A parser for public wurstlang docs.

Read the published docs here.

Usage

  • cargo run -- --help
  • cargo run < file.wurst > out.yaml
  • find ../WurstStdlib2/ -name '*.wurst' | xargs -I {} bash -c "cargo run < {}"
  • cargo run -- --sqlite < file.wurst | sqlite3 fromdump.db
  • cargo run --features "sqlitedb" -- --sqlitedb < file.wurst

TODO

  • Use pom for parsing
  • Parse package-level docs
  • Parse public enums
  • Parse public classes
  • version and publish to crates.io
  • Parse public interfaces
  • Parse public functions
  • Parse document with multiple public elements
  • Generate yaml result set
  • I/O and help text
  • publish parsed stdlib2
  • emit sqlite
  • emit sqlitedb with feature gate
  • emit json
  • consume published stdlib2 doktor
  • support non-function public class members
  • sample html in lexical order
  • sample html icons could look better
  • sample html don't print "null"
  • sample html indents stuff inside classes
  • sample html better css
  • alt sample html w/o js
  • sample html queryable from IRC
  • sample html link to element
  • publish documentation

Dependencies

~5MB
~81K SLoC