Theia APIs——Preferences

  • 时间:
  • 浏览:0

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

Preferences

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

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

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

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

  要使用你你你你这些代理,只须要将它绑定到有1个 多多新类型X = PreferenceProxy<CONFIGURATION_INTERFACE>,你你你你这些使用里边的法子bind(X)到有1个 多多代理。

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