Skip to content
This repository has been archived by the owner on Sep 6, 2021. It is now read-only.

Fixed LSP Linting Synchronization Issues #14685

Merged
merged 3 commits into from
Apr 5, 2019
Merged

Fixed LSP Linting Synchronization Issues #14685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
da67faf
Fixed LSP Linting Synchrnization Issues
Apr 3, 2019
e4a02cc
Addressed review comments
Apr 4, 2019
b204d2b
Removing Linter Name as it is not required
Apr 4, 2019
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
30 changes: 16 additions & 14 deletions src/extensions/default/PhpTooling/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ define(function (require, exports, module) {
DEBUG_OPEN_PREFERENCES_IN_SPLIT_VIEW = "debug.openPrefsInSplitView",
phpServerRunning = false,
serverCapabilities,
currentRootPath;
currentRootPath,
chProvider,
phProvider,
lProvider,
jdProvider;

PreferencesManager.definePreference("php", "object", phpConfig, {
description: Strings.DESCRIPTION_PHP_TOOLING_CONFIGURATION
Expand All @@ -66,6 +70,9 @@ define(function (require, exports, module) {
PreferencesManager.on("change", "php", function () {
var newPhpConfig = PreferencesManager.get("php");

if (lProvider && newPhpConfig["validateOnType"] !== phpConfig["validateOnType"]) {
lProvider._validateOnType = !(newPhpConfig["validateOnType"] === "false");
}
if ((newPhpConfig["executablePath"] !== phpConfig["executablePath"])
|| (newPhpConfig["enablePhpTooling"] !== phpConfig["enablePhpTooling"])) {
phpConfig = newPhpConfig;
Expand All @@ -76,6 +83,7 @@ define(function (require, exports, module) {
});

var handleProjectOpen = function (event, directory) {
lProvider.clearExistingResults();
if(serverCapabilities["workspace"] && serverCapabilities["workspace"]["workspaceFolders"]) {
_client.notifyProjectRootsChanged({
foldersAdded: [directory.fullPath],
Expand All @@ -90,17 +98,17 @@ define(function (require, exports, module) {
};

function registerToolingProviders() {
var chProvider = new CodeHintsProvider(_client),
phProvider = new DefaultProviders.ParameterHintsProvider(_client),
lProvider = new DefaultProviders.LintingProvider(_client),
jdProvider = new DefaultProviders.JumpToDefProvider(_client);
chProvider = new CodeHintsProvider(_client),
phProvider = new DefaultProviders.ParameterHintsProvider(_client),
lProvider = new DefaultProviders.LintingProvider(_client),
jdProvider = new DefaultProviders.JumpToDefProvider(_client);

JumpToDefManager.registerJumpToDefProvider(jdProvider, ["php"], 0);
CodeHintManager.registerHintProvider(chProvider, ["php"], 0);
ParameterHintManager.registerHintProvider(phProvider, ["php"], 0);
CodeInspection.register(["php"], {
name: Strings.PHP_DIAGNOSTICS,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have something here to differentiate from any other provider which might also provide "php" related linting.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed we are not having any name for default PHP Lint Provider

scanFile: lProvider.getInspectionResults.bind(lProvider)
name: "",
scanFileAsync: lProvider.getInspectionResultsAsync.bind(lProvider)
});

_client.addOnCodeInspection(lProvider.setInspectionResults.bind(lProvider));
Expand All @@ -114,9 +122,7 @@ define(function (require, exports, module) {


if (phpConfig["validateOnType"] !== "false") {
_client.addOnDocumentChangeHandler(function () {
CodeInspection.requestRun(Strings.PHP_DIAGNOSTICS);
});
lProvider._validateOnType = true;
}

_client.addOnProjectOpenHandler(handleProjectOpen);
Expand Down Expand Up @@ -170,12 +176,8 @@ define(function (require, exports, module) {
EditorManager.off("activeEditorChange.php");
LanguageManager.off("languageModified.php");
}

evtHandler.handleActiveEditorChange(null, EditorManager.getActiveEditor());
currentRootPath = ProjectManager.getProjectRoot()._path;
setTimeout(function () {
CodeInspection.requestRun(Strings.PHP_DIAGNOSTICS);
}, 1500);
}

function runPhpServer() {
Expand Down
25 changes: 25 additions & 0 deletions src/languageTools/DefaultProviders.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,16 +335,20 @@ define(function (require, exports, module) {

function LintingProvider() {
this._results = new Map();
this._promiseMap = new Map();
this._validateOnType = false;
}

LintingProvider.prototype.clearExistingResults = function (filePath) {
var filePathProvided = !!filePath;

if (filePathProvided) {
this._results.delete(filePath);
this._promiseMap.delete(filePath);
} else {
//clear all results
this._results.clear();
this._promiseMap.clear();
}
};

Expand All @@ -371,6 +375,27 @@ define(function (require, exports, module) {
this._results.set(filePath, {
errors: errors
});
if(this._promiseMap.get(filePath)) {
this._promiseMap.get(filePath).resolve(this._results.get(filePath));
this._promiseMap.delete(filePath);
}
if (this._validateOnType) {
var editor = EditorManager.getActiveEditor(),
docPath = editor ? editor.document.file._path : "";
if (filePath === docPath) {
CodeInspection.requestRun();
}
}
};

LintingProvider.prototype.getInspectionResultsAsync = function (fileText, filePath) {
var result = $.Deferred();

if (this._results.get(filePath)) {
return result.resolve(this._results.get(filePath));
}
this._promiseMap.set(filePath, result);
return result;
};

LintingProvider.prototype.getInspectionResults = function (fileText, filePath) {
Expand Down
1 change: 0 additions & 1 deletion src/nls/root/strings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -886,7 +886,6 @@ define({
"PHP_SERVER_MEMORY_LIMIT_INVALID" : "The memory limit you provided is invalid. Review the PHP preferences to set the correct value.",
"DESCRIPTION_PHP_TOOLING_CONFIGURATION" : "PHP Tooling default configuration settings",
"OPEN_PREFERENNCES" : "Open Preferences",
"PHP_DIAGNOSTICS" : "Diagnostics",

//Strings for LanguageTools Preferences
LANGUAGE_TOOLS_PREFERENCES : "Preferences for Language Tools"
Expand Down