install/run instructions?

[kurokirasama]

Hey, sorry my ignorance, but how to run or install this? There is nothing in the readme file.

After some google-ing, is this correct? (after cloning the repo):

npm run package

to run the server:

node out/index.js --stdio

?

[dklilley]

Hi @kurokirasama , thank you for raising this question! There is a known lack of documentation around the development workflows. This is a space we want to build up in the future.

The primary commands are the following:

• npm install - installs all needed NPM packages
• npm run compile - build the TypeScript code into executable JavaScript code for development
• npm run package - similar to npm run compile, but performs a production build

When it comes to running the language server, I believe this can be done with node out/index.js. The possible startup flags are enumerated in ConfigurationManager.ts:

MATLAB-language-server/src/lifecycle/ConfigurationManager.ts

Lines 8 to 14 in 319868d

	export enum Argument {
	// Basic arguments
	MatlabLaunchCommandArguments = 'matlabLaunchCommandArgs',
	MatlabInstallationPath = 'matlabInstallPath',
	MatlabConnectionTiming = 'matlabConnectionTiming',
	ShouldIndexWorkspace = 'indexWorkspace',

The descriptions for these can be found within CliUtils.ts.

Please feel free to reach out if you have any other questions about this.

[kurokirasama]

Thanks a lot! As I understand, this need matlab 2021+, right?

[dklilley]

Yes, that is correct - the language server currently support MATLAB R2021a and later.

[kurokirasama]

does it need polyspace?

[dklilley]

No, it does not require Polyspace. All features provided by this language server should only require a base MATLAB installation.

[kurokirasama]

super! Thanks!

[kurokirasama]

the matlabLaunchCommandArgs flag has to be this: /usr/local/MATLAB/R2023a/?

also, can you provide some guidance in how to set up this in sublime text?

[dklilley]

The matlabInstallPath flag should be set to something like /usr/local/MATLAB/R2023a (or the value returned by matlabroot when executed within MATLAB.

The matlabLaunchCommandArgs flag is for providing additional startup options to MATLAB, but this is not likely to be necessary.

Regarding Sublime Text, I will respond on your other issue (#29)

[gregdvd]

Requirements would also be nice - I fought for a couple of days with the "Client X quit with exit code 1 and signal 0." error message before discovering that it was caused by my "node" and "npm" being too old. I was using the version provided by my Ubuntu through apt (8.5.1) - now, after installing "npm 10.5.0" directly from nodejs.org, everything works fine.

BTW, thanks a lot for this project! It makes editing matlab files much easier!