centralize printing, add settings, improve PATH, fix misc bugs

debug printing is now handled through `persist.debug`
additionally, it can be disabled through the setting 'debug' (issue #25)

settings are loaded from SublimeLint.sublime-settings
added commands to load user and default settings through the command launcher

PATH is now detected using /bin/bash --login if it's your system shell

some extraneous linting bugs are fixed
Linter.popen now cleanly prints a "command not found" message if necesssary
better support for case-insensitive filesystems when reloading modules

Default.sublime-commands

@@ -0,0 +1,16 @@
+[
+    {
+        "caption": "Preferences: SublimeLint – Default",
+        "command": "open_file", "args":
+        {
+            "file": "${packages}/sublimelint/SublimeLint.sublime-settings"
+        }
+    },
+    {
+        "caption": "Preferences: SublimeLint – User",
+        "command": "open_file", "args":
+        {
+            "file": "${packages}/User/SublimeLint.sublime-settings"
+        }
+    }
+]

SublimeLint.sublime-settings

@@ -0,0 +1,3 @@
+{
+	"debug": false
+}

lint/linter.py

@@ -4,6 +4,7 @@
 
 import sublime
 import re
+import persist
 
 from highlight import Highlight
 
@@ -27,6 +28,7 @@ def __init__(self, view, syntax, filename='untitled'):
 		self.view = view
 		self.syntax = syntax
 		self.filename = filename
+
 		if self.regex:
 			self.regex = re.compile(self.regex)
 
@@ -46,8 +48,12 @@ def assign(cls, view):
 
 		settings = view.settings()
 		syn = settings.get('syntax')
-		if not syn: return
-
+		if not syn:
+			if id in cls.linters:
+				del cls.linters[id]
+
+			return
+
 		match = syntax_re.search(syn)
 
 		if match:
@@ -61,7 +67,7 @@ def assign(cls, view):
 					return
 
 			linters = set()
-			for entry in cls.languages.values():
+			for name, entry in cls.languages.items():
 				if entry.can_lint(syntax):
 					linter = entry(view, syntax)
 					linters.add(linter)
@@ -71,9 +77,11 @@ def assign(cls, view):
 			else:
 				if id in cls.linters:
 					del cls.linters[id]
-					
+
 			return linters
 
+		del cls.linters[id]
+
 	@classmethod
 	def reload(cls, mod):
 		'''
@@ -121,25 +129,26 @@ def lint(self, code=None):
 		if not code: return
 
 		output = self.communicate(self.cmd, code)
-		print repr(output)
-
-		for line in output.splitlines():
-			line = line.strip()
-
-			match, row, col, message, near = self.match_error(self.regex, line)
-			if match:
-				if row or row is 0:
-					if col or col is 0:
-						self.highlight.range(row, col)
-					elif near:
-						self.highlight.near(row, near)
+		if output:
+			persist.debug('Output:', repr(output))
+
+			for line in output.splitlines():
+				line = line.strip()
+
+				match, row, col, message, near = self.match_error(self.regex, line)
+				if match:
+					if row or row is 0:
+						if col or col is 0:
+							self.highlight.range(row, col)
+						elif near:
+							self.highlight.near(row, near)
+						else:
+							self.highlight.line(row)
+
+					if row in errors:
+						errors[row].append(message)
 					else:
-						self.highlight.line(row)
-
-				if row in errors:
-					errors[row].append(message)
-				else:
-					errors[row] = [message]
+						errors[row] = [message]
 
 	def draw(self, prefix='lint'):
 		self.highlight.draw(self.view, prefix)
@@ -152,16 +161,17 @@ def clear(self, prefix='lint'):
 	@classmethod
 	def can_lint(cls, language):
 		language = language.lower()
-		if isinstance(cls.language, basestring) and language == cls.language:
-			return True
-		elif isinstance(cls.language, (list, tuple, set)) and language in cls.language:
-			return True
-		else:
-			return False
+		if cls.language:
+			if language == cls.language:
+				return True
+			elif language in cls.language:
+				return True
+			else:
+				return False
 
 	def error(self, line, error):
 		self.highlight.line(line)
-		
+
 		error = str(error)
 		if line in self.errors:
 			self.errors[line].append(error)
@@ -182,21 +192,47 @@ def match_error(self, r, line):
 		return match, None, None, '', None
 
 	# popen methods
-
 	def communicate(self, cmd, code):
-		out = self.popen(cmd).communicate(code)
-		return (out[0] or '') + (out[1] or '')
+		out = self.popen(cmd)
+		if out is not None:
+			out = out.communicate(code)
+			return (out[0] or '') + (out[1] or '')
+		else:
+			return ''
+
+	def create_environment(self):
+		env = os.environ
+		if os.name == 'posix':
+			# find PATH using shell --login
+			if 'SHELL' in env and env['SHELL'] in ('/bin/bash', ):
+				shell = (env['SHELL'], '--login', '-c', 'echo _SUBL_ $PATH')
+				path = self.popen(shell, env).communicate()[0]
+				env['PATH'] = path.split('_SUBL_ ', 1)[1].split('\n', 1)[0]
+			# guess PATH
+			else:
+				for path in (
+					'/usr/bin', '/usr/local/bin',
+					'/usr/local/php/bin', '/usr/local/php5/bin'
+							):
+					if not path in env['PATH']:
+						env['PATH'] += (':' + path)
+
+		return env
 
 	def tmpfile(self, cmd, code, suffix=''):
 		f = tempfile.NamedTemporaryFile(suffix=suffix)
 		f.write(code)
 		f.flush()
 
 		cmd = tuple(cmd) + (f.name,)
-		out = self.popen(cmd).communicate('')
-		return (out[0] or '') + (out[1] or '')
+		out = self.popen(cmd)
+		if out:
+			out = out.communicate('')
+			return (out[0] or '') + (out[1] or '')
+		else:
+			return ''
 
-	def popen(self, cmd):
+	def popen(self, cmd, env=None):
 		if isinstance(cmd, basestring):
 			cmd = cmd,
 
@@ -206,15 +242,13 @@ def popen(self, cmd):
 			info.dwFlags |= subprocess.STARTF_USESHOWWINDOW
 			info.wShowWindow = subprocess.SW_HIDE
 
-		env = os.environ
-		if os.name == 'posix':
-			for path in (
-				'/usr/bin', '/usr/local/bin',
-				'/usr/local/php/bin', '/usr/local/php5/bin'
-						):
-				if not path in env['PATH']:
-					env['PATH'] += (':' + path)
-
-		return subprocess.Popen(cmd, stdin=subprocess.PIPE,
-			stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-			startupinfo=info, env=env)
+		if env is None:
+			env = self.create_environment()
+
+		try:
+			return subprocess.Popen(cmd, stdin=subprocess.PIPE,
+				stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+				startupinfo=info, env=env)
+		except OSError, err:
+			persist.debug('SublimeLint: Error launching', repr(cmd))
+			persist.debug('Error was:', err.strerror)

lint/modules.py

@@ -5,6 +5,7 @@
 import glob
 
 import traceback
+import persist
 
 class Modules:
 	def __init__(self, cwd, path):
@@ -14,7 +15,7 @@ def __init__(self, cwd, path):
 		self.modules = {}
 
 	def load(self, name):
-		print 'SublimeLint: loading `%s`' % name
+		persist.debug('SublimeLint: loading `%s`' % name)
 		pushd = os.getcwd()
 		os.chdir(self.base)
 		path = list(sys.path)
@@ -28,10 +29,10 @@ def load(self, name):
 			# second, we get an updated version of the module with reload() so development is easier
 			mod = sys.modules[name] = reload(sys.modules[name])
 		except:
-			print 'SublimeLint: Error importing `%s`' % name
-			print '-'*20
-			print traceback.format_exc()
-			print '-'*20
+			persist.debug('SublimeLint: error importing `%s`' % name)
+			persist.debug('-'*20)
+			persist.debug(traceback.format_exc())
+			persist.debug('-'*20)
 
 		self.modules[name] = mod
 
@@ -45,7 +46,6 @@ def load(self, name):
 
 	def reload(self, mod):
 		name = mod.__name__
-		print 'SublimeLint: reloading `%s`' % name
 		if name in self.modules:
 			return self.load(name)
 

lint/persist.py

@@ -12,6 +12,14 @@ class Daemon:
 	views = {}
 	last_run = {}
 
+	def __init__(self):
+		self.settings = sublime.load_settings('SublimeLint.sublime-settings')
+		self.settings.add_on_change('lint-persist-settings', self.update_settings)
+		self.update_settings()
+
+	def update_settings(self):
+		self.debug = self.settings.get('debug', False)
+
 	def start(self, callback):
 		self.callback = callback
 
@@ -51,22 +59,31 @@ def loop(self):
 
 				elif isinstance(item, basestring):
 					if item == 'reload':
-						print 'SublimeLint daemon detected a reload'
+						self.printf('SublimeLint daemon detected a reload')
 				else:
-					print 'SublimeLint: Unknown message sent to daemon:', item
+					self.printf('SublimeLint: Unknown message sent to daemon:', item)
 			except:
-				print 'Error in SublimeLint daemon:'
-				print '-'*20
-				print traceback.format_exc()
-				print '-'*20
+				self.printf('Error in SublimeLint daemon:')
+				self.printf('-'*20)
+				self.printf(traceback.format_exc())
+				self.printf('-'*20)
 
 	def hit(self, view):
 		self.q.put((view.id(), time.time()))
 
 	def delay(self):
 		self.q.put(0.01)
 
+	def printf(self, *args):
+		if not self.debug: return
+
+		for arg in args:
+			print arg,
+		print
+
 if not 'already' in globals():
 	queue = Daemon()
+	debug = queue.printf
+
 	errors = {}
 	already = True

sublimelint.py

@@ -22,9 +22,14 @@ class SublimeLint(sublime_plugin.EventListener):
 	def __init__(self, *args, **kwargs):
 		sublime_plugin.EventListener.__init__(self, *args, **kwargs)
 
+		self.settings = sublime.load_settings('SublimeLint.sublime-settings')
+		self.settings.add_on_change('lint-settings', self.update_settings)
+		self.update_settings()
+
 		self.loaded = set()
 		self.linted = set()
 		self.modules = Modules(cwd, 'languages').load_all()
+		self.pending_on_change = set()
 		persist.queue.start(self.lint)
 
 		# this gives us a chance to lint the active view on fresh install
@@ -34,11 +39,14 @@ def __init__(self, *args, **kwargs):
 
 		self.start = time.time()
 
+	def update_settings(self):
+		pass
+
 	def lint(self, view_id):
 		view = Linter.get_view(view_id)
 
 		if view is not None:
-			print 'SublimeLint: running on `%s`' % os.path.split(view.file_name() or 'untitled')[1]
+			persist.debug('SublimeLint: running on `%s`' % os.path.split(view.file_name() or 'untitled')[1])
 			code = Linter.text(view)
 			thread.start_new_thread(Linter.lint_view, (view_id, code, self.finish))
 
@@ -58,6 +66,8 @@ def finish(self, view, linters):
 
 	def hit(self, view):
 		self.linted.add(view.id())
+		if view.size() == 0: return
+
 		persist.queue.hit(view)
 
 	# callins
@@ -84,15 +94,27 @@ def on_new(self, view):
 		settings = view.settings()
 		syntax = settings.get('syntax')
 		def on_change():
-			if settings.get('syntax') != syntax:
-				Linter.assign(view)
+			# weird, the recursion bug seems to only be happening on one untitled view?
+			if view.id() in self.pending_on_change:
+				return
+
+			try:
+				self.pending_on_change.add(view.id())
+				if settings.get('syntax') != syntax:
+					Linter.assign(view)
+
+			finally:
+				self.pending_on_change.remove(view.id())
 
+		settings.clear_on_change('lint-syntax')
 		settings.add_on_change('lint-syntax', on_change)
 
 	def on_post_save(self, view):
 		# this will reload submodules if they are saved with sublime text
 		for name, module in self.modules.modules.items():
-			if module.__file__ == view.file_name():
+			if os.name == 'posix' and (
+				os.stat(module.__file__).st_ino == os.stat(view.file_name()).st_ino
+			) or module.__file__ == view.file_name():
 				self.modules.reload(module)
 				Linter.reload(name)
 				break