@theia/core 1.53.0-next.55 → 1.53.0-next.64

package/src/browser/label-parser.spec.ts

@@ -1,165 +1,165 @@
-// *****************************************************************************
-// Copyright (C) 2017 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
-// *****************************************************************************
-import { LabelParser, LabelPart, LabelIcon } from './label-parser';
-import { CommandService } from './../common';
-import { Container } from 'inversify';
-import { expect } from 'chai';
-
-let statusBarEntryUtility: LabelParser;
-
-before(() => {
-    const testContainer = new Container();
-    testContainer.bind(LabelParser).toSelf().inSingletonScope();
-    testContainer.bind(CommandService).toDynamicValue(ctx => ({
-        executeCommand<T>(): Promise<T | undefined> {
-            return Promise.resolve(undefined);
-        }
-    })).inSingletonScope();
-
-    statusBarEntryUtility = testContainer.get(LabelParser);
-});
-
-describe('StatusBarEntryUtility', () => {
-
-    let text: string;
-
-    it('should create an empty array.', () => {
-        text = '';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(0);
-    });
-
-    it('should create a string array with one entry.', () => {
-        text = 'foo bar';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(1);
-        expect(iconArr[0]).equals('foo bar');
-    });
-
-    it('should create a string array with one entry - text contains an $.', () => {
-        text = 'foo $ bar';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(1);
-        expect(iconArr[0]).equals('foo $ bar');
-    });
-
-    it('should create a string array with one entry - text contains an $( which does not close.', () => {
-        text = 'foo $(bar';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(1);
-        expect(iconArr[0]).equals('foo $(bar');
-    });
-
-    it('should create a string array with two entries. Second is a simple StatusBarIcon.', () => {
-        text = 'foo $(bar)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(2);
-        expect(iconArr[0]).equals('foo ');
-        expect(iconArr[1]).has.property('name');
-        expect(iconArr[1]).has.property('animation');
-        expect((iconArr[1] as LabelIcon).name).equals('bar');
-        expect((iconArr[1] as LabelIcon).animation).to.be.undefined;
-    });
-
-    it('should create a string array with two entries. Second is a StatusBarIcon with an animation.', () => {
-        text = 'foo $(bar~baz)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(2);
-        expect(iconArr[0]).equals('foo ');
-        expect(iconArr[1]).has.property('name');
-        expect(iconArr[1]).has.property('animation');
-        expect((iconArr[1] as LabelIcon).name).equals('bar');
-        expect((iconArr[1] as LabelIcon).animation).equals('baz');
-    });
-
-    it("should create string array of 'foo $(icon1) bar $(icon2) baz $(icon3)'", () => {
-        text = 'foo $(icon1) bar $(icon2) baz $(icon3)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(6);
-        expect(iconArr[0]).equals('foo ');
-        expect(iconArr[2]).equals(' bar ');
-    });
-
-    it("should create string array of '$(icon1) foo bar $(icon2) baz $(icon3)'", () => {
-        text = '$(icon1) foo bar $(icon2~ani1) baz $(icon3)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(5);
-        expect(iconArr[0]).has.property('name');
-        expect((iconArr[0] as LabelIcon).name).equals('icon1');
-        expect(iconArr[2]).has.property('animation');
-        expect((iconArr[2] as LabelIcon).animation).equals('ani1');
-    });
-
-    it("should create an array with one element of '$(icon1)'", () => {
-        text = '$(icon1)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(1);
-        expect(iconArr[0]).has.property('name');
-        expect((iconArr[0] as LabelIcon).name).equals('icon1');
-    });
-
-    it("should create an array of '$(icon1)$(icon2) (icon3)'", () => {
-        text = '$(icon1)$(icon2) $(icon3)';
-        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
-        expect(iconArr).to.have.lengthOf(4);
-        expect(iconArr[0]).has.property('name');
-        expect((iconArr[0] as LabelIcon).name).equals('icon1');
-        expect(iconArr[1]).has.property('name');
-        expect((iconArr[1] as LabelIcon).name).equals('icon2');
-        expect(iconArr[2]).equals(' ');
-        expect(iconArr[3]).has.property('name');
-        expect((iconArr[3] as LabelIcon).name).equals('icon3');
-    });
-
-    it('should strip nothing from an empty string', () => {
-        text = '';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal(text);
-    });
-
-    it('should strip nothing from an string containing no icons', () => {
-        // Deliberate double space to verify not concatenating these words
-        text = 'foo  bar';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal(text);
-    });
-
-    it("should strip a medial '$(icon)' from a string", () => {
-        text = 'foo $(icon) bar';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal('foo bar');
-    });
-
-    it("should strip a terminal '$(icon)' from a string", () => {
-        // Deliberate double space to verify not concatenating these words
-        text = 'foo  bar $(icon)';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal('foo  bar');
-    });
-
-    it("should strip an initial '$(icon)' from a string", () => {
-        // Deliberate double space to verify not concatenating these words
-        text = '$(icon) foo  bar';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal('foo  bar');
-    });
-
-    it("should strip multiple '$(icon)' specifiers from a string", () => {
-        text = '$(icon1) foo $(icon2)$(icon3)  bar $(icon4) $(icon5)';
-        const stripped: string = statusBarEntryUtility.stripIcons(text);
-        expect(stripped).to.be.equal('foo bar');
-    });
-});
+// *****************************************************************************
+// Copyright (C) 2017 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
+// *****************************************************************************
+import { LabelParser, LabelPart, LabelIcon } from './label-parser';
+import { CommandService } from './../common';
+import { Container } from 'inversify';
+import { expect } from 'chai';
+
+let statusBarEntryUtility: LabelParser;
+
+before(() => {
+    const testContainer = new Container();
+    testContainer.bind(LabelParser).toSelf().inSingletonScope();
+    testContainer.bind(CommandService).toDynamicValue(ctx => ({
+        executeCommand<T>(): Promise<T | undefined> {
+            return Promise.resolve(undefined);
+        }
+    })).inSingletonScope();
+
+    statusBarEntryUtility = testContainer.get(LabelParser);
+});
+
+describe('StatusBarEntryUtility', () => {
+
+    let text: string;
+
+    it('should create an empty array.', () => {
+        text = '';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(0);
+    });
+
+    it('should create a string array with one entry.', () => {
+        text = 'foo bar';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(1);
+        expect(iconArr[0]).equals('foo bar');
+    });
+
+    it('should create a string array with one entry - text contains an $.', () => {
+        text = 'foo $ bar';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(1);
+        expect(iconArr[0]).equals('foo $ bar');
+    });
+
+    it('should create a string array with one entry - text contains an $( which does not close.', () => {
+        text = 'foo $(bar';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(1);
+        expect(iconArr[0]).equals('foo $(bar');
+    });
+
+    it('should create a string array with two entries. Second is a simple StatusBarIcon.', () => {
+        text = 'foo $(bar)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(2);
+        expect(iconArr[0]).equals('foo ');
+        expect(iconArr[1]).has.property('name');
+        expect(iconArr[1]).has.property('animation');
+        expect((iconArr[1] as LabelIcon).name).equals('bar');
+        expect((iconArr[1] as LabelIcon).animation).to.be.undefined;
+    });
+
+    it('should create a string array with two entries. Second is a StatusBarIcon with an animation.', () => {
+        text = 'foo $(bar~baz)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(2);
+        expect(iconArr[0]).equals('foo ');
+        expect(iconArr[1]).has.property('name');
+        expect(iconArr[1]).has.property('animation');
+        expect((iconArr[1] as LabelIcon).name).equals('bar');
+        expect((iconArr[1] as LabelIcon).animation).equals('baz');
+    });
+
+    it("should create string array of 'foo $(icon1) bar $(icon2) baz $(icon3)'", () => {
+        text = 'foo $(icon1) bar $(icon2) baz $(icon3)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(6);
+        expect(iconArr[0]).equals('foo ');
+        expect(iconArr[2]).equals(' bar ');
+    });
+
+    it("should create string array of '$(icon1) foo bar $(icon2) baz $(icon3)'", () => {
+        text = '$(icon1) foo bar $(icon2~ani1) baz $(icon3)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(5);
+        expect(iconArr[0]).has.property('name');
+        expect((iconArr[0] as LabelIcon).name).equals('icon1');
+        expect(iconArr[2]).has.property('animation');
+        expect((iconArr[2] as LabelIcon).animation).equals('ani1');
+    });
+
+    it("should create an array with one element of '$(icon1)'", () => {
+        text = '$(icon1)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(1);
+        expect(iconArr[0]).has.property('name');
+        expect((iconArr[0] as LabelIcon).name).equals('icon1');
+    });
+
+    it("should create an array of '$(icon1)$(icon2) (icon3)'", () => {
+        text = '$(icon1)$(icon2) $(icon3)';
+        const iconArr: LabelPart[] = statusBarEntryUtility.parse(text);
+        expect(iconArr).to.have.lengthOf(4);
+        expect(iconArr[0]).has.property('name');
+        expect((iconArr[0] as LabelIcon).name).equals('icon1');
+        expect(iconArr[1]).has.property('name');
+        expect((iconArr[1] as LabelIcon).name).equals('icon2');
+        expect(iconArr[2]).equals(' ');
+        expect(iconArr[3]).has.property('name');
+        expect((iconArr[3] as LabelIcon).name).equals('icon3');
+    });
+
+    it('should strip nothing from an empty string', () => {
+        text = '';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal(text);
+    });
+
+    it('should strip nothing from an string containing no icons', () => {
+        // Deliberate double space to verify not concatenating these words
+        text = 'foo  bar';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal(text);
+    });
+
+    it("should strip a medial '$(icon)' from a string", () => {
+        text = 'foo $(icon) bar';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal('foo bar');
+    });
+
+    it("should strip a terminal '$(icon)' from a string", () => {
+        // Deliberate double space to verify not concatenating these words
+        text = 'foo  bar $(icon)';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal('foo  bar');
+    });
+
+    it("should strip an initial '$(icon)' from a string", () => {
+        // Deliberate double space to verify not concatenating these words
+        text = '$(icon) foo  bar';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal('foo  bar');
+    });
+
+    it("should strip multiple '$(icon)' specifiers from a string", () => {
+        text = '$(icon1) foo $(icon2)$(icon3)  bar $(icon4) $(icon5)';
+        const stripped: string = statusBarEntryUtility.stripIcons(text);
+        expect(stripped).to.be.equal('foo bar');
+    });
+});

