Register Custom Preferences

There are two main ways to register frequently-used customized configurations:

1. Register on the integration side by using module contribution points.
2. Register by using Configurations contribution points of extensions.

OpenSumi provides custom configuration capabilities based on OpenSumi's Contribution Point mechanism. You only need to implement PreferenceContribution to register the configuration.

For example, we can register the runtime configuration in the project by creating a DemoPreferenceContribution with the following pseudo code:

import { PreferenceContribution } from '@opensumi/ide-core-browser';
import { Domain, PreferenceSchema } from '@opensumi/ide-core-common';

export const DemoPreferenceSchema: PreferenceSchema = {
  type: 'object',
  properties: {
    testValue: {
      type: 'string',
      default: 'test',
      description: 'test'
    }
  }
};

@Domain(PreferenceContribution)
export class DemoPreferenceContribution implements PreferenceContribution {
  public schema: PreferenceSchema = DemoPreferenceSchema;
}

By introducing the DemoPreferenceContribution into the Providers declaration in the module, it can be used in other modules in the following way:

@Autowired(PreferenceService)
protected readonly preferenceService: PreferenceService;

...
this.preferenceService.get('testValue')

Another way to register is to use extensions configuration Contribution points.

Customize Integration Parameters

When integrating OpenSumi framework, we often need to perform independent configurations, and the following table lists some parameters that can be configured during the integration phase by passing in configuration items.

In Electron IDE Sample, you can find the renderApp initialization method in src/browser/index.ts#L113 and add the following:

renderApp({
  // add your configuration
  appName: 'OpenSumi',
  ...
})

Also you can find the same configuration logic on WebIDE Sample, see src/browser/index.ts#L12.

The complete configuration file can be found in the live code packages/core-browser/src/react-providers/config-provider.tsx#L14~#L245.

Browser Configuration

The definition can be found in the AppConfig definition in @opensumi/ide-core-browser.

Node Configuration

The definition can be found in the AppConfig definition in @opensumi/ide-core-node.

For more configurations, please see the OpenSumi source code.