@theia/preview 1.45.0 → 1.46.0-next.72

package/lib/browser/markdown/markdown-preview-handler.spec.js

@@ -1,194 +1,194 @@
-"use strict";
-// *****************************************************************************
-// Copyright (C) 2018 TypeFox and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable no-unsanitized/property */
-const jsdom_1 = require("@theia/core/lib/browser/test/jsdom");
-let disableJSDOM = (0, jsdom_1.enableJSDOM)();
-const frontend_application_config_provider_1 = require("@theia/core/lib/browser/frontend-application-config-provider");
-frontend_application_config_provider_1.FrontendApplicationConfigProvider.set({});
-const chai = require("chai");
-const chai_1 = require("chai");
-const uri_1 = require("@theia/core/lib/common/uri");
-const markdown_preview_handler_1 = require("./markdown-preview-handler");
-disableJSDOM();
-chai.use(require('chai-string'));
-let previewHandler;
-before(() => {
-    previewHandler = new markdown_preview_handler_1.MarkdownPreviewHandler();
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    previewHandler.linkNormalizer = {
-        normalizeLink: (documentUri, link) => 'endpoint/' + documentUri.parent.resolve(link).path.toString().substring(1)
-    };
-});
-describe('markdown-preview-handler', () => {
-    before(() => {
-        disableJSDOM = (0, jsdom_1.enableJSDOM)();
-    });
-    after(() => {
-        disableJSDOM();
-    });
-    it('renders html with line information', async () => {
-        await assertRenderedContent(exampleMarkdown1, exampleHtml1);
-    });
-    it('renders images', async () => {
-        await assertRenderedContent(exampleMarkdown2, exampleHtml2);
-    });
-    it('renders HTML image as block', async () => {
-        await assertRenderedContent(exampleMarkdown3, exampleHtml3);
-    });
-    it('renders HTML images inlined', async () => {
-        await assertRenderedContent(exampleMarkdown4, exampleHtml4);
-    });
-    it('renders multiple HTML images in a html block', async () => {
-        await assertRenderedContent(exampleMarkdown5, exampleHtml5);
-    });
-    it('finds element for source line', () => {
-        document.body.innerHTML = exampleHtml1;
-        const element = previewHandler.findElementForSourceLine(document.body, 4);
-        (0, chai_1.expect)(element).not.to.be.equal(undefined);
-        (0, chai_1.expect)(element.tagName).to.be.equal('H2');
-        (0, chai_1.expect)(element.textContent).to.be.equal('License');
-    });
-    it('finds previous element for empty source line', () => {
-        document.body.innerHTML = exampleHtml1;
-        const element = previewHandler.findElementForSourceLine(document.body, 3);
-        (0, chai_1.expect)(element).not.to.be.equal(undefined);
-        (0, chai_1.expect)(element.tagName).to.be.equal('P');
-        (0, chai_1.expect)(element.textContent).that.startWith('Shows a preview of supported resources.');
-    });
-    it('finds source line for offset in html', () => {
-        mockOffsetProperties();
-        document.body.innerHTML = exampleHtml1;
-        for (const expectedLine of [0, 1, 4, 5]) {
-            const line = previewHandler.getSourceLineForOffset(document.body, offsetForLine(expectedLine));
-            (0, chai_1.expect)(line).to.be.equal(expectedLine);
-        }
-    });
-    it('interpolates source lines for offset in html', () => {
-        mockOffsetProperties();
-        document.body.innerHTML = exampleHtml1;
-        const expectedLines = [1, 2, 3, 4];
-        const offsets = expectedLines.map(l => offsetForLine(l));
-        for (let i = 0; i < expectedLines.length; i++) {
-            const expectedLine = expectedLines[i];
-            const offset = offsets[i];
-            const line = previewHandler.getSourceLineForOffset(document.body, offset);
-            (0, chai_1.expect)(line).to.be.equal(expectedLine);
-        }
-    });
-    it('can handle \'.md\' files', () => {
-        (0, chai_1.expect)(previewHandler.canHandle(new uri_1.default('a.md'))).greaterThan(0);
-    });
-    it('can handle \'.markdown\' files', () => {
-        (0, chai_1.expect)(previewHandler.canHandle(new uri_1.default('a.markdown'))).greaterThan(0);
-    });
-});
-async function assertRenderedContent(source, expectation) {
-    const contentElement = previewHandler.renderContent({ content: source, originUri: new uri_1.default('file:///workspace/DEMO.md') });
-    (0, chai_1.expect)(contentElement.innerHTML).equals(expectation);
-}
-const exampleMarkdown1 = //
- `# Theia - Preview Extension
-Shows a preview of supported resources.
-See [here](https://github.com/eclipse-theia/theia).
-
-## License
-[Apache-2.0](https://github.com/eclipse-theia/theia/blob/master/LICENSE)
-`;
-const exampleHtml1 = //
- `<h1 data-line="0" class="line" id="theia---preview-extension">Theia - Preview Extension</h1>
-<p data-line="1" class="line">Shows a preview of supported resources.
-See <a href="https://github.com/eclipse-theia/theia">here</a>.</p>
-<h2 data-line="4" class="line" id="license">License</h2>
-<p data-line="5" class="line"><a href="https://github.com/eclipse-theia/theia/blob/master/LICENSE">Apache-2.0</a></p>
-`;
-const exampleMarkdown2 = //
- `# Heading
-![alternativetext](subfolder/image.png)
-`;
-const exampleHtml2 = //
- `<h1 data-line="0" class="line" id="heading">Heading</h1>
-<p data-line="1" class="line"><img alt="alternativetext" src="endpoint/workspace/subfolder/image.png"></p>
-`;
-const exampleMarkdown3 = //
- `# Block HTML Image
-<img src="subfolder/image1.png" alt="tada"/>
-
-# Block HTML Image
- <img src="subfolder/image3.png" alt="tada"/>
-`;
-const exampleHtml3 = //
- `<h1 data-line="0" class="line" id="block-html-image">Block HTML Image</h1>
-<img alt="tada" src="endpoint/workspace/subfolder/image1.png">
-<h1 data-line="3" class="line" id="block-html-image-2">Block HTML Image</h1>
-<img alt="tada" src="endpoint/workspace/subfolder/image3.png">
-`;
-const exampleMarkdown4 = //
- `# Inlined HTML Image
-text in paragraph <img src="subfolder/image2.png" alt="tada"/>
-`;
-const exampleHtml4 = //
- `<h1 data-line="0" class="line" id="inlined-html-image">Inlined HTML Image</h1>
-<p data-line="1" class="line">text in paragraph <img alt="tada" src="endpoint/workspace/subfolder/image2.png"></p>
-`;
-const exampleMarkdown5 = //
- `# Multiple HTML Images nested in blocks
-word  <p>
-<img src="subfolder/image2.png" alt="tada"/>
-</p>
-
-<p>
-<img src="subfolder/image2.png" alt="tada"/>
-</p>
-`;
-const exampleHtml5 = //
- `<h1 data-line="0" class="line" id="multiple-html-images-nested-in-blocks">Multiple HTML Images nested in blocks</h1>
-<p data-line="1" class="line">word  </p><p>
-<img alt="tada" src="endpoint/workspace/subfolder/image2.png"></p>
-<p></p>
-<p>
-<img alt="tada" src="endpoint/workspace/subfolder/image2.png">
-</p>
-`;
-/**
- * `offsetTop` of elements to be `sourceLine` number times `20`.
- */
-function mockOffsetProperties() {
-    Object.defineProperties(HTMLElement.prototype, {
-        offsetLeft: {
-            get: () => 0
-        },
-        offsetTop: {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            get: function () {
-                const element = this;
-                const line = Number.parseInt(element.getAttribute('data-line') || '0');
-                return offsetForLine(line);
-            }
-        },
-        offsetHeight: {
-            get: () => 0
-        },
-        offsetWidth: {
-            get: () => 0
-        }
-    });
-}
-function offsetForLine(line) {
-    return line * 20;
-}
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2018 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-unsanitized/property */
+const jsdom_1 = require("@theia/core/lib/browser/test/jsdom");
+let disableJSDOM = (0, jsdom_1.enableJSDOM)();
+const frontend_application_config_provider_1 = require("@theia/core/lib/browser/frontend-application-config-provider");
+frontend_application_config_provider_1.FrontendApplicationConfigProvider.set({});
+const chai = require("chai");
+const chai_1 = require("chai");
+const uri_1 = require("@theia/core/lib/common/uri");
+const markdown_preview_handler_1 = require("./markdown-preview-handler");
+disableJSDOM();
+chai.use(require('chai-string'));
+let previewHandler;
+before(() => {
+    previewHandler = new markdown_preview_handler_1.MarkdownPreviewHandler();
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    previewHandler.linkNormalizer = {
+        normalizeLink: (documentUri, link) => 'endpoint/' + documentUri.parent.resolve(link).path.toString().substring(1)
+    };
+});
+describe('markdown-preview-handler', () => {
+    before(() => {
+        disableJSDOM = (0, jsdom_1.enableJSDOM)();
+    });
+    after(() => {
+        disableJSDOM();
+    });
+    it('renders html with line information', async () => {
+        await assertRenderedContent(exampleMarkdown1, exampleHtml1);
+    });
+    it('renders images', async () => {
+        await assertRenderedContent(exampleMarkdown2, exampleHtml2);
+    });
+    it('renders HTML image as block', async () => {
+        await assertRenderedContent(exampleMarkdown3, exampleHtml3);
+    });
+    it('renders HTML images inlined', async () => {
+        await assertRenderedContent(exampleMarkdown4, exampleHtml4);
+    });
+    it('renders multiple HTML images in a html block', async () => {
+        await assertRenderedContent(exampleMarkdown5, exampleHtml5);
+    });
+    it('finds element for source line', () => {
+        document.body.innerHTML = exampleHtml1;
+        const element = previewHandler.findElementForSourceLine(document.body, 4);
+        (0, chai_1.expect)(element).not.to.be.equal(undefined);
+        (0, chai_1.expect)(element.tagName).to.be.equal('H2');
+        (0, chai_1.expect)(element.textContent).to.be.equal('License');
+    });
+    it('finds previous element for empty source line', () => {
+        document.body.innerHTML = exampleHtml1;
+        const element = previewHandler.findElementForSourceLine(document.body, 3);
+        (0, chai_1.expect)(element).not.to.be.equal(undefined);
+        (0, chai_1.expect)(element.tagName).to.be.equal('P');
+        (0, chai_1.expect)(element.textContent).that.startWith('Shows a preview of supported resources.');
+    });
+    it('finds source line for offset in html', () => {
+        mockOffsetProperties();
+        document.body.innerHTML = exampleHtml1;
+        for (const expectedLine of [0, 1, 4, 5]) {
+            const line = previewHandler.getSourceLineForOffset(document.body, offsetForLine(expectedLine));
+            (0, chai_1.expect)(line).to.be.equal(expectedLine);
+        }
+    });
+    it('interpolates source lines for offset in html', () => {
+        mockOffsetProperties();
+        document.body.innerHTML = exampleHtml1;
+        const expectedLines = [1, 2, 3, 4];
+        const offsets = expectedLines.map(l => offsetForLine(l));
+        for (let i = 0; i < expectedLines.length; i++) {
+            const expectedLine = expectedLines[i];
+            const offset = offsets[i];
+            const line = previewHandler.getSourceLineForOffset(document.body, offset);
+            (0, chai_1.expect)(line).to.be.equal(expectedLine);
+        }
+    });
+    it('can handle \'.md\' files', () => {
+        (0, chai_1.expect)(previewHandler.canHandle(new uri_1.default('a.md'))).greaterThan(0);
+    });
+    it('can handle \'.markdown\' files', () => {
+        (0, chai_1.expect)(previewHandler.canHandle(new uri_1.default('a.markdown'))).greaterThan(0);
+    });
+});
+async function assertRenderedContent(source, expectation) {
+    const contentElement = previewHandler.renderContent({ content: source, originUri: new uri_1.default('file:///workspace/DEMO.md') });
+    (0, chai_1.expect)(contentElement.innerHTML).equals(expectation);
+}
+const exampleMarkdown1 = //
+ `# Theia - Preview Extension
+Shows a preview of supported resources.
+See [here](https://github.com/eclipse-theia/theia).
+
+## License
+[Apache-2.0](https://github.com/eclipse-theia/theia/blob/master/LICENSE)
+`;
+const exampleHtml1 = //
+ `<h1 data-line="0" class="line" id="theia---preview-extension">Theia - Preview Extension</h1>
+<p data-line="1" class="line">Shows a preview of supported resources.
+See <a href="https://github.com/eclipse-theia/theia">here</a>.</p>
+<h2 data-line="4" class="line" id="license">License</h2>
+<p data-line="5" class="line"><a href="https://github.com/eclipse-theia/theia/blob/master/LICENSE">Apache-2.0</a></p>
+`;
+const exampleMarkdown2 = //
+ `# Heading
+![alternativetext](subfolder/image.png)
+`;
+const exampleHtml2 = //
+ `<h1 data-line="0" class="line" id="heading">Heading</h1>
+<p data-line="1" class="line"><img alt="alternativetext" src="endpoint/workspace/subfolder/image.png"></p>
+`;
+const exampleMarkdown3 = //
+ `# Block HTML Image
+<img src="subfolder/image1.png" alt="tada"/>
+
+# Block HTML Image
+ <img src="subfolder/image3.png" alt="tada"/>
+`;
+const exampleHtml3 = //
+ `<h1 data-line="0" class="line" id="block-html-image">Block HTML Image</h1>
+<img alt="tada" src="endpoint/workspace/subfolder/image1.png">
+<h1 data-line="3" class="line" id="block-html-image-2">Block HTML Image</h1>
+<img alt="tada" src="endpoint/workspace/subfolder/image3.png">
+`;
+const exampleMarkdown4 = //
+ `# Inlined HTML Image
+text in paragraph <img src="subfolder/image2.png" alt="tada"/>
+`;
+const exampleHtml4 = //
+ `<h1 data-line="0" class="line" id="inlined-html-image">Inlined HTML Image</h1>
+<p data-line="1" class="line">text in paragraph <img alt="tada" src="endpoint/workspace/subfolder/image2.png"></p>
+`;
+const exampleMarkdown5 = //
+ `# Multiple HTML Images nested in blocks
+word  <p>
+<img src="subfolder/image2.png" alt="tada"/>
+</p>
+
+<p>
+<img src="subfolder/image2.png" alt="tada"/>
+</p>
+`;
+const exampleHtml5 = //
+ `<h1 data-line="0" class="line" id="multiple-html-images-nested-in-blocks">Multiple HTML Images nested in blocks</h1>
+<p data-line="1" class="line">word  </p><p>
+<img alt="tada" src="endpoint/workspace/subfolder/image2.png"></p>
+<p></p>
+<p>
+<img alt="tada" src="endpoint/workspace/subfolder/image2.png">
+</p>
+`;
+/**
+ * `offsetTop` of elements to be `sourceLine` number times `20`.
+ */
+function mockOffsetProperties() {
+    Object.defineProperties(HTMLElement.prototype, {
+        offsetLeft: {
+            get: () => 0
+        },
+        offsetTop: {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            get: function () {
+                const element = this;
+                const line = Number.parseInt(element.getAttribute('data-line') || '0');
+                return offsetForLine(line);
+            }
+        },
+        offsetHeight: {
+            get: () => 0
+        },
+        offsetWidth: {
+            get: () => 0
+        }
+    });
+}
+function offsetForLine(line) {
+    return line * 20;
+}
 //# sourceMappingURL=markdown-preview-handler.spec.js.map

