ruby-method-locate

ruby-method-locate

Finds position of ruby methods/modules/classes in a file. Intended for use in code editors.

const rubyLocate = require('ruby-method-locate');

rubyLocate('./main.rb').then(result => {
  // ...
}).catch( failure => {
  // some file access error
});

If main.rb contains:

module MyModule
  class MyClass
    def initialize
    end

    def call
    end
  end
end

the locator will return a promise which resolves with:

{ module:
  { MyModule:
      { posn: { line: 0, char: 7 },
        class:
        { MyClass:
            { posn: { line: 1, char: 8 },
              method:
              { initialize: { posn: { line: 2, char: 8 } },
                call: { posn: { line: 5, char: 8 } }
              } } } } } }

returns undefined if there are no modules, classes or methods in the file.