Skip to content

Don't modify LS settings if jediEnabled does not exist #12551

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

Merged
merged 2 commits into from
Jun 24, 2020
Merged

Don't modify LS settings if jediEnabled does not exist #12551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57a6360
Don't modify LS settings if jediEnabled does not exist
jakebailey Jun 24, 2020
80868a2
Cleanup
jakebailey Jun 24, 2020
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
51 changes: 32 additions & 19 deletions src/client/testing/common/updateTestSettings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
'use strict';

import { inject, injectable } from 'inversify';
import { applyEdits, Edit, findNodeAtLocation, FormattingOptions, getNodeValue, modify, parseTree } from 'jsonc-parser';
import { applyEdits, findNodeAtLocation, getNodeValue, ModificationOptions, modify, parseTree } from 'jsonc-parser';
import * as path from 'path';
import { IExtensionActivationService, LanguageServerType } from '../../activation/types';
import { IApplicationEnvironment, IWorkspaceService } from '../../common/application/types';
Expand Down Expand Up @@ -104,7 +104,8 @@ export class UpdateTestSettingService implements IExtensionActivationService {

private fixLanguageServerSettings(fileContent: string): string {
// `python.jediEnabled` is deprecated:
// - `true` or missing then set to `languageServer: Jedi`.
// - If missing, do nothing.
// - `true`, then set to `languageServer: Jedi`.
// - `false` and `languageServer` is present, do nothing.
// - `false` and `languageServer` is NOT present, set `languageServer` to `Microsoft`.
// `jediEnabled` is NOT removed since JSONC parser may also remove comments.
Expand All @@ -113,28 +114,40 @@ export class UpdateTestSettingService implements IExtensionActivationService {

try {
const ast = parseTree(fileContent);

const jediEnabledNode = findNodeAtLocation(ast, jediEnabledPath);
const jediEnabled = jediEnabledNode ? getNodeValue(jediEnabledNode) : true;
const languageServerNode = findNodeAtLocation(ast, languageServerPath);
const formattingOptions: FormattingOptions = {
tabSize: 4,
insertSpaces: true
};
let edits: Edit[] = [];

if (!jediEnabledNode || jediEnabled) {
// `jediEnabled` is missing or is true. Default is true, so assume Jedi.
edits = modify(fileContent, languageServerPath, LanguageServerType.Jedi, { formattingOptions });
} else {
// `jediEnabled` is false. if languageServer is missing, set it to Microsoft.
if (!languageServerNode) {
edits = modify(fileContent, languageServerPath, LanguageServerType.Microsoft, {
formattingOptions
});

// If missing, do nothing.
if (!jediEnabledNode) {
return fileContent;
}

const jediEnabled = getNodeValue(jediEnabledNode);

const modificationOptions: ModificationOptions = {
formattingOptions: {
tabSize: 4,
insertSpaces: true
}
};

// `jediEnabled` is true, set it to Jedi.
if (jediEnabled) {
return applyEdits(
fileContent,
modify(fileContent, languageServerPath, LanguageServerType.Jedi, modificationOptions)
);
}

// `jediEnabled` is false. if languageServer is missing, set it to Microsoft.
if (!languageServerNode) {
return applyEdits(
fileContent,
modify(fileContent, languageServerPath, LanguageServerType.Microsoft, modificationOptions)
);
}

fileContent = applyEdits(fileContent, edits);
// tslint:disable-next-line:no-empty
} catch {}
return fileContent;
Expand Down
14 changes: 12 additions & 2 deletions src/test/application/diagnostics/checks/updateTestSettings.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,14 @@ suite('Application Diagnostics - Check Test Settings', () => {

[
{
testTitle: 'No jediEnabled setting.',
testTitle: 'No jediEnabled setting',
contents: '{}',
expectedContent: '{ "python.languageServer": "Jedi" }'
expectedContent: '{}'
},
{
testTitle: 'jediEnabled setting in comment',
contents: '{\n // "python.jediEnabled": true\n }',
expectedContent: '{\n // "python.jediEnabled": true\n }'
},
{
testTitle: 'jediEnabled: true, no languageServer setting',
Expand Down Expand Up @@ -250,6 +255,11 @@ suite('Application Diagnostics - Check Test Settings', () => {
testTitle: 'jediEnabled: false, languageServer is Jedi',
contents: '{ "python.jediEnabled": false, "python.languageServer": "Jedi" }',
expectedContent: '{ "python.jediEnabled": false, "python.languageServer": "Jedi"}'
},
{
testTitle: 'jediEnabled not present, languageServer is Microsoft',
contents: '{ "python.languageServer": "Microsoft" }',
expectedContent: '{ "python.languageServer": "Microsoft" }'
}
].forEach((item) => {
test(item.testTitle, async () => {
Expand Down