maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

more guidance to the user when configuration writing fails

Browse source
This commit is contained in:
Benjamin Pasero 2016-09-15 13:57:20 +02:00
parent af0c083522
commit ccac827d7d
1 changed files with 23 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/vs/workbench/services/configuration/node/configurationEditingService.ts
View file

@ -55,7 +55,7 @@ export class ConfigurationEditingService implements IConfigurationEditingService
// First validate before making any edits // First validate before making any edits
return this.validate(target, operation).then(validation => { return this.validate(target, operation).then(validation => {
if (typeof validation.error === 'number') { if (typeof validation.error === 'number') {
return this.wrapError(validation.error); return this.wrapError(validation.error, target);
} }
// Create configuration file if missing // Create configuration file if missing
@ -83,8 +83,8 @@ export class ConfigurationEditingService implements IConfigurationEditingService
}); });
} }
private wrapError(code: ConfigurationEditingErrorCode): TPromise<any> { private wrapError(code: ConfigurationEditingErrorCode, target: ConfigurationTarget): TPromise<any> {
const message = this.toErrorMessage(code); const message = this.toErrorMessage(code, target);
return TPromise.wrapError<IConfigurationEditingError>({ return TPromise.wrapError<IConfigurationEditingError>({
code, code,
@ -93,13 +93,29 @@ export class ConfigurationEditingService implements IConfigurationEditingService
}); });
} }
private toErrorMessage(error: ConfigurationEditingErrorCode): string { private toErrorMessage(error: ConfigurationEditingErrorCode, target: ConfigurationTarget): string {
switch (error) { switch (error) {
// API constraints
case ConfigurationEditingErrorCode.ERROR_UNKNOWN_KEY: return nls.localize('errorUnknownKey', "Unable to write to the configuration file (Unknown Key)"); case ConfigurationEditingErrorCode.ERROR_UNKNOWN_KEY: return nls.localize('errorUnknownKey', "Unable to write to the configuration file (Unknown Key)");
case ConfigurationEditingErrorCode.ERROR_INVALID_TARGET: return nls.localize('errorInvalidTarget', "Unable to write to the configuration file (Invalid Target)"); case ConfigurationEditingErrorCode.ERROR_INVALID_TARGET: return nls.localize('errorInvalidTarget', "Unable to write to the configuration file (Invalid Target)");
case ConfigurationEditingErrorCode.ERROR_NO_WORKSPACE_OPENED: return nls.localize('errorWorkspaceOpened', "Unable to write to the configuration file (No Workspace Opened)"); case ConfigurationEditingErrorCode.ERROR_NO_WORKSPACE_OPENED: return nls.localize('errorWorkspaceOpened', "Unable to write to the workspace configuration file (No Workspace Opened)");
case ConfigurationEditingErrorCode.ERROR_INVALID_CONFIGURATION: return nls.localize('errorInvalidConfiguration', "Unable to write to the configuration file (Invalid Configuration Found)");
case ConfigurationEditingErrorCode.ERROR_CONFIGURATION_FILE_DIRTY: return nls.localize('errorConfigurationFileDirty', "Unable to write to the configuration file (Configuration File Dirty)"); // User issues
case ConfigurationEditingErrorCode.ERROR_INVALID_CONFIGURATION: {
if (target === ConfigurationTarget.USER) {
return nls.localize('errorInvalidConfiguration', "Unable to write settings. Please open **User Settings** to correct errors/warnings in the file and try again.");
}
return nls.localize('errorInvalidConfigurationWorkspace', "Unable to write settings. Please open **Workspace Settings** to correct errors/warnings in the file and try again.");
};
case ConfigurationEditingErrorCode.ERROR_CONFIGURATION_FILE_DIRTY: {
if (target === ConfigurationTarget.USER) {
return nls.localize('errorConfigurationFileDirty', "Unable to write settings because the file is dirty. Please save the **User Settings** file and try again.");
}
return nls.localize('errorConfigurationFileDirtyWorkspace', "Unable to write settings because the file is dirty. Please save the **Workspace Settings** file and try again.");
};
} }
} }