@opensumi/ide-preferences 2.21.13 → 2.22.0

package/src/browser/workspace-preference-provider.ts

@@ -0,0 +1,129 @@
+import { Injectable, Autowired } from '@opensumi/di';
+import { URI, DisposableCollection } from '@opensumi/ide-core-browser';
+import { PreferenceScope, PreferenceProvider } from '@opensumi/ide-core-browser/lib/preferences';
+import { IWorkspaceService } from '@opensumi/ide-workspace';
+
+import { WorkspaceFilePreferenceProviderFactory } from './workspace-file-preference-provider';
+
+@Injectable()
+export class WorkspacePreferenceProvider extends PreferenceProvider {
+  public name: 'workspace';
+
+  @Autowired(IWorkspaceService)
+  protected readonly workspaceService: IWorkspaceService;
+
+  @Autowired(WorkspaceFilePreferenceProviderFactory)
+  protected readonly workspaceFileProviderFactory: WorkspaceFilePreferenceProviderFactory;
+
+  // 该实例仅在工作区模式下才需要实例化
+  @Autowired(PreferenceProvider, { tag: PreferenceScope.Folder })
+  protected readonly foldersPreferenceProvider: PreferenceProvider;
+
+  constructor() {
+    super();
+    this.init();
+  }
+
+  protected async init(): Promise<void> {
+    this._ready.resolve();
+    this.ensureDelegateUpToDate();
+    this.workspaceService.onWorkspaceLocationChanged(() => this.ensureDelegateUpToDate());
+  }
+
+  getConfigUri(resourceUri: string | undefined = this.ensureResourceUri()): URI | undefined {
+    const delegate = this.delegate;
+    return delegate && delegate.getConfigUri(resourceUri);
+  }
+
+  protected _delegate: PreferenceProvider | undefined;
+  protected get delegate(): PreferenceProvider | undefined {
+    if (!this._delegate) {
+      this.ensureDelegateUpToDate();
+    }
+    return this._delegate;
+  }
+
+  protected readonly toDisposeOnEnsureDelegateUpToDate = new DisposableCollection();
+  protected ensureDelegateUpToDate(): void {
+    const delegate = this.createDelegate();
+    if (this._delegate !== delegate) {
+      this.toDisposeOnEnsureDelegateUpToDate.dispose();
+      this.toDispose.push(this.toDisposeOnEnsureDelegateUpToDate);
+
+      this._delegate = delegate;
+
+      if (delegate) {
+        this.toDisposeOnEnsureDelegateUpToDate.pushAll([
+          delegate,
+          delegate.onDidPreferencesChanged((changes) => {
+            this.emitPreferencesChangedEvent(changes);
+          }),
+        ]);
+      }
+    }
+  }
+
+  protected createDelegate(): PreferenceProvider | undefined {
+    const workspace = this.workspaceService.workspace;
+    if (!workspace) {
+      return undefined;
+    }
+    // 如果不是在多工作区模式下，返回foldersPreferenceProvider
+    if (!this.workspaceService.isMultiRootWorkspaceOpened) {
+      return this.foldersPreferenceProvider;
+    }
+    // 工作区模式下需要额外读取一次工作区对应的配置文件内容进行配置合并
+    // PreferenceScope.Folder 为默认优先级最高的配置
+    return this.workspaceFileProviderFactory({
+      workspaceUri: new URI(workspace.uri),
+    });
+  }
+
+  doGet<T>(
+    preferenceName: string,
+    resourceUri: string | undefined = this.ensureResourceUri(),
+    language?: string,
+  ): T | undefined {
+    const delegate = this.delegate;
+    return delegate ? delegate.get<T>(preferenceName, resourceUri, language) : undefined;
+  }
+
+  doResolve<T>(
+    preferenceName: string,
+    resourceUri: string | undefined = this.ensureResourceUri(),
+    language?: string,
+  ): { value?: T; configUri?: URI } {
+    const delegate = this.delegate;
+    return delegate ? delegate.resolve<T>(preferenceName, resourceUri, language) : {};
+  }
+
+  getPreferences(resourceUri: string | undefined = this.ensureResourceUri(), language?: string) {
+    const delegate = this.delegate;
+    return delegate ? delegate.getPreferences(resourceUri, language) : undefined;
+  }
+
+  getLanguagePreferences(resourceUri: string | undefined = this.ensureResourceUri()) {
+    const delegate = this.delegate;
+    return delegate ? delegate.getLanguagePreferences(resourceUri) : undefined;
+  }
+
+  async doSetPreference(
+    preferenceName: string,
+    value: any,
+    resourceUri: string | undefined = this.ensureResourceUri(),
+    language?: string,
+  ): Promise<boolean> {
+    const delegate = this.delegate;
+    if (delegate) {
+      return delegate.setPreference(preferenceName, value, resourceUri, language);
+    }
+    return false;
+  }
+
+  protected ensureResourceUri(): string | undefined {
+    if (this.workspaceService.workspace && !this.workspaceService.isMultiRootWorkspaceOpened) {
+      return this.workspaceService.workspace.uri;
+    }
+    return undefined;
+  }
+}

