Theia APIs——Preferences

  • 时间:
  • 浏览:0
  • 来源:大发pk10_pk10app开户_大发pk10app开户

上一篇: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