Merge pull request #111 from austb/lint_from_module_dir

(GH-103) Parse puppet-lint.rc in module directory

Author: jpogran

client/src/connection.ts

@@ -224,6 +224,7 @@ export class ConnectionManager implements IConnectionManager {
 
     if ((this.connectionConfiguration.host == undefined) || (this.connectionConfiguration.host == '')) {
       args.push('--ip=127.0.0.1');
+      args.push('--local-workspace=' + vscode.workspace.textDocuments[0]);
     } else {
       args.push('--ip=' + this.connectionConfiguration.host);
     }

server/lib/puppet-languageserver.rb

@@ -24,7 +24,8 @@ def self.parse(options)
         connection_timeout: 10,
         preload_puppet: true,
         debug: nil,
-        fast_start_tcpserver: true
+        fast_start_tcpserver: true,
+        workspace: nil,
       }
 
       opt_parser = OptionParser.new do |opts|
@@ -58,6 +59,10 @@ def self.parse(options)
           args[:fast_start_tcpserver] = false
         end
 
+        opts.on('--local-workspace=PATH', 'The workspace or file path that will be used to provide module-specific functionality. Default is no workspace path.') do |path|
+          args[:workspace] = path
+        end
+
         opts.on('-h', '--help', 'Prints this help') do
           puts opts
           exit

server/lib/puppet-languageserver/document_validator.rb

@@ -1,14 +1,43 @@
 require 'puppet-lint'
 module PuppetLanguageServer
   module DocumentValidator
-    def self.validate(content, _max_problems = 100)
+    def self.find_module_root_from_path(path)
+      return nil if path.nil?
+
+      filepath = Pathname.new(path).expand_path
+      return nil unless filepath.exist?
+
+      if filepath.directory?
+        directory = filepath
+      else
+        directory = filepath.dirname
+      end
+
+      module_root = nil
+      directory.ascend do |p|
+        if p.join('metadata.json').exist?
+          module_root = p
+          break
+        end
+      end
+
+      module_root
+    end
+
+    def self.validate(content, workspace, _max_problems = 100)
       result = []
       # TODO: Need to implement max_problems
       problems = 0
 
-      begin
-        # TODO: load .puppet-lint.rc from the module root as well
+      # Find module root and attempt to build PuppetLint options
+      module_root = find_module_root_from_path(workspace)
+      if module_root.nil?
         PuppetLint::OptParser.build
+      else
+        Dir.chdir(module_root.to_s) { PuppetLint::OptParser.build }
+      end
+
+      begin
         linter = PuppetLint::Checks.new
         problems = linter.run(nil, content)
         unless problems.nil?

server/lib/puppet-languageserver/message_router.rb

@@ -24,6 +24,8 @@ def self.document(uri)
   class MessageRouter < JSONRPCHandler
     def initialize(*options)
       super(*options)
+
+      @workspace = options.first[:workspace] unless options.compact.empty?
     end
 
     def documents
@@ -139,7 +141,7 @@ def receive_notification(method, params)
         file_uri = params['textDocument']['uri']
         content = params['textDocument']['text']
         documents.set_document(file_uri, content)
-        reply_diagnostics(file_uri, PuppetLanguageServer::DocumentValidator.validate(content))
+        reply_diagnostics(file_uri, PuppetLanguageServer::DocumentValidator.validate(content, @workspace))
 
       when 'textDocument/didClose'
         PuppetLanguageServer.log_message(:info, 'Received textDocument/didClose notification.')
@@ -151,7 +153,7 @@ def receive_notification(method, params)
         file_uri = params['textDocument']['uri']
         content = params['contentChanges'][0]['text'] # TODO: Bad hardcoding zero
         documents.set_document(file_uri, content)
-        reply_diagnostics(file_uri, PuppetLanguageServer::DocumentValidator.validate(content))
+        reply_diagnostics(file_uri, PuppetLanguageServer::DocumentValidator.validate(content, @workspace))
 
       when 'textDocument/didSave'
         PuppetLanguageServer.log_message(:info, 'Received textDocument/didSave notification.')

server/spec/integration/puppet-languageserver/document_validator_spec.rb

@@ -8,7 +8,7 @@
       let(:manifest) { 'user { "Bob"' }
 
       it "should return at least one error" do
-        result = subject.validate(manifest)
+        result = subject.validate(manifest, nil)
         expect(result.length).to be > 0
       end
     end
@@ -17,7 +17,7 @@
       let(:manifest) { "user { 'Bob': ensure => 'present' }" }
 
       it "should return an empty array" do
-        expect(subject.validate(manifest)).to eq([])
+        expect(subject.validate(manifest, nil)).to eq([])
       end
     end