package/src/common/commands.ts

@@ -0,0 +1,5 @@
+import { Command } from '@opensumi/ide-core-browser';
+
+export const SettingJSONGlyphMarginEdit: Command = {
+  id: 'preference.setting.glyphMargin.edit',
+};

package/src/common/index.ts

@@ -0,0 +1,4 @@
+export * from './preference';
+export * from './user-storage';
+export * from './preference-id';
+export * from './types';

package/src/common/preference-id.ts

@@ -0,0 +1,11 @@
+export enum PreferenceSettingId {
+  General = 'general',
+  Editor = 'editor',
+  Terminal = 'terminal',
+  Feature = 'feature',
+  View = 'view',
+}
+
+export const knownPrefIdMappings = {
+  'workbench.editor.enablePreview': 'editor.previewMode',
+};

package/src/common/preference.ts

@@ -0,0 +1,51 @@
+import { IPreferenceViewDesc, localize } from '@opensumi/ide-core-browser';
+
+export const PREF_SCHEME = 'pref';
+
+export const knownTermMappings = new Map<string, string>();
+knownTermMappings.set('power shell', 'PowerShell');
+knownTermMappings.set('powershell', 'PowerShell');
+knownTermMappings.set('javascript', 'JavaScript');
+knownTermMappings.set('typescript', 'TypeScript');
+
+['css', 'html', 'scss', 'less', 'json', 'js', 'ts', 'ie', 'id', 'php', 'scm', 'npm'].forEach((v) => {
+  knownTermMappings.set(v, v.toUpperCase());
+});
+
+function transformFirstTerm(term: string): string {
+  const termLowerCase = term.toLowerCase();
+  if (knownTermMappings.has(termLowerCase)) {
+    return knownTermMappings.get(termLowerCase)!;
+  }
+  return toNormalCase(term);
+}
+
+export function toPreferenceReadableName(name: string) {
+  const parts = name.split('.');
+  let result = transformFirstTerm(parts[0]);
+  if (parts[1]) {
+    result += ' > ' + toNormalCase(parts[1]);
+  }
+  if (parts[2]) {
+    result += ' : ' + toNormalCase(parts[2]);
+  }
+  if (parts.slice(3).length > 0) {
+    result += '. ' + parts.slice(3).join(' ');
+  }
+  return result;
+}
+
+export function getPreferenceItemLabel(pref: IPreferenceViewDesc) {
+  let localized: string | undefined;
+  if (pref.localized) {
+    localized = localize(pref.localized);
+  }
+  if (!localized) {
+    localized = toPreferenceReadableName(pref.id);
+  }
+  return localized;
+}
+
+export function toNormalCase(str: string) {
+  return str.substr(0, 1).toUpperCase() + str.substr(1).replace(/([^A-Z])([A-Z])/g, '$1 $2');
+}

package/src/common/types.ts

@@ -0,0 +1,63 @@
+import {
+  ISettingGroup,
+  ISettingSection,
+  IDisposable,
+  PreferenceScope,
+  IResolvedPreferenceViewDesc,
+} from '@opensumi/ide-core-browser';
+
+export const SettingContribution = Symbol('SettingContribution');
+
+export interface SettingContribution {
+  /**
+   * 注册 Setting
+   * @param registry
+   */
+  registerSetting?(registry: {
+    registerSettingGroup: (settingGroup: ISettingGroup) => IDisposable;
+    registerSettingSection: (key: string, section: ISettingSection) => IDisposable;
+  }): void;
+
+  /**
+   * 最后处理一次 SettingGroup
+   * @params settingGroup
+   */
+  handleSettingGroup?(settingGroup: ISettingGroup[]): ISettingGroup[];
+
+  /**
+   * 最后处理一次 settingSections
+   * @params settingSections
+   */
+  handleSettingSections?(settingSections: { [key: string]: ISettingSection[] }): { [key: string]: ISettingSection[] };
+}
+
+export interface IPreferenceTask {
+  path: string[];
+  key: string;
+  value: string;
+}
+
+export interface ISectionItemData {
+  /**
+   * 有两种：
+   * - section:${sectionTitle}
+   * - group:${groupId}
+   */
+  id?: string;
+  scope: PreferenceScope;
+
+  title?: string;
+  component?: any;
+  preference?: IResolvedPreferenceViewDesc;
+
+  /**
+   * 该 item 在左侧文件树的路径信息
+   */
+  _path?: string;
+}
+
+export const enum ESectionItemKind {
+  Section = 'section:',
+  Group = 'group:',
+  Preference = 'preference:',
+}

package/src/common/user-storage.ts

@@ -0,0 +1,6 @@
+import { FileSystemProvider } from '@opensumi/ide-core-browser';
+
+export const IUserStorageService = Symbol('IUserStorageService');
+
+// tslint:disable-next-line: no-empty-interface
+export type IUserStorageService = FileSystemProvider;

