coffeescript/init.lua

CoffeeScript

 





  

    
  

  
A coffeescript module for the
Textadept editor.
It provides utilities for editing
CoffeeScript code.

It contains additional key commands, indentation support and
snippets, the latter based on Jeremy Ashkenas'
Textmate bundle.



The source is on
GitHub,
released under the
MIT license.



Installation



Clone the git repository to your .textadept directory:



cd ~/.textadept/modules
git clone \
  https://github.com/rgieseke/ta-coffeescript.git coffeescript





  
local M = {}






  

    
  

  
Settings




  





  

    
  

  
Check the syntax after saving a file using the --lint option of the
CoffeeScript executable. This requires the jsl
(JavaScript Lint) command
to be installed.




  
M.CHECK_SYNTAX = true






  

    
  

  
Sets default buffer properties for CoffeeScript files. A default indent of
4 spaces is used.




  
events.connect(events.LEXER_LOADED, function(lang)
  if lang == 'coffeescript' then buffer.tab_width = 4 end
end)






  

    
  

  
Commands.




  





  

    
  

  
Check syntax after file saving.




  
events.connect(events.FILE_AFTER_SAVE,
  function() -- show syntax errors as annotations
    if M.CHECK_SYNTAX and buffer:get_lexer() == 'coffeescript' then
      local buffer = buffer
      buffer:annotation_clear_all()
      local filename = buffer.filename:iconv(_CHARSET, 'UTF-8')
      local command = 'coffee -c -l '..filename
      local p = io.popen(command..' 2>&1')
      local out = p:read('*all')
      p:close()
      if out then
        local line, msg = out:match('.-:(%d+):%d-:(.+)')
        if line then
          line = line - 1 -- Scintilla line numbers start from 0.
          buffer.annotation_visible = 2






  

    
  

  
If error is off screen, show annotation on the current line.




  
          if (line < buffer.first_visible_line) or
             (line > buffer.first_visible_line + buffer.lines_on_screen) then
            msg = 'line '..(line + 1)..'\n'..msg
            line = buffer.line_from_position(buffer.current_pos)
          end
          buffer.annotation_style[line] = 8 -- error style number
          buffer.annotation_text[line] = msg
        end
      end
    end
  end)






  

    
  

  
Control structures after which indentation should be increased. Loops can
be used as an expression, so the pattern need to start with a variable
name, see
Loops and Comprehensions.




  
local control_structure_patterns = {
  '^%s*class',
  '^%s*%w*%s?=?%s?for',
  '^%s*if',
  '^%s*else',
  '^%s*switch',
  '^%s*when',
  '^%s*%w*%s?=?%s?while',
  '^%s*until',
  '^%s*loop',
  '^%s*try',
  '^%s*catch',
  '^%s*finally',
  '[%-=]>[\r\n]$',
  '[=:][\r\n]$'
}






  

    
  

  
Increase indentation level after new line if line contains class,
for, etc., but only if at the end of a line.




  
local function indent()
  local buffer = buffer
  if buffer:auto_c_active() then return false end
  local current_pos = buffer.current_pos
  local line_num = buffer:line_from_position(current_pos)
  local col = buffer.column[current_pos]
  if col == 0 or buffer.current_pos ~= buffer.line_end_position[line_num] then
    return false
  end
  local line = buffer:get_line(line_num)
  local line_indentation = buffer.line_indentation
  for _, patt in ipairs(control_structure_patterns) do
    if line:find(patt) then
      local indent = line_indentation[line_num]
      buffer:begin_undo_action()
      buffer:new_line()
      line_indentation[line_num + 1] = indent + buffer.indent
      buffer:line_end()
      buffer:end_undo_action()
      return true
    end
  end
  return false
end






  

    
  

  
Insert clipboard content enclosed in backticks for raw JavaScript.




  
function M.insert_raw_js(args)
  local buffer = buffer
  buffer:begin_undo_action()
  buffer:add_text('``')
  buffer:char_left()
  buffer:paste()
  buffer:char_right()
  buffer:end_undo_action()
