BibTex Parser 3 Roadmap

[renanbr]

Goals

• make the code source more modern
• improve code source readability
• improve documentation

Topics

• entries as object Entry instead of array
  • an immutable object
  • do not mix up tags with non-tag stuff, it means provide these methods in Entry class:
    • getCitationKey(): string
    • getType(): string
    • getOriginal(): string
    • getTag(string $name): Stringable (PHP 8.0)
      • processors may return a "stringable" ArrayIterator for lists (e.g. keywords, author)
• create a ProcessorInterface
  • type-hint processor's argument and return as Entry (PHP 7.0)
• instantiate a default Listener in Parser
  • provide a way to clear listeners in Parser
• don't leak abbreviation among files (bug in v2?)
  • trigger Listeners when Parser reaches the end of a file (or string input)
• place interfaces under an unified namespace
• stricter static analysis check
• more examples in documentation
  • how to integrate this library with the most popular frameworks

[renanbr]

closing in favour of #96