package/src/index.ts

@@ -0,0 +1 @@
+export * from './common';

package/lib/browser/folder-preference-provider.d.ts

@@ -1,26 +0,0 @@
-import { URI, PreferenceScope } from '@opensumi/ide-core-browser';
-import { FileStat } from '@opensumi/ide-file-service';
-import { IWorkspaceService } from '@opensumi/ide-workspace/lib/common';
-import { AbstractResourcePreferenceProvider } from './abstract-resource-preference-provider';
-export declare const FolderPreferenceProviderFactory: unique symbol;
-export declare type FolderPreferenceProviderFactory = (options: FolderPreferenceProviderOptions) => FolderPreferenceProvider;
-export declare const FolderPreferenceProviderOptions: unique symbol;
-export interface FolderPreferenceProviderOptions {
-    readonly folder: FileStat;
-    readonly configUri: URI;
-}
-/**
- * 这玩意应该叫 FolderFilePreferenceProvider， 它代表的是一个文件夹下的 “一个” 文件读出来的配置项
- * 但是一个文件夹的配置文件夹比如 .sumi 内可以存在多个这样的文件, 比如 settings.json, launch.json
- * 他们的结果会合并并且放入各自的section中。
- */
-export declare class FolderPreferenceProvider extends AbstractResourcePreferenceProvider {
-    protected readonly options: FolderPreferenceProviderOptions;
-    protected readonly workspaceService: IWorkspaceService;
-    private _folderUri;
-    get folderUri(): URI;
-    getUri(): URI;
-    protected getScope(): PreferenceScope;
-    getDomain(): string[];
-}
-//# sourceMappingURL=folder-preference-provider.d.ts.map

package/lib/browser/folder-preference-provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"folder-preference-provider.d.ts","sourceRoot":"","sources":["../../src/browser/folder-preference-provider.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAEvE,OAAO,EAAE,kCAAkC,EAAE,MAAM,yCAAyC,CAAC;AAE7F,eAAO,MAAM,+BAA+B,eAA4C,CAAC;AACzF,oBAAY,+BAA+B,GAAG,CAAC,OAAO,EAAE,+BAA+B,KAAK,wBAAwB,CAAC;AAErH,eAAO,MAAM,+BAA+B,eAA4C,CAAC;AACzF,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;CACzB;AAED;;;;GAIG;AACH,qBACa,wBAAyB,SAAQ,kCAAkC;IAG9E,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,+BAA+B,CAAC;IAG5D,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAEvD,OAAO,CAAC,UAAU,CAAM;IAExB,IAAI,SAAS,IAAI,GAAG,CAKnB;IAEM,MAAM,IAAI,GAAG;IAIpB,SAAS,CAAC,QAAQ,IAAI,eAAe;IAQrC,SAAS,IAAI,MAAM,EAAE;CAGtB"}

package/lib/browser/folder-preference-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"folder-preference-provider.js","sourceRoot":"","sources":["../../src/browser/folder-preference-provider.ts"],"names":[],"mappings":";;;;AAAA,qCAAqD;AACrD,iEAAkE;AAElE,+DAAuE;AAEvE,mGAA6F;AAEhF,QAAA,+BAA+B,GAAG,MAAM,CAAC,iCAAiC,CAAC,CAAC;AAG5E,QAAA,+BAA+B,GAAG,MAAM,CAAC,iCAAiC,CAAC,CAAC;AAMzF;;;;GAIG;AAEH,IAAa,wBAAwB,GAArC,MAAa,wBAAyB,SAAQ,0EAAkC;IAU9E,IAAI,SAAS;QACX,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,IAAI,sBAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;IAES,QAAQ;QAChB,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,0BAA0B,EAAE;YACrD,OAAO,kCAAe,CAAC,SAAS,CAAC;SAClC;QACD,OAAO,kCAAe,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,SAAS;QACP,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AA7BC;IADC,IAAA,cAAS,EAAC,uCAA+B,CAAC;;yDACiB;AAG5D;IADC,IAAA,cAAS,EAAC,0BAAiB,CAAC;;kEAC0B;AAN5C,wBAAwB;IADpC,IAAA,eAAU,GAAE;GACA,wBAAwB,CAgCpC;AAhCY,4DAAwB"}

package/lib/browser/index.less

@@ -1,36 +0,0 @@
-.preference-view {
-  margin: 40;
-  height: 100%;
-  color: #ccc;
-  .scope-select {
-    position: fixed;
-    right: 100px;
-  }
-  .preference-line {
-    margin: 40px;
-  }
-  .key {
-    font-weight: bold;
-  }
-  .control-wrap {
-    color: #fff;
-    select,
-    input {
-      border: none;
-      background: #333;
-      padding: 3px 5px;
-    }
-  }
-  .desc {
-  }
-  .text-control {
-    max-width: 500px;
-    width: 100%;
-  }
-  .select-control {
-    width: 300px;
-  }
-  .number-control {
-    width: 300px;
-  }
-}