Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Folder level settings #268

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Folder level settings #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e6f181c
set all configuration properties to resource scope
limarkxx Jul 27, 2023
54f4230
require ConfigurationScope in ConfigurationService constructor
limarkxx Jul 27, 2023
dac806e
Move logLevel source-of-truth to ConfigurationService
limarkxx Jul 27, 2023
b0a390f
spawn ConfigurationService for each of workspaceFolders
limarkxx Jul 27, 2023
6103ba3
restore lf line endings
limarkxx Jul 27, 2023
302b491
Pass in workspaceFolder and filter on matched files to limit to corre…
limarkxx Aug 9, 2023
4f43c91
multi LSP instances, LSP issue
limarkxx Aug 9, 2023
f2db8e7
Workaround for ExecuteCommandFeature issue
limarkxx Aug 9, 2023
0a56493
add version gate
Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 34 additions & 18 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@
"psalm.phpExecutablePath": {
"type": "string",
"default": null,
"description": "Optional, defaults to searching for \"php\". The path to a PHP 7.0+ executable to use to execute the Psalm server. The PHP 7.0+ installation should preferably include and enable the PHP module `pcntl`. (Modifying requires VSCode reload)"
"description": "Optional, defaults to searching for \"php\". The path to a PHP 7.0+ executable to use to execute the Psalm server. The PHP 7.0+ installation should preferably include and enable the PHP module `pcntl`. (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.phpExecutableArgs": {
"type": "array",
Expand All @@ -79,48 +80,56 @@
"-dxdebug.remote_enable=0",
"-dxdebug_profiler_enable=0"
],
"description": "Optional (Advanced), default is '-dxdebug.remote_autostart=0 -dxdebug.remote_enable=0 -dxdebug_profiler_enable=0'. Additional PHP executable CLI arguments to use. (Modifying requires VSCode reload)"
"description": "Optional (Advanced), default is '-dxdebug.remote_autostart=0 -dxdebug.remote_enable=0 -dxdebug_profiler_enable=0'. Additional PHP executable CLI arguments to use. (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.psalmVersion": {
"type": "string",
"default": null,
"description": "Optional (Advanced). If provided, this overrides the Psalm version detection (Modifying requires VSCode reload)"
"description": "Optional (Advanced). If provided, this overrides the Psalm version detection (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.psalmScriptPath": {
"type": "string",
"default": null,
"description": "Optional (Advanced). If provided, this overrides the Psalm script to use, e.g. vendor/bin/psalm-language-server. (Modifying requires VSCode reload)"
"description": "Optional (Advanced). If provided, this overrides the Psalm script to use, e.g. vendor/bin/psalm-language-server. (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.psalmScriptArgs": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"description": "Optional (Advanced). Additional arguments to the Psalm language server. (Modifying requires VSCode reload)"
"description": "Optional (Advanced). Additional arguments to the Psalm language server. (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.psalmClientScriptPath": {
"type": "string",
"default": null,
"description": "Optional (Advanced). If provided, this overrides the Psalm script to use, e.g. vendor/bin/psalm. (Modifying requires VSCode reload)",
"markdownDeprecationMessage": "**Deprecated**: Please use `#psalm.psalmScriptPath#` instead.",
"deprecationMessage": "Deprecated: Please use psalm.psalmScriptPath instead."
"deprecationMessage": "Deprecated: Please use psalm.psalmScriptPath instead.",
"scope": "resource"
},
"psalm.enableUseIniDefaults": {
"type": "boolean",
"default": false,
"description": "Enable this to use PHP-provided ini defaults for memory and error display. (Modifying requires restart)"
"description": "Enable this to use PHP-provided ini defaults for memory and error display. (Modifying requires restart)",
"scope": "resource"
},
"psalm.enableDebugLog": {
"type": "boolean",
"default": false,
"description": "Enable this to print messages to the debug console when developing or debugging this VS Code extension. (Modifying requires VSCode reload)",
"deprecationMessage": "Deprecated: Please use psalm.enableVerbose, psalm.logLevel or psalm.trace.server instead."
"deprecationMessage": "Deprecated: Please use psalm.enableVerbose, psalm.logLevel or psalm.trace.server instead.",
"scope": "resource"
},
"psalm.enableVerbose": {
"type": "boolean",
"default": false,
"description": "Enable --verbose mode on the Psalm Language Server (Modifying requires VSCode reload)"
"description": "Enable --verbose mode on the Psalm Language Server (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.logLevel": {
"type": "string",
Expand All @@ -134,7 +143,7 @@
],
"default": "INFO",
"description": "Traces the communication between VSCode and the Psalm language server.",
"scope": "window"
"scope": "resource"
},
"psalm.trace.server": {
"type": "string",
Expand All @@ -145,7 +154,7 @@
],
"default": "off",
"description": "Traces the communication between VSCode and the Psalm language server.",
"scope": "window"
"scope": "resource"
},
"psalm.analyzedFileExtensions": {
"type": "array",
Expand All @@ -159,22 +168,26 @@
"language": "php"
}
],
"description": "A list of file extensions to request Psalm to analyze. By default, this only includes 'php' (Modifying requires VSCode reload)"
"description": "A list of file extensions to request Psalm to analyze. By default, this only includes 'php' (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.unusedVariableDetection": {
"type": "boolean",
"default": false,
"description": "Enable this to enable unused variable and parameter detection"
"description": "Enable this to enable unused variable and parameter detection",
"scope": "resource"
},
"psalm.connectToServerWithTcp": {
"type": "boolean",
"default": false,
"description": "If this is set to true, this VSCode extension will use TCP instead of the default STDIO to communicate with the Psalm language server. (Modifying requires VSCode reload)"
"description": "If this is set to true, this VSCode extension will use TCP instead of the default STDIO to communicate with the Psalm language server. (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.disableAutoComplete": {
"type": "boolean",
"default": false,
"description": "Enable to disable autocomplete on methods and properties (Modifying requires VSCode reload)"
"description": "Enable to disable autocomplete on methods and properties (Modifying requires VSCode reload)",
"scope": "resource"
},
"psalm.configPaths": {
"type": "array",
Expand All @@ -185,17 +198,20 @@
"psalm.xml",
"psalm.xml.dist"
],
"description": "A list of files to checkup for psalm configuration (relative to the workspace directory)"
"description": "A list of files to checkup for psalm configuration (relative to the workspace directory)",
"scope": "resource"
},
"psalm.hideStatusMessageWhenRunning": {
"type": "boolean",
"default": true,
"description": "This will hide the Psalm status from the status bar when it is started and running. This is useful to clear up a cluttered status bar."
"description": "This will hide the Psalm status from the status bar when it is started and running. This is useful to clear up a cluttered status bar.",
"scope": "resource"
},
"psalm.maxRestartCount": {
"type": "number",
"default": 5,
"description": "The number of times the Language Server is allowed to crash and restart before it will no longer try to restart (Modifying requires VSCode reload)"
"description": "The number of times the Language Server is allowed to crash and restart before it will no longer try to restart (Modifying requires VSCode reload)",
"scope": "resource"
}
}
},
Expand Down
9 changes: 6 additions & 3 deletions src/ConfigurationService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { workspace, WorkspaceConfiguration } from 'vscode';
import { ConfigurationScope, workspace, WorkspaceConfiguration } from 'vscode';
import which from 'which';
import { join } from 'path';
import { DocumentSelector, integer } from 'vscode-languageserver-protocol';
Expand All @@ -25,6 +25,7 @@ interface Config {
}

export class ConfigurationService {
private scope: ConfigurationScope;
private config: Config = {
maxRestartCount: 5,
disableAutoComplete: false,
Expand All @@ -36,11 +37,13 @@ export class ConfigurationService {
logLevel: 'INFO',
};

public constructor() {}
public constructor(scope: ConfigurationScope) {
this.scope = scope;
}

public async init() {
const workspaceConfiguration: WorkspaceConfiguration =
workspace.getConfiguration('psalm');
workspace.getConfiguration('psalm', this.scope);

// Work around until types are updated
let whichPHP: Config['phpExecutablePath'];
Expand Down
Loading