Documented the linter and LiveCode Script grammar. Moved to using the server engine and added support to the linter for tagged server files (iRev). Added myself as an author

Monte Goulding · Monte Goulding · commit bd57d382a3b1 · 2015-09-17T09:50:29.000+10:00
diff --git a/README.md b/README.md
@@ -19,13 +19,19 @@ Currently, this package supports editing:
 
 * LiveCode Builder source code in `.lcb` files
 * LiveCode server source code in `.lc` and `.irev` files
+* LiveCode Script source code in `.livecodescript` files, where the shebang line
+contains `livecode` or the first line contains an Emacs mode comment
+`# -*- mode:livecodescript -*-`
 
 The package provides syntax highlighting, highlighting and indentation support
 for all the supported languages.
 
 It also provides snippets to enhance LiveCode server script and revIgniter
 script development.
 
+For LiveCode Script there are quite a number of autocomplete snippets generated
+from the LiveCode documentation.
+
 ## Installation
 
 Install the `language-livecode` package from the "Install Packages and Themes"
@@ -34,11 +40,30 @@ view in Atom's "Settings" window.
 You may also wish to install the [revIgniter theme](https://atom.io/themes/revigniter-syntax)
 for Atom.
 
+## Script Error Checking
+
+This package provides a linter for LiveCode Script and Server to highlight and describe
+script compilation errors on the fly.
+
+Dependencies:
+
+ * The [linter package](https://atom.io/packages/linter) needs to be installed
+ * LiveCode Server engine for the platform it is being run on must be accessible
+
+The default setting assumes you have installed the LiveCode Server engine somewhere
+on the current `$PATH` with the name `livecode-server`. However, you can enter any
+path or name you choose via the package settings.
+
+For LiveCode Server the linter will only check for errors within the scope of
+the file being edited. If for example a variable re-declarition error is caused
+by the inclusion of another file that error won't be detected.
+
 ## Authors
 
 * Ralf Bitter
 * Peter Brett
 * Adam Robertson
+* Monte Goulding
 
 ## Reporting bugs and contributing
 
diff --git a/grammars/livecodescript.cson b/grammars/livecodescript.cson
@@ -6,7 +6,7 @@
 'fileTypes': [
   'livecodescript'
 ]
-'firstLineMatch': '^#!.*\\b(livecode|/usr/bin/env livecode)|^#\\s*-\\*-[^*]*mode:\\s*livecodescript[^*]*-\\*-'
+'firstLineMatch': '^#!.*\\b(livecode)|^#\\s*-\\*-[^*]*mode:\\s*livecodescript[^*]*-\\*-'
 'patterns': [
   {
     include: "#language"
diff --git a/lib/main.coffee b/lib/main.coffee
@@ -4,16 +4,16 @@ module.exports =
   config:
     executablePath:
       type: 'string'
-      title: 'LiveCode Standalone Engine Path'
-      default: 'livecode' # Let OS's $PATH handle the rest
+      title: 'LiveCode Server Engine Path'
+      default: 'livecode-server' # Let OS's $PATH handle the rest
 
   activate: ->
     @subscriptions = new CompositeDisposable
     @subscriptions.add atom.config.observe 'language-livecode.executablePath',
       (executablePath) =>
         @executablePath = executablePath
     path = require 'path'
-    @linterPath = path.join(__dirname, '..', 'tools', 'Linter.livecodescript')
+    @linterPath = path.join(__dirname, '..', 'tools', 'Linter.lc')
 
   deactivate: ->
     @subscriptions.dispose()
@@ -28,7 +28,6 @@ module.exports =
           filePath = textEditor.getPath()
           command = @executablePath
           parameters = []
-          parameters.push('-ui')
           stackfile = @linterPath
           parameters.push(stackfile)
           scope = '-scope=' + textEditor.getRootScopeDescriptor()
diff --git a/tools/GenerateSnippets.livecodescript b/tools/GenerateSnippets.livecodescript
@@ -9,7 +9,7 @@ on mouseUp
    if the short name of the target is "Generate Snippets" then
       put  "# GENERATED SNIPPETS START" & cr & \
             "'.source.livecodescript':" & cr & \
-            tab & "autocomplete:" & cr & \	
+            tab & "autocomplete:" & cr & \
             tab & tab & "symbols:" & cr & \
             tab & tab & tab & "builtins:" & cr & \
             tab & tab & tab & tab & "suggestions: [" into theSnippets
@@ -24,21 +24,21 @@ on mouseUp
             delete word 1 of theSyntax
             replace "[" with empty in theSyntax
             replace "]" with empty in theSyntax
-            
+
             -- parameters
             put empty into theFunctionName
             put empty into theParameters
             if theSyntax contains "(" then
                get MatchText(theSyntax,"(?i)^(.*)\((.*)\)",theFunctionName,theParameters)
-               
+
                if theParameters is empty then
                   next repeat
                end if
-               
+
                put theFunctionName into thePrefix
-               
+
                put theFunctionName&"(" into theBody
-               
+
                if theParameters is not empty then
                   replace "<" with "" in theParameters
                   replace ">" with "" in theParameters
@@ -52,11 +52,11 @@ on mouseUp
                else
                   put ")" after theBody
                end if
-               
+
                AddSnippet theSnippets, theFunctionName, theBody, "function", theDescription, theFile
-               
+
             else
-               
+
                if theSyntax contains "of" then
                   put word 2 to -4 of theSyntax into theOptions
                   put word -3 of theSyntax into theFunctionName
@@ -69,7 +69,7 @@ on mouseUp
                   put word 2 to -2 of theSyntax into theOptions
                   put word -1 of theSyntax into theFunctionName
                end if
-               
+
                if theOptions contains "|" then
                   split theOptions with "|"
                   repeat with theIndex = 1 to the number of elements of theOptions
@@ -88,7 +88,7 @@ on mouseUp
             end if
          end repeat
       end repeat
-      
+
       # messages
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/message"
       repeat for each line theFile in the files
@@ -117,12 +117,12 @@ on mouseUp
             if the last char of theSyntax is comma then
                delete the last char of theSyntax
             end if
-            
+
             put theSyntax & cr & tab & "${1:/* code */ }" & cr & "end" && theMessageName into theBody
             AddSnippet theSnippets, theMessageName & " ... end " & theMessageName, theBody, "message", theDescription, theFile
          end repeat
       end repeat
-      
+
       # properties
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/property"
       repeat for each line theFile in the files
@@ -143,12 +143,12 @@ on mouseUp
             repeat with theIndex = 2 to the number of items of theSnippet
                put theIndex-1&":" before item theIndex of theSnippet
             end repeat
-            
-            
+
+
             AddSnippet theSnippets, theSyntax, theSnippet, "property", theDescription, theFile
          end repeat
       end repeat
-      
+
       # keywords
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/keyword"
       repeat for each line theFile in the files
@@ -163,7 +163,7 @@ on mouseUp
             AddSnippet theSnippets, theSyntax, theSyntax, "keyword", theDescription, theFile
          end repeat
       end repeat
-      
+
       # constants
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/constant"
       repeat for each line theFile in the files
@@ -176,7 +176,7 @@ on mouseUp
             AddSnippet theSnippets, theSyntax, theSyntax, "constant", theDescription, theFile
          end repeat
       end repeat
-      
+
       # objects
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/object"
       repeat for each line theFile in the files
@@ -189,7 +189,7 @@ on mouseUp
             AddSnippet theSnippets, theSyntax, theSyntax, "object", theDescription, theFile
          end repeat
       end repeat
-      
+
       # operators
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/operator"
       repeat for each line theFile in the files
@@ -229,7 +229,7 @@ on mouseUp
             end repeat
          end repeat
       end repeat
-      
+
       # commands
       set the folder to specialFolderPath("home") & "/livecode/docs/dictionary/command"
       repeat for each line theFile in the files
@@ -248,7 +248,7 @@ on mouseUp
                replace ">" with "" in theSyntax
                put word 1 to 3 of theSyntax into thePrefix
                replace space with empty in thePrefix
-               
+
                split theParameters with "<"
                repeat with theIndex = 1 to the number of elements of theParameters
                   if theIndex is 1 then
@@ -262,10 +262,10 @@ on mouseUp
             end repeat
          end repeat
       end repeat
-      
+
       put cr & tab & tab & tab & tab & "]" & cr & \
             "# GENERATED SNIPPETS END" & cr after theSnippets
-      
+
       put url ("binfile:"&specialFolderPath("home")&"/atom-language-livecode/settings/language-livecode.cson") into theCSON
       put offset("# GENERATED SNIPPETS START",theCSON) into theStart
       put offset("# GENERATED SNIPPETS END",theCSON) into theEnd
@@ -389,35 +389,35 @@ command AddSnippet @pSnippets, pName, pBody, pType, pDescription, pFile
    if pName ends with space then
       delete the last char of pName
    end if
-   
+
    put tab & tab & tab & tab & tab into tTabLevel
-   
+
    put tTabLevel&"{" & cr into theSnippet
-   
+
    replace quote with "\"&quote in pBody
-   
+
    if the number of lines of pBody > 1 then
       put "'''" & cr before pBody
       put cr & "'''" after pBody
-      
+
       repeat with theIndex = 2 to the number of lines of pBody
          put tTabLevel & tab before line theIndex of pBody
       end repeat
    else
       put "'" & pBody & "'" into pBody
    end if
-   
+
    # I assume this is based on the lcdoc filename... hope so
    set the itemDelimiter to "."
    put "https://livecode.com/resources/api/#livecode_script/"&item 1 of pFile into theMoreURL
-   
+
    put tTabLevel & tab & "type: '" & pType & "'" & cr after theSnippet
    put tTabLevel & tab & "snippet: " & pBody & cr after theSnippet
    put tTabLevel & tab & "description: '" & pDescription & "'" & cr after theSnippet
    put tTabLevel & tab & "descriptionMoreURL: '" & theMoreURL & "'" & cr after theSnippet
-   
+
    put tTabLevel&"}" after theSnippet
-   
+
    put cr & theSnippet after pSnippets
-   
+
 end AddSnippet
diff --git a/tools/Linter.lc b/tools/Linter.lc
@@ -0,0 +1,98 @@
+<?livecode
+
+local sErrorsList
+local sLastLine
+
+Lint
+
+command Lint
+  local tScope
+  repeat for each element theArgument in the commandArguments
+    if theArgument begins with "-scope" then
+       split theArgument with "="
+       put theArgument[2] into tScope
+    end if
+  end repeat
+
+  read from stdin until empty
+  put it into tScript
+
+  put the scriptParsingErrors into sErrorsList
+  split sErrorsList with return
+
+  create script only stack "TestScript"
+
+  if tScope is empty or tScope is ".source.livecodescript" then
+    local tLineOffset = 0
+
+    -- check for script only
+    if word 1 of tScript is "script" then
+      put 1 into tLineOffset
+    end if
+
+    if tLineOffset is 1 then
+      delete line 1 of tScript
+    end if
+
+    set the script of stack "TestScript" to tScript
+
+    put the result into theErrors
+    split theErrors with return
+    repeat with tIndex = 1 to the number of elements in theErrors
+      if theErrors[tIndex] is not empty then
+        put sErrorsList[item 1 of theErrors[tIndex]] into tMessage
+        if tMessage is not empty then
+          if item 4 of theErrors[tIndex] is not empty then
+            put " (" & item 4 of theErrors[tIndex] & ")" after tMessage
+          end if
+          write item 2 of theErrors[tIndex] + tLineOffset, item 3 of theErrors[tIndex], tMessage & linefeed to stdout
+        end if
+      end if
+    end repeat
+  else if tScope is ".source.iRev" then
+    -- write out to a temporary file and include
+    put the temporary folder & slash & uuid() into tFile
+    -- can't lint a whole web app...
+    replace "include" with "# include" in tScript
+    replace "require" with "# require" in tScript
+    -- ensure it throws an error so it's not exectuted
+    put return & quote after tScript
+    put the number of lines of tScript into sLastLine
+    put tScript into url ("binfile:" & tFile)
+    include tFile
+  end if
+
+  write linefeed to stdout
+
+end Lint
+
+command scriptExecutionError pStack, pFiles
+  local tHint, tFile
+  --write 1,1,line 2 of pStack & linefeed to stdout
+  split pStack with return
+  repeat with tIndex = 2 to the number of elements in pStack
+    if item 1 of pStack[tIndex] is 730 then
+      exit repeat
+    end if
+    if item 2 of pStack[tIndex] is not 0 and item 2 of pStack[tIndex] is not sLastLine then
+      put sErrorsList[item 1 of pStack[tIndex]] into tMessage
+      if tMessage is not empty then
+        if item 4 of pStack[tIndex] is not empty then
+          put " (" & item 4 of pStack[tIndex] & ")" after tMessage
+        end if
+        write item 2 of pStack[tIndex], item 3 of pStack[tIndex], tMessage & linefeed to stdout
+      end if
+    end if
+  end repeat
+
+  -- cleanup
+  set the itemDelimiter to slash
+  repeat for each line tFile in pFiles
+    if item -1 of tFile is "Linter.lc" then
+      next repeat
+    end if
+    delete file tFile
+  end repeat
+
+  write linefeed to stdout
+end scriptExecutionError
diff --git a/tools/Linter.livecodescript b/tools/Linter.livecodescript
diff --git a/tools/scriptErrors.txt b/tools/scriptErrors.txt

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`'fileTypes': [`
`7`	`7`	`'livecodescript'`
`8`	`8`	`]`
`9`		`-'firstLineMatch': '^#!.\\b(livecode\|/usr/bin/env livecode)\|^#\\s-\\-[^]mode:\\slivecodescript[^]-\\*-'`
	`9`	`+'firstLineMatch': '^#!.\\b(livecode)\|^#\\s-\\-[^]mode:\\slivecodescript[^]-\\*-'`
`10`	`10`	`'patterns': [`
`11`	`11`	`{`
`12`	`12`	`include: "#language"`