end






  

    
  

  
Insert heredoc.

Parameter:

char: ", ' or #




  
function M.insert_heredoc(char)
  local buffer = buffer
  buffer:begin_undo_action()
  local current_pos = buffer.current_pos
  local indentation = buffer.column[current_pos]
  local space = string.rep(" ", indentation)
  buffer:add_text(char:rep(3).."\n"..space.."\n"..space..char:rep(3))
  buffer:line_up()
  buffer:end_undo_action()
end







  

    
  

  
Key Commands




  





  

    
  

  
CoffeeScript-specific key commands.

On the Mac the Command key is used instead of Alt.




  
keys.coffeescript = {






  

    
  

  
Open this module for editing:

 Language module prefix (usually Alt/⌘+L), M




  
  [keys.LANGUAGE_MODULE_PREFIX] = {
    m = { io.open_file,
          (_USERHOME..'/modules/coffeescript/init.lua'):iconv('UTF-8', __CHARSET) },
    },






  

    
  

  
Insert clipboard contents enclosed in backticks for raw
JavaScript: Ctrl+J




  
  cj =  insert_raw_js,
  ['\n'] = indent,






  

    
  

  
Insert heredoc: Ctrl+Alt/⌘+"




  
  [not OSX and 'ca"' or 'cm"'] = { M.insert_heredoc, '"' },






  

    
  

  
Insert heredoc: Ctrl+Alt/⌘+'




  
  [not OSX and "ca'" or "cm'"] = { M.insert_heredoc, "'" },






  

    
  

  
Insert block comment: Ctrl+#




  
  ['c#'] = { M.insert_heredoc, '#' },
}






  

    
  

  
Snippets.




  





  

    
  

  
Container for CoffeeScript-specific snippets.




  
if type(snippets) == 'table' then
  snippets.coffeescript = {






  

    
  

  
Bound function.




  
    bfun = "%1((%2(args)) )=>\n\t%0",






  

    
  

  
Class.




  
    cla = [[
class %1(ClassName)%2( extends %3(Ancestor))
	%4(constructor: (%5(args)) ->
		%6(# body...))
	%0]],






  

    
  

  
Else if.




  
    elif = "else if %1(condition)\n\t",






  

    
  

  
Function.




  
    fun = [[
%1(name) = (%2(args)) ->
	%0]],






  

    
  

  
If … else.




  
    ife = [[
if %1(condition)
	%2
else
	%0]],






  

    
  

  
If.




  
    ['if'] = [[
if %1(condition)
	%0]],






  

    
  

  
Interpolated code in double-quoted strings.




  
  ['#'] = "#{ %0 }",






  

    
  

  
Array comprehension.




  
  fora = "for %1(name) in %2(array)\n\t%0",






  

    
  

  
Object comprehension.




  
  foro = "for %1(key), %2(value) of %3(Object)\n\t%0",






  

    
  

  
Range comprehension (exclusive).




  
  forrex = "for %1(name) in [%2(start)...%3(finish)]%4( by %5(step))\n\t%0",






  

    
  

  
Range comprehension (inclusive).




  
  forr = [[
for %1(name) in [%2(start)..%3(finish)]%4( by %5(step))
	%0]],






  

    
  

  
Switch.




  
  swi = [[
switch %1(object)
	when %2(value)
		%0]],






  

    
  

  
Ternary if.




  
  ifte = "if %1(condition) then %2(value) else %0",






  

    
  

  
Try … catch.




  
  try = [[
try
	%1
catch %2(error)
	%0]],






  

    
  

  
Unless.




  
  unl = "%1(action) unless %0",






  

    
  

  
Console.log.




  
  log = "console.log",
  c = "console.log",






  

    
  

  
Require.




  
  req = "require",
  }
end

return M