Skip to content

Commit

Permalink
[output] add severity/color to appendLine method
Browse files Browse the repository at this point in the history
Signed-off-by: Amiram Wingarten <amiram.wingarten@sap.com>
  • Loading branch information
amiramw committed Apr 20, 2020
1 parent a187f01 commit 368d109
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 13 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## v1.1.0

- [task] fixed presentation.reveal & focus for detected tasks [#7548](https://github.com/eclipse-theia/theia/pull/7548)
- [output] added optional argument `severity` to `OutputChannel.appendLine` method for coloring.

Breaking changes:

Expand Down
3 changes: 3 additions & 0 deletions examples/api-samples/compile.tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
"references": [
{
"path": "../../packages/core/compile.tsconfig.json"
},
{
"path": "../../packages/output/compile.tsconfig.json"
}
]
}
3 changes: 2 additions & 1 deletion examples/api-samples/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"version": "1.0.0",
"description": "Theia - Example code to demonstrate Theia API",
"dependencies": {
"@theia/core": "^1.0.0"
"@theia/core": "^1.0.0",
"@theia/output": "^1.0.0"
},
"theiaExtensions": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
import { ContainerModule } from 'inversify';
import { bindDynamicLabelProvider } from './label/sample-dynamic-label-provider-command-contribution';
import { bindSampleUnclosableView } from './view/sample-unclosable-view-contribution';
import { bindSampleOutputChannelWithSeverity } from './output/sample-output-channel-with-severity';

export default new ContainerModule(bind => {
bindDynamicLabelProvider(bind);
bindSampleUnclosableView(bind);
bindSampleOutputChannelWithSeverity(bind);
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/********************************************************************************
* Copyright (c) 2020 SAP SE or an SAP affiliate company 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 WITH Classpath-exception-2.0
********************************************************************************/
import { FrontendApplicationContribution } from '@theia/core/lib/browser';
import { inject, injectable, interfaces } from 'inversify';
import { OutputChannelManager, OutputChannelSeverity } from '@theia/output/lib/common/output-channel';

@injectable()
export class SampleOutputChannelWithSeverity
implements FrontendApplicationContribution {
@inject(OutputChannelManager)
protected readonly outputChannelManager: OutputChannelManager;
public onStart(): void {
const channel = this.outputChannelManager.getChannel('my test channel');
channel.appendLine('hello info1'); // showed without color
channel.appendLine('hello info2', OutputChannelSeverity.Info);
channel.appendLine('hello error', OutputChannelSeverity.Error);
channel.appendLine('hello warning', OutputChannelSeverity.Warning);
}
}
export const bindSampleOutputChannelWithSeverity = (bind: interfaces.Bind) => {
bind(FrontendApplicationContribution)
.to(SampleOutputChannelWithSeverity)
.inSingletonScope();
};
14 changes: 10 additions & 4 deletions packages/output/src/browser/output-widget.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

import { inject, injectable, postConstruct } from 'inversify';
import { Message } from '@theia/core/lib/browser';
import { OutputChannelManager, OutputChannel } from '../common/output-channel';
import { OutputChannel, OutputChannelManager, OutputChannelSeverity } from '../common/output-channel';
import { ReactWidget } from '@theia/core/lib/browser/widgets/react-widget';
import * as React from 'react';

Expand Down Expand Up @@ -117,10 +117,16 @@ export class OutputWidget extends ReactWidget {
};

if (this.outputChannelManager.selectedChannel) {
for (const text of this.outputChannelManager.selectedChannel.getLines()) {
const lines = text.split(/[\n\r]+/);
for (const outputChannelLine of this.outputChannelManager.selectedChannel.getLines()) {
const lines = outputChannelLine.text.split(/[\n\r]+/);
let className;
if (outputChannelLine.severity === OutputChannelSeverity.Error) {
className = 'theia-output-error';
} else if (outputChannelLine.severity === OutputChannelSeverity.Warning) {
className = 'theia-output-warning';
}
for (const line of lines) {
result.push(<div style={style} key={id++}>{line}</div>);
result.push(<div style={style} className={className} key={id++}>{line}</div>);
}
}
}
Expand Down
8 changes: 8 additions & 0 deletions packages/output/src/browser/style/output.css
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,11 @@
.output-tab-icon::before {
content: "\f024"
}

.theia-output-error {
color: var(--theia-errorForeground);
}

.theia-output-warning {
color: var(--theia-editorWarning-foreground);
}
27 changes: 19 additions & 8 deletions packages/output/src/common/output-channel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,22 @@ export class OutputChannelManager implements Disposable {
}
}

export enum OutputChannelSeverity {
Error = 1,
Warning = 2,
Info = 3
}
export interface OutputChannelLine {
text: string;
severity?: OutputChannelSeverity;
}

export class OutputChannel {

private readonly visibilityChangeEmitter = new Emitter<{ visible: boolean }>();
private readonly contentChangeEmitter = new Emitter<OutputChannel>();
private lines: string[] = [];
private currentLine: string | undefined;
private lines: OutputChannelLine[] = [];
private currentLine: OutputChannelLine | undefined;
private visible: boolean = true;

readonly onVisibilityChange: Event<{ visible: boolean }> = this.visibilityChangeEmitter.event;
Expand All @@ -120,19 +130,20 @@ export class OutputChannel {

append(value: string): void {
if (this.currentLine === undefined) {
this.currentLine = value;
this.currentLine = { text: value, severity: OutputChannelSeverity.Info };
} else {
this.currentLine += value;
this.currentLine.text += value;
}
this.contentChangeEmitter.fire(this);
}

appendLine(line: string): void {
appendLine(line: string, severity = OutputChannelSeverity.Info): void {
if (this.currentLine !== undefined) {
this.lines.push(this.currentLine + line);
this.currentLine.text = this.currentLine.text + line;
this.lines.push(this.currentLine);
this.currentLine = undefined;
} else {
this.lines.push(line);
this.lines.push({ text: line, severity });
}
const maxChannelHistory = this.preferences['output.maxChannelHistory'];
if (this.lines.length > maxChannelHistory) {
Expand All @@ -152,7 +163,7 @@ export class OutputChannel {
this.visibilityChangeEmitter.fire({ visible });
}

getLines(): string[] {
getLines(): OutputChannelLine[] {
if (this.currentLine !== undefined) {
return [...this.lines, this.currentLine];
} else {
Expand Down

0 comments on commit 368d109

Please sign in to comment.