Theia APIs——Preferences

  • 时间:
  • 浏览:5
  • 来源:幸运快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