3分时时彩官网_3分时时彩平台哪个好_玩3分时时彩的网站

Theia APIs——Preferences

时间:2020-01-15 18:19:22 出处:3分时时彩官网_3分时时彩平台哪个好_玩3分时时彩的网站

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

热门

热门标签