Theia APIs——Preferences

  • 时间:
  • 浏览:0
  • 来源:大发时时彩_时时彩高手计划_大发时时彩高手计划

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

Preferences

  Theia有二个多多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)。

  所哪些地方地方地方文件都能够包所含一个多多有效的JSON,其中所含preferences的名称和值(注意下面例子中的preference都有官方指定的,这里仅作为二个多多示例)。如有能够,你能够能在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的二个多多模块。

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

  为了提供preference的值,模块能够提供二个多多有效的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提供了二个多多特定于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.
}

  要使用什儿 代理,只能够将它绑定到二个多多新类型X = PreferenceProxy<CONFIGURATION_INTERFACE>,因此使用里面的法子bind(X)到二个多多代理。

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服务器会触发二个多多事件。首先,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