Allow configurable file extension for indexing

fixtures/different_extension.inc

@@ -0,0 +1 @@
+<?php

src/Indexer.php

@@ -65,14 +65,20 @@ class Indexer
     private $composerJson;
 
     /**
-     * @param FilesFinder       $filesFinder
-     * @param string            $rootPath
-     * @param LanguageClient    $client
-     * @param Cache             $cache
-     * @param DependenciesIndex $dependenciesIndex
-     * @param Index             $sourceIndex
-     * @param PhpDocumentLoader $documentLoader
-     * @param \stdClass|null    $composerLock
+     * @var Options
+     */
+    private $options;
+
+    /**
+     * @param FilesFinder            $filesFinder
+     * @param string                 $rootPath
+     * @param LanguageClient         $client
+     * @param Cache                  $cache
+     * @param DependenciesIndex      $dependenciesIndex
+     * @param Index                  $sourceIndex
+     * @param PhpDocumentLoader      $documentLoader
+     * @param \stdClass|null         $composerLock
+     * @param Options|null           $options
      */
     public function __construct(
         FilesFinder $filesFinder,
@@ -83,7 +89,8 @@ public function __construct(
         Index $sourceIndex,
         PhpDocumentLoader $documentLoader,
         \stdClass $composerLock = null,
-        \stdClass $composerJson = null
+        \stdClass $composerJson = null,
+        Options $options = null
     ) {
         $this->filesFinder = $filesFinder;
         $this->rootPath = $rootPath;
@@ -94,6 +101,7 @@ public function __construct(
         $this->documentLoader = $documentLoader;
         $this->composerLock = $composerLock;
         $this->composerJson = $composerJson;
+        $this->options = $options;
     }
 
     /**
@@ -104,8 +112,8 @@ public function __construct(
     public function index(): Promise
     {
         return coroutine(function () {
-
-            $pattern = Path::makeAbsolute('**/*.php', $this->rootPath);
+            $fileTypes = implode(',', $this->options->getFileTypes());
+            $pattern = Path::makeAbsolute('**/*{' . $fileTypes . '}', $this->rootPath);
             $uris = yield $this->filesFinder->find($pattern);
 
             $count = count($uris);

src/LanguageServer.php

@@ -167,11 +167,12 @@ public function __construct(ProtocolReader $reader, ProtocolWriter $writer)
      * @param ClientCapabilities $capabilities The capabilities provided by the client (editor)
      * @param string|null $rootPath The rootPath of the workspace. Is null if no folder is open.
      * @param int|null $processId The process Id of the parent process that started the server. Is null if the process has not been started by another process. If the parent process is not alive then the server should exit (see exit notification) its process.
+     * @param mixed $initializationOptions The options send from client to initialize the server
      * @return Promise <InitializeResult>
      */
-    public function initialize(ClientCapabilities $capabilities, string $rootPath = null, int $processId = null): Promise
+    public function initialize(ClientCapabilities $capabilities, string $rootPath = null, int $processId = null, $initializationOptions = null): Promise
     {
-        return coroutine(function () use ($capabilities, $rootPath, $processId) {
+        return coroutine(function () use ($capabilities, $rootPath, $processId, $initializationOptions) {
 
             if ($capabilities->xfilesProvider) {
                 $this->filesFinder = new ClientFilesFinder($this->client);
@@ -190,6 +191,7 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
             $this->projectIndex = new ProjectIndex($sourceIndex, $dependenciesIndex, $this->composerJson);
             $stubsIndex = StubsIndex::read();
             $this->globalIndex = new GlobalIndex($stubsIndex, $this->projectIndex);
+            $options = new Options($initializationOptions);
 
             // The DefinitionResolver should look in stubs, the project source and dependencies
             $this->definitionResolver = new DefinitionResolver($this->globalIndex);
@@ -235,7 +237,8 @@ public function initialize(ClientCapabilities $capabilities, string $rootPath =
                     $sourceIndex,
                     $this->documentLoader,
                     $this->composerLock,
-                    $this->composerJson
+                    $this->composerJson,
+                    $options
                 );
                 $indexer->index()->otherwise('\\LanguageServer\\crash');
             }

src/Options.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace LanguageServer;
+
+class Options
+{
+    /**
+     * Filetypes the indexer should process
+     *
+     * @var array
+     */
+    private $fileTypes = [".php"];
+
+    /**
+     * @param \Traversable|\stdClass|array|null $options
+     */
+    public function __construct($options = null)
+    {
+        // Do nothing when the $options parameter is not an object
+        if (!is_object($options) && !is_array($options) && (!$options instanceof \Traversable)) {
+            return;
+        }
+
+        foreach ($options as $option => $value) {
+            $method = 'set' . ucfirst($option);
+
+            call_user_func([$this, $method], $value);
+        }
+    }
+
+    /**
+     * Validate and set options for file types
+     *
+     * @param array $fileTypes List of file types
+     */
+    public function setFileTypes(array $fileTypes)
+    {
+        $fileTypes = filter_var_array($fileTypes, FILTER_SANITIZE_STRING);
+        $fileTypes =  filter_var($fileTypes, FILTER_CALLBACK, ['options' => [$this, 'filterFileTypes']]);
+        $fileTypes = array_filter($fileTypes);
+
+        $this->fileTypes = !empty($fileTypes) ? $fileTypes : $this->fileTypes;
+    }
+
+    /**
+     * Get list of registered file types
+     *
+     * @return array
+     */
+    public function getFileTypes(): array
+    {
+        return $this->fileTypes;
+    }
+
+    /**
+     * Filter valid file type
+     *
+     * @param string $fileType The file type to filter
+     * @return string|bool If valid it returns the file type, otherwise false
+     */
+    private function filterFileTypes(string $fileType)
+    {
+        $fileType = trim($fileType);
+
+        if (empty($fileType)) {
+            return $fileType;
+        }
+
+        if (substr($fileType, 0, 1) !== '.') {
+            return false;
+        }
+
+        return $fileType;
+    }
+}

tests/LanguageServerTest.php

@@ -117,4 +117,31 @@ public function testIndexingWithFilesAndContentRequests()
         $this->assertTrue($filesCalled);
         $this->assertTrue($contentCalled);
     }
+
+    public function testIndexingMultipleFileTypes()
+    {
+        $promise = new Promise;
+        $input = new MockProtocolStream;
+        $output = new MockProtocolStream;
+        $options = (object)[
+            'fileTypes' => [
+                '.php',
+                '.inc'
+            ]
+        ];
+
+        $output->on('message', function (Message $msg) use ($promise, &$foundFiles) {
+            if ($msg->body->method === 'window/logMessage' && $promise->state === Promise::PENDING) {
+                if ($msg->body->params->type === MessageType::ERROR) {
+                    $promise->reject(new Exception($msg->body->params->message));
+                } else if (strpos($msg->body->params->message, 'All 27 PHP files parsed') !== false) {
+                    $promise->fulfill();
+                }
+            }
+        });
+        $server = new LanguageServer($input, $output);
+        $capabilities = new ClientCapabilities;
+        $server->initialize($capabilities, realpath(__DIR__ . '/../fixtures'), getmypid(), $options);
+        $promise->wait();
+    }
 }