package/lib/browser/preview-contribution.d.ts

@@ -1,51 +1,51 @@
-import { Widget } from '@theia/core/shared/@phosphor/widgets';
-import { FrontendApplicationContribution, WidgetOpenerOptions, NavigatableWidgetOpenHandler } from '@theia/core/lib/browser';
-import { EditorManager, TextEditor, EditorWidget } from '@theia/editor/lib/browser';
-import { CommandContribution, CommandRegistry, Command, MenuContribution, MenuModelRegistry, Disposable } from '@theia/core/lib/common';
-import { TabBarToolbarContribution, TabBarToolbarRegistry } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
-import URI from '@theia/core/lib/common/uri';
-import { Position } from '@theia/core/shared/vscode-languageserver-protocol';
-import { PreviewWidget } from './preview-widget';
-import { PreviewHandlerProvider } from './preview-handler';
-import { PreviewPreferences } from './preview-preferences';
-export declare namespace PreviewCommands {
-    /**
-     * No `label`. Otherwise, it would show up in the `Command Palette` and we already have the `Preview` open handler.
-     * See in (`WorkspaceCommandContribution`)[https://bit.ly/2DncrSD].
-     */
-    const OPEN: Command;
-    const OPEN_SOURCE: Command;
-}
-export interface PreviewOpenerOptions extends WidgetOpenerOptions {
-    originUri?: URI;
-}
-export declare class PreviewContribution extends NavigatableWidgetOpenHandler<PreviewWidget> implements CommandContribution, MenuContribution, FrontendApplicationContribution, TabBarToolbarContribution {
-    readonly id = "code-editor-preview";
-    readonly label: string;
-    protected readonly editorManager: EditorManager;
-    protected readonly previewHandlerProvider: PreviewHandlerProvider;
-    protected readonly preferences: PreviewPreferences;
-    protected readonly synchronizedUris: Set<string>;
-    protected scrollSyncLockOn: 'preview' | 'editor' | undefined;
-    protected scrollSyncLockTimeout: number | undefined;
-    onStart(): void;
-    protected lockScrollSync(on: 'preview' | 'editor', delay?: number): Promise<void>;
-    protected registerEditorAndPreviewSync(source: PreviewWidget | EditorWidget): Promise<void>;
-    protected revealSourceLineInPreview(previewWidget: PreviewWidget, position: Position): void;
-    protected synchronizeScrollToEditor(previewWidget: PreviewWidget, editor: TextEditor): Disposable;
-    protected registerOpenOnDoubleClick(ref: PreviewWidget): void;
-    canHandle(uri: URI): number;
-    protected get openByDefault(): boolean;
-    open(uri: URI, options?: PreviewOpenerOptions): Promise<PreviewWidget>;
-    protected serializeUri(uri: URI): string;
-    protected resolveOpenerOptions(options?: PreviewOpenerOptions): Promise<PreviewOpenerOptions>;
-    registerCommands(registry: CommandRegistry): void;
-    registerMenus(menus: MenuModelRegistry): void;
-    registerToolbarItems(registry: TabBarToolbarRegistry): void;
-    protected canHandleEditorUri(widget?: Widget): boolean;
-    protected getCurrentEditorUri(widget?: Widget): URI | undefined;
-    protected getCurrentEditor(widget?: Widget): EditorWidget | undefined;
-    protected openForEditor(widget?: Widget): Promise<void>;
-    protected openSource(ref: PreviewWidget): Promise<EditorWidget>;
-}
+import { Widget } from '@theia/core/shared/@phosphor/widgets';
+import { FrontendApplicationContribution, WidgetOpenerOptions, NavigatableWidgetOpenHandler } from '@theia/core/lib/browser';
+import { EditorManager, TextEditor, EditorWidget } from '@theia/editor/lib/browser';
+import { CommandContribution, CommandRegistry, Command, MenuContribution, MenuModelRegistry, Disposable } from '@theia/core/lib/common';
+import { TabBarToolbarContribution, TabBarToolbarRegistry } from '@theia/core/lib/browser/shell/tab-bar-toolbar';
+import URI from '@theia/core/lib/common/uri';
+import { Position } from '@theia/core/shared/vscode-languageserver-protocol';
+import { PreviewWidget } from './preview-widget';
+import { PreviewHandlerProvider } from './preview-handler';
+import { PreviewPreferences } from './preview-preferences';
+export declare namespace PreviewCommands {
+    /**
+     * No `label`. Otherwise, it would show up in the `Command Palette` and we already have the `Preview` open handler.
+     * See in (`WorkspaceCommandContribution`)[https://bit.ly/2DncrSD].
+     */
+    const OPEN: Command;
+    const OPEN_SOURCE: Command;
+}
+export interface PreviewOpenerOptions extends WidgetOpenerOptions {
+    originUri?: URI;
+}
+export declare class PreviewContribution extends NavigatableWidgetOpenHandler<PreviewWidget> implements CommandContribution, MenuContribution, FrontendApplicationContribution, TabBarToolbarContribution {
+    readonly id = "code-editor-preview";
+    readonly label: string;
+    protected readonly editorManager: EditorManager;
+    protected readonly previewHandlerProvider: PreviewHandlerProvider;
+    protected readonly preferences: PreviewPreferences;
+    protected readonly synchronizedUris: Set<string>;
+    protected scrollSyncLockOn: 'preview' | 'editor' | undefined;
+    protected scrollSyncLockTimeout: number | undefined;
+    onStart(): void;
+    protected lockScrollSync(on: 'preview' | 'editor', delay?: number): Promise<void>;
+    protected registerEditorAndPreviewSync(source: PreviewWidget | EditorWidget): Promise<void>;
+    protected revealSourceLineInPreview(previewWidget: PreviewWidget, position: Position): void;
+    protected synchronizeScrollToEditor(previewWidget: PreviewWidget, editor: TextEditor): Disposable;
+    protected registerOpenOnDoubleClick(ref: PreviewWidget): void;
+    canHandle(uri: URI): number;
+    protected get openByDefault(): boolean;
+    open(uri: URI, options?: PreviewOpenerOptions): Promise<PreviewWidget>;
+    protected serializeUri(uri: URI): string;
+    protected resolveOpenerOptions(options?: PreviewOpenerOptions): Promise<PreviewOpenerOptions>;
+    registerCommands(registry: CommandRegistry): void;
+    registerMenus(menus: MenuModelRegistry): void;
+    registerToolbarItems(registry: TabBarToolbarRegistry): void;
+    protected canHandleEditorUri(widget?: Widget): boolean;
+    protected getCurrentEditorUri(widget?: Widget): URI | undefined;
+    protected getCurrentEditor(widget?: Widget): EditorWidget | undefined;
+    protected openForEditor(widget?: Widget): Promise<void>;
+    protected openSource(ref: PreviewWidget): Promise<EditorWidget>;
+}
 //# sourceMappingURL=preview-contribution.d.ts.map