Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@theia/preferences

eclipse-theia29.8kEPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.01.61.0TypeScript support: included

Theia - Preferences Extension

theia-extension

readme


theia-ext-logo

ECLIPSE THEIA - PREFERENCES EXTENSION


Description

The @theia/preferences extension implements the preferences API defined in @theia/core, including the four preference providers:

  • Default Preference, which serves as default values of preferences,
  • User Preference for the user home directory, which has precedence over the default values,
  • Workspace Preference for the workspace, which has precedence over User Preference, and
  • Folder Preference for the root folder, which has precedence over the Workspace Preference

To set:

  • User Preferences: Create or edit a settings.json under the .theia folder located either in the user home.
  • Workspace Preference: If one folder is opened as the workspace, create or edit a settings.json under the root of the workspace. If a multi-root workspace is opened, create or edit the "settings" property in the workspace file.
  • Folder Preferences: Create or edit a settings.json under any of the root folders.

Example of a settings.json below:

{
    // Enable/Disable the line numbers in the monaco editor
 "editor.lineNumbers": "off",
    // Tab width in the editor
 "editor.tabSize": 4,
 "files.watcherExclude": "path/to/file"
}

Example of a workspace file below:

{
   "folders": [
      {
         "path": "file:///home/username/helloworld"
   },
   {
         "path": "file:///home/username/dev/byeworld"
      }
   ],
   "settings": {
      // Enable/Disable the line numbers in the monaco editor
   "editor.lineNumbers": "off",
      // Tab width in the editor
   "editor.tabSize": 4,
   }
}

Additional Information

License

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia

Theia - Preferences Extension

License