vallentin/comment-parser

This crate implements a (pull) parser for extracting comments from code in various programming languages.

Hello there!

I'm Christian Vallentin, a developer from Denmark with an MSc in Software Engineering.

comment-parser's Issues

feature request: obtain lines of the comments

It'd be nice to get more metadata on each comments. Right now I'm trying to understand what lines a comment start and end on

Return language in the `UnsupportedLanguage` error

Can we update the LanguageError enum so that UnsupportedLanguage also includes the Language that was detected (but not supported). Something like

pub enum LanguageError {
  UnknownLanguage,
  UnsupportedLanguage(String),
}

Happy to send a pull request if you like the idea.

YAML syntax is wrong (it's more like shell, than C)

Currently yaml is configured like so:

const SYNTAXES: [(&str, &[SyntaxRule]); 15] = [
    ..snip..
    ("yaml", &C),
]

const C: [SyntaxRule; 3] = [
    LineComment(b"//"),
    BlockComment(b"/*", b"*/"),
    String(b"\""),
];

The YAML spec says the only valid comment symbol is #, and that's a single line. I think the correct syntax would be:

const YAML: [SyntaxRule; 2] = [
    LineComment(b"#"),
    String(b"\""),
];