Class: Linguist::Shebang

Inherits:
Object
  • Object
show all
Defined in:
lib/linguist/shebang.rb

Class Method Summary collapse

Class Method Details

.call(blob, candidates) ⇒ Object

Public: Use shebang to detect language of the blob.

blob - An object that quacks like a blob. candidates - A list of candidate languages.

Examples

Shebang.call(FileBlob.new("path/to/file"))

Returns an array of languages from the candidate list for which the blob’s shebang is valid. Returns an empty list if there is no shebang. If the candidate list is empty, any language is a valid candidate.



15
16
17
18
19
20
 
# File 'lib/linguist/shebang.rb', line 15

def self.call(blob, candidates)
  return [] if blob.symlink?

  languages = Language.find_by_interpreter interpreter(blob.data)
  candidates.any? ? candidates & languages : languages
end

.interpreter(data) ⇒ Object

Public: Get the interpreter from the shebang

Returns a String or nil



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/linguist/shebang.rb', line 25

def self.interpreter(data)
  shebang = data.lines.first

  # First line must start with #!
  return unless shebang && shebang.start_with?("#!")

  s = StringScanner.new(shebang)

  # There was nothing after the #!
  return unless path = s.scan(/^#!\s*\S+/)

  # Keep going
  script = path.split('/').last

  # if /usr/bin/env type shebang then walk the string
  if script == 'env'
    s.scan(/\s+/)
    s.scan(/.*=[^\s]+\s+/) # skip over variable arguments e.g. foo=bar
    script = s.scan(/\S+/)
  end

  # Interpreter was /usr/bin/env with no arguments
  return unless script

  # "python2.6" -> "python2"
  script.sub!(/(\.\d+)$/, '')

  # #! perl -> perl
  script.sub!(/^#!\s*/, '')

  # Check for multiline shebang hacks that call `exec`
  if script == 'sh' &&
    data.lines.first(5).any? { |l| l.match(/exec (\w+).+\$0.+\$@/) }
    script = $1
  end

  File.basename(script)
end