package/src/browser/label-parser.ts

@@ -1,108 +1,108 @@
-// *****************************************************************************
-// Copyright (C) 2017 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
-// *****************************************************************************
-import { injectable } from 'inversify';
-import { isObject, isString } from '../common';
-
-export interface LabelIcon {
-    name: string;
-    animation?: string;
-}
-
-export namespace LabelIcon {
-    export function is(val: unknown): val is LabelIcon {
-        return isObject<LabelIcon>(val) && isString(val.name);
-    }
-}
-
-export type LabelPart = string | LabelIcon;
-
-@injectable()
-export class LabelParser {
-
-    /**
-     * Returns an array with parts of the given text.
-     * These parts are of type LabelPart which can be either a string or a LabelIcon.
-     * For splitting up the giving text the parser follows this rule:
-     * The text gets parsed for the following pattern: $(iconName~iconAnimation).
-     * If the parser finds such pattern a new LabelIcon object
-     * { name: 'iconName', animation: 'iconAnimation'} is added to the returned array.
-     * iconName can be for instance the name of an icon of e.g. FontAwesome and the (optional) iconAnimation
-     * the name of an animation class which must be supported by the particular icon toolkit.
-     *
-     * Every string before, between or after such icon patterns gets also added to the array
-     * before, between or after the related LabelIcon.
-     *
-     * @param text - the label text to parse
-     */
-    parse(text: string): LabelPart[] {
-        const parserArray: LabelPart[] = [];
-        let arrPointer = 0;
-        let potentialIcon = '';
-
-        for (let idx = 0; idx < text.length; idx++) {
-            const char = text.charAt(idx);
-            parserArray[arrPointer] = parserArray[arrPointer] || '';
-            if (potentialIcon === '') {
-                if (char === '$') {
-                    potentialIcon += char;
-                } else {
-                    parserArray[arrPointer] += char;
-                }
-            } else if (potentialIcon === '$') {
-                if (char === '(') {
-                    potentialIcon += char;
-                } else {
-                    parserArray[arrPointer] += potentialIcon + char;
-                    potentialIcon = '';
-                }
-            } else {
-                if (char === ')') {
-                    const iconClassArr = potentialIcon.substring(2, potentialIcon.length).split('~');
-                    if (parserArray[arrPointer] !== '') {
-                        arrPointer++;
-                    }
-                    parserArray[arrPointer] = { name: iconClassArr[0], animation: iconClassArr[1] };
-                    arrPointer++;
-                    potentialIcon = '';
-                } else {
-                    potentialIcon += char;
-                }
-            }
-        }
-
-        if (potentialIcon !== '') {
-            parserArray[arrPointer] += potentialIcon;
-        }
-
-        return parserArray;
-    }
-
-    /**
-     * Strips icon specifiers from the given `text`, leaving only a
-     * space-separated concatenation of the non-icon segments.
-     *
-     * @param text text to be stripped of icon specifiers
-     * @returns the `text` with icon specifiers stripped out
-     */
-    stripIcons(text: string): string {
-        return this.parse(text)
-            .filter(item => !LabelIcon.is(item))
-            .map(s => (s as string).trim())
-            .filter(s => s.length)
-            .join(' ');
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2017 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
+// *****************************************************************************
+import { injectable } from 'inversify';
+import { isObject, isString } from '../common';
+
+export interface LabelIcon {
+    name: string;
+    animation?: string;
+}
+
+export namespace LabelIcon {
+    export function is(val: unknown): val is LabelIcon {
+        return isObject<LabelIcon>(val) && isString(val.name);
+    }
+}
+
+export type LabelPart = string | LabelIcon;
+
+@injectable()
+export class LabelParser {
+
+    /**
+     * Returns an array with parts of the given text.
+     * These parts are of type LabelPart which can be either a string or a LabelIcon.
+     * For splitting up the giving text the parser follows this rule:
+     * The text gets parsed for the following pattern: $(iconName~iconAnimation).
+     * If the parser finds such pattern a new LabelIcon object
+     * { name: 'iconName', animation: 'iconAnimation'} is added to the returned array.
+     * iconName can be for instance the name of an icon of e.g. FontAwesome and the (optional) iconAnimation
+     * the name of an animation class which must be supported by the particular icon toolkit.
+     *
+     * Every string before, between or after such icon patterns gets also added to the array
+     * before, between or after the related LabelIcon.
+     *
+     * @param text - the label text to parse
+     */
+    parse(text: string): LabelPart[] {
+        const parserArray: LabelPart[] = [];
+        let arrPointer = 0;
+        let potentialIcon = '';
+
+        for (let idx = 0; idx < text.length; idx++) {
+            const char = text.charAt(idx);
+            parserArray[arrPointer] = parserArray[arrPointer] || '';
+            if (potentialIcon === '') {
+                if (char === '$') {
+                    potentialIcon += char;
+                } else {
+                    parserArray[arrPointer] += char;
+                }
+            } else if (potentialIcon === '$') {
+                if (char === '(') {
+                    potentialIcon += char;
+                } else {
+                    parserArray[arrPointer] += potentialIcon + char;
+                    potentialIcon = '';
+                }
+            } else {
+                if (char === ')') {
+                    const iconClassArr = potentialIcon.substring(2, potentialIcon.length).split('~');
+                    if (parserArray[arrPointer] !== '') {
+                        arrPointer++;
+                    }
+                    parserArray[arrPointer] = { name: iconClassArr[0], animation: iconClassArr[1] };
+                    arrPointer++;
+                    potentialIcon = '';
+                } else {
+                    potentialIcon += char;
+                }
+            }
+        }
+
+        if (potentialIcon !== '') {
+            parserArray[arrPointer] += potentialIcon;
+        }
+
+        return parserArray;
+    }
+
+    /**
+     * Strips icon specifiers from the given `text`, leaving only a
+     * space-separated concatenation of the non-icon segments.
+     *
+     * @param text text to be stripped of icon specifiers
+     * @returns the `text` with icon specifiers stripped out
+     */
+    stripIcons(text: string): string {
+        return this.parse(text)
+            .filter(item => !LabelIcon.is(item))
+            .map(s => (s as string).trim())
+            .filter(s => s.length)
+            .join(' ');
+    }
+
+}