When running the Psalm language server in my Psalm extension it starts up fine but never finishes analyzing a file because of an error I receive that I’m not sure what to do about, saying The data couldn't be read because it is missing:
I’m pretty sure this is not an error coming from Psalm since I can’t find this string in the Psalm codebase, so I’m wondering if this could be coming from Nova? Another point to consider is that when I initially published the extension it was working fine. I forget which version of Nova I had at the time, but this may be a regression in the LSP support?
I’m not really sure how to start debugging this so I’d appreciate it if y’all could take a look on your end. For the extension to work you need to have PHP, Composer, and Psalm on your computer.
Getting set up for testing
- Install PHP on your computer. I recommend using homebrew.
- Install composer on your computer:
# This is copied from the page I linked to above, but I'd recommend going there yourself to read the instructions.
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r "if (hash_file('sha384', 'composer-setup.php') === '55ce33d7678c5a611085589f1f3ddf8b3c52d662cd01d4ba75c0ee0459970c2200a51f492d557530c71c15d8dba01eae') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"
sudo mv composer.phar /usr/local/bin/composer # not strictly necessary, you can also run the PHAR file from wherever it is installed and delete it after testing.
- Create a directory with a test file:
mkdir test-psalm
cd test-psalm
touch test-file.php
- Add the following code to the test file:
<?php
/**
* @return array<string>
*/
function takesAnInt(int $i) {
return [$i, "hello"];
}
$data = ["some text", 5];
takesAnInt($data[0]);
$condition = rand(0, 5);
if ($condition) {
} elseif ($condition) {}
- Install psalm in the test folder and generate a config file:
cd test-psalm # If you're not in the test directory already
/path/to/composer require --dev vimeo/psalm # change /path/to/composer to wherever the .phar file is
./vendor/bin/psalm --init
- Make sure psalm runs correctly normally (i.e. not the LSP way used in the extension)
./vendor/bin/psalm --no-cache test-file.php
- Install the Psalm extension.
- Add the test project to Nova and open the test file.
- Notice the Psalm extension/LSP will run and send/receive several messages, but it won’t highlight the issues (like shown on the screenshot in the plugin readme). It doesn’t highlight the issue because the language server stops after running into the issue. Instead you’ll get a notification from the extension saying Psalm stopped. If you check the extension console you’ll see the
The data couldn't be read because it is missingmessage. The error parameter passed toonDidStopseems to be astring(the message in the extension console) which is why the notice body isundefined; it’s expecting an object with amessageproperty.
