@difizen/libro-common 0.3.4 → 1.0.0

package/src/core/keybinding/vs/contextkeys.ts

@@ -0,0 +1,52 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { isMacintosh, isLinux, isWindows, isWeb } from '../../../common/index.js';
+import { localize } from '../../nls';
+
+import { RawContextKey } from './contextkey';
+
+export const IsMacContext = new RawContextKey<boolean>(
+  'isMac',
+  isMacintosh,
+  localize('isMac', 'Whether the operating system is macOS'),
+);
+export const IsLinuxContext = new RawContextKey<boolean>(
+  'isLinux',
+  isLinux,
+  localize('isLinux', 'Whether the operating system is Linux'),
+);
+export const IsWindowsContext = new RawContextKey<boolean>(
+  'isWindows',
+  isWindows,
+  localize('isWindows', 'Whether the operating system is Windows'),
+);
+
+export const IsWebContext = new RawContextKey<boolean>(
+  'isWeb',
+  isWeb,
+  localize('isWeb', 'Whether the platform is a web browser'),
+);
+export const IsMacNativeContext = new RawContextKey<boolean>(
+  'isMacNative',
+  isMacintosh && !isWeb,
+  localize(
+    'isMacNative',
+    'Whether the operating system is macOS on a non-browser platform',
+  ),
+);
+
+export const IsDevelopmentContext = new RawContextKey<boolean>(
+  'isDevelopment',
+  false,
+  true,
+);
+
+export const InputFocusedContextKey = 'inputFocus';
+export const InputFocusedContext = new RawContextKey<boolean>(
+  InputFocusedContextKey,
+  false,
+  localize('inputFocus', 'Whether keyboard focus is inside an input box'),
+);

package/src/core/keybinding/vs/jsonContributionRegistry.ts

@@ -0,0 +1,74 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import type { Event } from '../../../common/index.js';
+import { Emitter } from '../../../common/index.js';
+
+import type { IJSONSchema } from './jsonSchema';
+import * as platform from './platform';
+
+export const Extensions = {
+  JSONContribution: 'base.contributions.json',
+};
+
+export interface ISchemaContributions {
+  schemas: Record<string, IJSONSchema>;
+}
+
+export interface IJSONContributionRegistry {
+  readonly onDidChangeSchema: Event<string>;
+
+  /**
+   * Register a schema to the registry.
+   */
+  registerSchema: (uri: string, unresolvedSchemaContent: IJSONSchema) => void;
+
+  /**
+   * Notifies all listeners that the content of the given schema has changed.
+   * @param uri The id of the schema
+   */
+  notifySchemaChanged: (uri: string) => void;
+
+  /**
+   * Get all schemas
+   */
+  getSchemaContributions: () => ISchemaContributions;
+}
+
+function normalizeId(id: string) {
+  if (id.length > 0 && id.charAt(id.length - 1) === '#') {
+    return id.substring(0, id.length - 1);
+  }
+  return id;
+}
+
+class JSONContributionRegistry implements IJSONContributionRegistry {
+  private schemasById: Record<string, IJSONSchema>;
+
+  private readonly _onDidChangeSchema = new Emitter<string>();
+  readonly onDidChangeSchema: Event<string> = this._onDidChangeSchema.event;
+
+  constructor() {
+    this.schemasById = {};
+  }
+
+  public registerSchema(uri: string, unresolvedSchemaContent: IJSONSchema): void {
+    this.schemasById[normalizeId(uri)] = unresolvedSchemaContent;
+    this._onDidChangeSchema.fire(uri);
+  }
+
+  public notifySchemaChanged(uri: string): void {
+    this._onDidChangeSchema.fire(uri);
+  }
+
+  public getSchemaContributions(): ISchemaContributions {
+    return {
+      schemas: this.schemasById,
+    };
+  }
+}
+
+const jsonContributionRegistry = new JSONContributionRegistry();
+platform.Registry.add(Extensions.JSONContribution, jsonContributionRegistry);

package/src/core/keybinding/vs/jsonSchema.ts

