Skip to content

Break up the comment parsing to smaller module #251

@alpaca-tc

Description

@alpaca-tc

I want to break up the comment parsing in watson-ruby to smaller module. There are three reasons for this.

  • First, extracting comments from a file which contains compound filetype is complex.
  • Second, watson-ruby can not read shebang and detect filetype without extension.
  • Third, Watson's way to extract comments from a file has many incorrect detection.

They are the reasons why I present a suggestion.


Currently I am writing the gem called CommentExtractor. It can easily extract comments from a file as follows.

path = 'path/to/file'
if parser = CommentExtractor::Parser.for(path)
  comments = parser.parse

  comments.each do |c|
    puts "#{c.file}:#{c.line} - #{c.value}" #=> "path/to/file:2 - I am comment"
  end
end

If watson-ruby merged CommentExtractor, it becomes that easier to extract comments.
Let me know if you have any opinion, suggestions or problems on my suggestion.


links

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions