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