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