Theia APIs——Preferences

  • 时间:
  • 浏览:1
  • 来源:大发快三_快三开户网址_大发快三开户网址

上一篇:Theia APIs——命令和快捷键

Preferences

  Theia有有有有2个 多preference service,模块还能够通过它来获取preference的值,提供默认的preferences以及监听preference的更改。

  Preferences的内容还能够保居于workspace根目录下的.theia/settings.json中,但是Linux系统的$HOME/.theia/settings.json文件中。在Windows系统中,用户设置默认保居于%USERPROFILE%/.theia/settings.json文件中(之类c:\Users\epatpol\.theia\settings.json)。

  所有或多或少文件都时要包富含有有2个 多有效的JSON,其中富含preferences的名称和值(注意下面例子中的preference时要官方指定的,这里仅作为有有有2个 多示例)。如有时要,你也还能够在settings.json文件中打上去注释。如:

{
    // Enable/Disable the line numbers in the monaco editor
    "monaco.lineNumbers": "off",
    // Tab width in the editor
    "monaco.tabWidth": 4,
    "fs.watcherExcludes": "path/to/file"
}

  让我们歌词 歌词 以filesystem作为示例,它是使用preference service的有有有2个 多模块。

使用inversity创建具有默认preferences的模块

  为了提供preference的值,模块时要提供有有有2个 多有效的json schema,用来验证所提供的值。模块时要像下面原本将PreferenceContributton绑定到值:

export interface PreferenceSchema {
    [name: string]: Object,
    properties: {
        [name: string]: object
    }
}

export interface PreferenceContribution {
    readonly schema: PreferenceSchema;
}

  之类,filesystem中的代码:

export const filesystemPreferenceSchema: PreferenceSchema = {
    "type": "object",
    "properties": {
        "files.watcherExclude": {
            "description": "List of paths to exclude from the filesystem watcher",
            "additionalProperties": {
                "type": "boolean"
            }
        }
    }
};

bind(PreferenceContribution).toConstantValue(
{ 
    schema: filesystemPreferenceSchema 
});

  下面是或多或少有关提供验证的schema的链接:

通过配置监听preference的更改

  要使用preference的值,只需从容器中获得注入的PreferenceService。

const preferences = ctx.container.get(PreferenceService);

   对filesystem而言,服务在一开始绑定的刚刚获取。这里,我想要使用onPreferenceChanged法律土办法来注册preference更改的回调。

constructor(@inject(PreferenceService) protected readonly prefService: PreferenceService
    prefService.onPreferenceChanged(e => { callback }

  这里,事件接收到的对象e是下面或多或少类型:

export interface PreferenceChangedEvent {
    readonly preferenceName: string;
    readonly newValue?: any;
    readonly oldValue?: any;
}

   我嘴笨 让我们歌词 歌词 还能够在类中直接原本使用,不过filesystem提供了有有有2个 多特定于filesystem preferences的代理preference服务(该服务在后台运行),原本还能够减慢、更有效地搜索preference(但是它在filesystem preference service中进行搜索,而时要通过更通用的preference service搜索所有的内容)。从或多或少意义上来说,它也更高效,但是如此 或多或少监视与某个模块相关的特定preferences的模块才会得到通知。要做到或多或少点,还能够看看有关filesystem配置的代理接口是如保绑定使用preference代理接口的:

export type PreferenceProxy<T> = Readonly<T> & Disposable & PreferenceEventEmitter<T>;
export function createPreferenceProxy<T extends Configuration>(preferences: PreferenceService, configuration: T): PreferenceProxy<T> {
    /* Register a client to the preference server
    When a preference is received, it is validated against the schema and then fired if valid, otherwise the default value is provided.

    This proxy is also in charge of calling the configured preference service when the proxy object is called i.e editorPrefs['preferenceName']

    It basically forwards methods to the real object, i.e dispose/ready etc.
}

  要使用或多或少代理,只时要将它绑定到有有有2个 多新类型X = PreferenceProxy<CONFIGURATION_INTERFACE>,但是使用上方的法律土办法bind(X)到有有有2个 多代理。

export interface FileSystemConfiguration {
    'files.watcherExclude': { [globPattern: string]: boolean }
}

export const FileSystemPreferences = Symbol('FileSystemPreferences');
export type FileSystemPreferences = PreferenceProxy<FileSystemConfiguration>;

export function createFileSystemPreferences(preferences: PreferenceService): FileSystemPreferences {
    return createPreferenceProxy(preferences, defaultFileSystemConfiguration, filesystemPreferenceSchema);
}

export function bindFileSystemPreferences(bind: interfaces.Bind): void {

    bind(FileSystemPreferences).toDynamicValue(ctx => {
        const preferences = ctx.container.get(PreferenceService);
        return createFileSystemPreferences(preferences);
    });

    bind(PreferenceContribution).toConstantValue({ schema: filesystemPreferenceSchema });

}

  最后,在模块中使用filesystem配置,只时要将它注入到你时要的地方。我想要像原本访问preference(以filesystem为例):

const patterns = this.preferences['files.watcherExclude'];

  你也还能够像原本监听preference的更改:

this.toDispose.push(preferences.onPreferenceChanged(e => {
    if (e.preferenceName === 'files.watcherExclude') {
        this.toRestartAll.dispose();
    }
}));
constructor(...,
        @inject(FileSystemPreferences) protected readonly preferences: FileSystemPreferences) {
    ...
         this.toDispose.push(preferences.onPreferenceChanged(e => {
            if (e.preferenceName === 'files.watcherExclude') {
                this.toRestartAll.dispose();
            }
        }));
    ...
}

Preference的修改流程

  当在${workspace}/.theia/但是os.homedir()/.theia/中修改settings.json的内容时,JSON preference服务器会触发有有有2个 多事件。首先,CompoundPreferenceServer用来管理不同的服务器(作用域),之类workspace/user/defaults(提供上方说的contributions)。接下来,PreferenceService管理该服务器并在其上打上去更多api以方便调用(之类getBoolean,getSrtring等等),它同時 还允许客户端监听preference的修改。或多或少PreferenceService还能够直接或通过特定的代理(如上方或多或少filesystem配置)被注入到模块中。

  当preference被修改时,对应的流程是:

.theia/settings.json -> JsonPreferenceServer -> CompoundPreferenceServer -> PreferenceService -> PreferenceProxy<FileSystemConfiguration> -> FileSystemWatcher

获取preference的值

  对于filesystem来说,让我们歌词 歌词 还能够使用与上方相同的代理配置来访问preference的内容。

    if (this.prefService['preferenceName']) {
    ...
    }
    
    if (this.prefService['preferenceName2']) {
    ...
    }
})

  它能正常工作,正如让我们歌词 歌词 在上方所就看的那样,代理将简单地调用prefService.get('preferenceName')。

TODO/FIXME

  • 在CompoundPreferenceServer中打上去server优先级

  • 当在theia的settings.json中修改内容时打上去自动完成和描述功能

原文地址:https://theia-ide.org/docs/preferences