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