@@ -0,0 +1,85 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export type JSONSchemaType =
+  | 'string'
+  | 'number'
+  | 'integer'
+  | 'boolean'
+  | 'null'
+  | 'array'
+  | 'object';
+
+export interface IJSONSchema {
+  id?: string;
+  $id?: string;
+  $schema?: string;
+  type?: JSONSchemaType | JSONSchemaType[];
+  title?: string;
+  default?: any;
+  definitions?: IJSONSchemaMap;
+  description?: string;
+  properties?: IJSONSchemaMap;
+  patternProperties?: IJSONSchemaMap;
+  additionalProperties?: boolean | IJSONSchema;
+  minProperties?: number;
+  maxProperties?: number;
+  dependencies?: IJSONSchemaMap | Record<string, string[]>;
+  items?: IJSONSchema | IJSONSchema[];
+  minItems?: number;
+  maxItems?: number;
+  uniqueItems?: boolean;
+  additionalItems?: boolean | IJSONSchema;
+  pattern?: string;
+  minLength?: number;
+  maxLength?: number;
+  minimum?: number;
+  maximum?: number;
+  exclusiveMinimum?: boolean | number;
+  exclusiveMaximum?: boolean | number;
+  multipleOf?: number;
+  required?: string[];
+  $ref?: string;
+  anyOf?: IJSONSchema[];
+  allOf?: IJSONSchema[];
+  oneOf?: IJSONSchema[];
+  not?: IJSONSchema;
+  enum?: any[];
+  format?: string;
+
+  // schema draft 06
+  const?: any;
+  contains?: IJSONSchema;
+  propertyNames?: IJSONSchema;
+
+  // schema draft 07
+  $comment?: string;
+  if?: IJSONSchema;
+  then?: IJSONSchema;
+  else?: IJSONSchema;
+
+  // VS Code extensions
+  defaultSnippets?: IJSONSchemaSnippet[];
+  errorMessage?: string;
+  patternErrorMessage?: string;
+  deprecationMessage?: string | undefined;
+  markdownDeprecationMessage?: string;
+  enumDescriptions?: string[];
+  markdownEnumDescriptions?: string[];
+  markdownDescription?: string;
+  doNotSuggest?: boolean;
+  suggestSortText?: string;
+  allowComments?: boolean;
+  allowTrailingCommas?: boolean;
+}
+
+export type IJSONSchemaMap = Record<string, IJSONSchema>;
+
+export interface IJSONSchemaSnippet {
+  label?: string;
+  description?: string;
+  body?: any; // a object that will be JSON stringified
+  bodyText?: string; // an already stringified JSON object that can contain new lines (\n) and tabs (\t)
+}

package/src/core/keybinding/vs/platform.test.ts

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import 'regenerator-runtime/runtime';
+import * as assert from 'assert';
+
+import { types } from '../../../common/index.js';
+
+import { Registry } from './platform';
+
+describe('Platform / Registry', () => {
+  test('registry - api', function () {
+    assert.ok(types.isFunction(Registry.add));
+    assert.ok(types.isFunction(Registry.as));
+    assert.ok(types.isFunction(Registry.knows));
+  });
+
+  test('registry - mixin', function () {
+    Registry.add('foo', { bar: true });
+
+    assert.ok(Registry.knows('foo'));
+    assert.ok(Registry.as<any>('foo').bar);
+    assert.equal(Registry.as<any>('foo').bar, true);
+  });
+
+  test('registry - knows, as', function () {
+    const ext = {};
+
+    Registry.add('knows,as', ext);
+
+    assert.ok(Registry.knows('knows,as'));
+    assert.ok(!Registry.knows('knows,as1234'));
+
+    assert.ok(Registry.as('knows,as') === ext);
+    assert.ok(Registry.as('knows,as1234') === null);
+  });
+
+  test('registry - mixin, fails on duplicate ids', function () {
+    Registry.add('foo-dup', { bar: true });
+
+    try {
+      Registry.add('foo-dup', { bar: false });
+      assert.ok(false);
+    } catch (e) {
+      assert.ok(true);
+    }
+  });
+});

package/src/core/keybinding/vs/platform.ts

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { types, ok } from '../../../common/index.js';
+
+export interface IRegistry {
+  /**
+   * Adds the extension functions and properties defined by data to the
+   * platform. The provided id must be unique.
+   * @param id a unique identifier
+   * @param data a contribution
+   */
+  add: (id: string, data: any) => void;
+
+  /**
+   * Returns true iff there is an extension with the provided id.
+   * @param id an extension identifier
+   */
+  knows: (id: string) => boolean;
+
+  /**
+   * Returns the extension functions and properties defined by the specified key or null.
+   * @param id an extension identifier
+   */
+  as: <T>(id: string) => T;
+}
+
+class RegistryImpl implements IRegistry {
+  private readonly data = new Map<string, any>();
+
+  public add(id: string, data: any): void {
+    ok(types.isString(id));
+    ok(types.isObject(data));
+    ok(!this.data.has(id), 'There is already an extension with this id');
+
+    this.data.set(id, data);
+  }
+
+  public knows(id: string): boolean {
+    return this.data.has(id);
+  }
+
+  public as(id: string): any {
+    return this.data.get(id) || null;
+  }
+}
+
+export const Registry: IRegistry = new RegistryImpl();