Theia APIs——Preferences

  • 时间:
  • 浏览:0
  • 来源:十分时时彩_十分时时彩网投平台_线上十分时时彩投注平台

上一篇:Theia APIs——命令和快捷键

Preferences

  Theia有一有另2个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)。

  所哪些地方地方地方文件都需要所含一有另2个有效的JSON,其中所含preferences的名称和值(注意下面例子中的preference需要官方指定的,这里仅作为一有另2个示例)。如有需要,你也可不能不能在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的一有另2个模块。

使用inversity创建具有默认preferences的模块

  为了提供preference的值,模块需要提供一有另2个有效的json schema,用来验证所提供的值。模块需要像下面另一有另2个将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;
}

   其实朋友 可不能不能在类中直接另一有另2个使用,不过filesystem提供了一有另2个特定于filesystem preferences的代理preference服务(该服务在后台运行),另一有另2个可不能不能变慢、更有效地搜索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.
}

  要使用你这俩代理,只需要将它绑定到一有另2个新类型X = PreferenceProxy<CONFIGURATION_INTERFACE>,因此使用后边的方法 bind(X)到一有另2个代理。

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配置,只需要将它注入到你需要的地方。我能 像另一有另2个访问preference(以filesystem为例):

const patterns = this.preferences['files.watcherExclude'];

  你也可不能不能像另一有另2个监听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服务器会触发一有另2个事件。首先,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