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

Jump to bottom

Ignore all unknown editor settings in conversion #650

Merged
merged 1 commit into from Jul 29, 2020
Merged

Ignore all unknown editor settings in conversion #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
79 changes: 46 additions & 33 deletions src/editorSettings/convertEditorSettings.test.ts
View file
Open in desktop
Expand Up @@ -13,29 +13,26 @@ describe("convertEditorSettings", () => {
};

// Act
const { converted, missing, failed } = convertEditorSettings(
{ converters },
editorConfiguration,
);
const result = convertEditorSettings({ converters }, editorConfiguration);

// Assert
expect(converted.size).toEqual(0);
expect(missing.length).toEqual(0);
expect(failed.length).toEqual(0);
expect(result).toEqual({
converted: new Map(),
failed: [],
missing: [],
});
});

it("skips a configuration if not an editor setting", () => {
// Arrange
const conversionResult: EditorSettingConversionResult = {
const { editorSetting, converters } = setupConversionEnvironment({
settings: [
{
editorSettingName: "editor.eslint-setting-a",
value: "a",
},
],
};

const { editorSetting, converters } = setupConversionEnvironment(conversionResult);
});

const editorConfiguration = {
notAnEditorSetting: "a",
Expand All @@ -44,29 +41,40 @@ describe("convertEditorSettings", () => {
};

// Act
const { converted, missing, failed } = convertEditorSettings(
{ converters },
editorConfiguration,
);
const result = convertEditorSettings({ converters }, editorConfiguration);

// Assert
expect(converted.size).toEqual(1);
expect(missing.length).toEqual(0);
expect(failed.length).toEqual(0);
expect(result).toEqual({
converted: new Map([
[
"editor.eslint-setting-a",
{
editorSettingName: "editor.eslint-setting-a",
value: "a",
},
],
]),
failed: [],
missing: [],
});
});

it("marks a setting as missing when its converter returns undefined", () => {
// Arrange
const { editorSetting, converters } = setupConversionEnvironment();

// Act
const { missing } = convertEditorSettings(
const result = convertEditorSettings(
{ converters },
{ [editorSetting.editorSettingName]: editorSetting },
);

// Assert
expect(missing).toEqual([{ editorSettingName: editorSetting.editorSettingName }]);
expect(result).toEqual({
converted: new Map(),
failed: [],
missing: [{ editorSettingName: editorSetting.editorSettingName }],
});
});

it("marks a conversion as failed when returned a conversion error", () => {
Expand All @@ -76,45 +84,50 @@ describe("convertEditorSettings", () => {
converters.set(editorSetting.editorSettingName, () => conversionError);

// Act
const { failed } = convertEditorSettings(
const result = convertEditorSettings(
{ converters },
{ [editorSetting.editorSettingName]: editorSetting },
);

// Assert
expect(failed).toEqual([conversionError]);
expect(result).toEqual({
converted: new Map(),
failed: [conversionError],
missing: [],
});
});

it("marks a converted setting name as converted when a conversion has settings", () => {
// Arrange
const conversionResult: EditorSettingConversionResult = {
const { editorSetting, converters } = setupConversionEnvironment({
settings: [
{
editorSettingName: "editor.eslint-setting-a",
editorSettingName: "eslint.configFile",
value: "a",
},
],
};
const { editorSetting, converters } = setupConversionEnvironment(conversionResult);
});

// Act
const { converted } = convertEditorSettings(
const result = convertEditorSettings(
{ converters },
{ [editorSetting.editorSettingName]: editorSetting.value },
);

// Assert
expect(converted).toEqual(
new Map([
expect(result).toEqual({
converted: new Map([
[
"editor.eslint-setting-a",
"eslint.configFile",
{
editorSettingName: "editor.eslint-setting-a",
editorSettingName: "eslint.configFile",
value: "a",
},
],
]),
);
failed: [],
missing: [],
});
});
});

Expand All @@ -127,7 +140,7 @@ function setupConversionEnvironment(conversionResult?: EditorSettingConversionRe

function createSampleEditorSetting(): EditorSetting {
return {
editorSettingName: "editor.tslint-editor-setting-a",
editorSettingName: "tslint.configFile",
value: "a",
};
}
Expand Down
11 changes: 9 additions & 2 deletions src/editorSettings/convertEditorSettings.ts
View file
Open in desktop
Expand Up @@ -4,7 +4,14 @@ import { convertEditorSetting } from "./convertEditorSetting";
import { EditorSettingConverter } from "./converter";
import { EditorSetting } from "./types";

const EDITOR_SETTINGS_PREFIX = "editor.";
const knownEditorSettings = new Set([
"tslint.configFile",
"tslint.jsEnable",
"tslint.ignoreDefinitionFiles",
"tslint.exclude",
"tslint.alwaysShowRuleFailuresAsWarnings",
"tslint.suppressWhileTypeErrorsPresent",
]);

export type ConvertEditorSettingsDependencies = {
converters: Map<string, EditorSettingConverter>;
Expand All @@ -30,7 +37,7 @@ export const convertEditorSettings = (
for (const [configurationName, value] of Object.entries(rawEditorConfiguration)) {
// Configurations other than editor settings will be ignored.
// See: https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin#configuration
if (!configurationName.startsWith(EDITOR_SETTINGS_PREFIX)) {
if (!knownEditorSettings.has(configurationName)) {
continue;
}

Expand Down