Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markers: improve 'description' #7209

Merged
merged 1 commit into from
Feb 27, 2020
+156 −94
Merged

markers: improve 'description' #7209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 144 additions & 88 deletions packages/markers/src/browser/marker-tree-label-provider.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@ import URI from '@theia/core/lib/common/uri';
import { expect } from 'chai';
import { Container } from 'inversify';
import { ContributionProvider } from '@theia/core/lib/common';
import { FileStat } from '@theia/filesystem/lib/common';
import { LabelProvider, LabelProviderContribution, DefaultUriLabelProviderContribution } from '@theia/core/lib/browser';
import { FileStat, FileSystem } from '@theia/filesystem/lib/common';
import { LabelProvider, LabelProviderContribution, DefaultUriLabelProviderContribution, ApplicationShell } from '@theia/core/lib/browser';
import { MarkerInfoNode } from './marker-tree';
import { MarkerTreeLabelProvider } from './marker-tree-label-provider';
import { Signal } from '@phosphor/signaling';
import { TreeLabelProvider } from '@theia/core/lib/browser/tree/tree-label-provider';
import { WorkspaceService } from '@theia/workspace/lib/browser';
import { WorkspaceUriLabelProviderContribution } from '@theia/workspace/lib/browser/workspace-uri-contribution';
import { WorkspaceVariableContribution } from '@theia/workspace/lib/browser/workspace-variable-contribution';
import { MockFilesystem } from '@theia/filesystem/lib/common/test/mock-filesystem';

disableJSDOM();

Expand All @@ -40,8 +44,15 @@ before(() => {

workspaceService = new WorkspaceService();
testContainer.bind(WorkspaceService).toConstantValue(workspaceService);
testContainer.bind(WorkspaceVariableContribution).toSelf().inSingletonScope();
testContainer.bind(ApplicationShell).toConstantValue({
currentChanged: new Signal({})
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any);
testContainer.bind(FileSystem).to(MockFilesystem).inSingletonScope();

testContainer.bind(DefaultUriLabelProviderContribution).toSelf().inSingletonScope();
testContainer.bind(WorkspaceUriLabelProviderContribution).toSelf().inSingletonScope();
testContainer.bind(LabelProvider).toSelf().inSingletonScope();
testContainer.bind(MarkerTreeLabelProvider).toSelf().inSingletonScope();
testContainer.bind(TreeLabelProvider).toSelf().inSingletonScope();
Expand All @@ -51,6 +62,7 @@ before(() => {
return [
ctx.container.get<MarkerTreeLabelProvider>(MarkerTreeLabelProvider),
ctx.container.get<TreeLabelProvider>(TreeLabelProvider),
ctx.container.get<WorkspaceUriLabelProviderContribution>(WorkspaceUriLabelProviderContribution),
ctx.container.get<DefaultUriLabelProviderContribution>(DefaultUriLabelProviderContribution)
];
}
Expand All @@ -66,101 +78,145 @@ after(() => {

describe('Marker Tree Label Provider', () => {

it('should return the filename and extension for #getName', () => {
const label = markerTreeLabelProvider.getName(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(label).equals('foo.ts');
describe('#getName', () => {
it('should return the correct filename and extension', () => {
const label = markerTreeLabelProvider.getName(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(label).equals('foo.ts');
});
});

it('should return the folder name for #getLongName', async () => {

// Verify that the label provider successfully returns the directory name.
let label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(label).equals('/a/b/c');

// Verify that the label provider successfully returns the directory name (starting with a period).
label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('a/b/.c/foo.ts')
);
expect(label).equals('/a/b/.c');

// Verify that the label provider successfully returns the directory name (at the root).
label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('foo.ts')
);
expect(label).equals('/');

// Verify that the label provider successfully returns the directory and root name for a multiple root workspace.
const uri: string = 'file:///file';
const file = <FileStat>{
uri: uri,
lastModification: 0,
isDirectory: false
};
const root1 = <FileStat>{
uri: 'file:///root1',
lastModification: 0,
isDirectory: true
};
const root2 = <FileStat>{
uri: 'file:///root2',
lastModification: 0,
isDirectory: true
};
workspaceService['_workspace'] = file;
workspaceService['_roots'] = [root1, root2];
label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///root1/foo/foo.ts')
);
expect(label).equals('root1 ● /root1/foo');

label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///root2/foo/foo.ts')
);
expect(label).equals('root2 ● /root2/foo');
describe('getLongName', () => {
describe('single-root workspace', () => {
beforeEach(() => {
const root = <FileStat>{
uri: 'file:///home/a',
lastModification: 0,
isDirectory: true
};
workspaceService['_workspace'] = root;
workspaceService['_roots'] = [root];
});
it('should return the proper label for a directory', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///home/a/b/c/foo.ts')
);
expect(label).equals('b/c');
});
it('should return the proper label for a directory starting with \'.\'', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///home/a/b/.c/foo.ts')
);
expect(label).equals('b/.c');
});
it('should return the proper label when the resource is located at the workspace root', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///home/a/foo.ts')
);
expect(label).equals('');
});
it('should return the full path when the resource does not exist in the workspace root', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///home/b/foo.ts')
);
expect(label).equals('/home/b');
});
});
describe('multi-root workspace', () => {
beforeEach(() => {
const uri: string = 'file:///file';
const file = <FileStat>{
uri: uri,
lastModification: 0,
isDirectory: false
};
const root1 = <FileStat>{
uri: 'file:///root1',
lastModification: 0,
isDirectory: true
};
const root2 = <FileStat>{
uri: 'file:///root2',
lastModification: 0,
isDirectory: true
};
workspaceService['_workspace'] = file;
workspaceService['_roots'] = [root1, root2];
});
it('should return the proper root \'root1\' and directory', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///root1/foo/foo.ts')
);
expect(label).equals('root1 ● foo');
});
it('should return the proper root \'root2\' and directory', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///root2/foo/foo.ts')
);
expect(label).equals('root2 ● foo');
});
it('should only return the root when the resource is located at the workspace root', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///root1/foo.ts')
);
expect(label).equals('root1');
});
it('should return the full path when the resource does not exist in any workspace root', () => {
const label = markerTreeLabelProvider.getLongName(
createMarkerInfoNode('file:///home/a/b/foo.ts')
);
expect(label).equals('/home/a/b');
});
});
});

it('should return the filename and extension for #getIcon', () => {

// Verify that a typescript icon is returned for a typescript file.
const typescriptIcon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(typescriptIcon).contain('ts-icon');

// Verify that a json icon is returned for a json file.
const jsonIcon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.json')
);
expect(jsonIcon).contain('database-icon');

// Verify that a markdown icon is returned for a markdown file.
const markdownIcon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.md')
);
expect(markdownIcon).contain('markdown-icon');
describe('#getIcon', () => {
it('should return a typescript icon for a typescript file', () => {
const icon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(icon).contain('ts-icon');
});
it('should return a json icon for a json file', () => {
const icon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.json')
);
expect(icon).contain('database-icon');
});
it('should return a generic icon for a file with no extension', () => {
const icon = markerTreeLabelProvider.getIcon(
createMarkerInfoNode('a/b/c/foo.md')
);
expect(icon).contain('markdown-icon');
});
});

it('should return the parent\'s long name for #getDescription', () => {

let label = markerTreeLabelProvider.getDescription(
createMarkerInfoNode('a/b/c/foo.ts')
);
expect(label).equals('/a/b/c');

label = markerTreeLabelProvider.getDescription(
createMarkerInfoNode('foo.ts')
);
expect(label).equals('/');
describe('#getDescription', () => {
beforeEach(() => {
const root = <FileStat>{
uri: 'file:///home/a',
lastModification: 0,
isDirectory: true
};
workspaceService['_workspace'] = root;
workspaceService['_roots'] = [root];
});
it('should return the parent\' long name', () => {
const label = markerTreeLabelProvider.getDescription(
createMarkerInfoNode('file:///home/a/b/c/foo.ts')
);
expect(label).equals('b/c');
});
});

it('should successfully handle \'MarkerInfoNodes\'', () => {
const node = createMarkerInfoNode('a/b/c/foo.ts');
expect(markerTreeLabelProvider.canHandle(node)).greaterThan(0);
describe('#canHandle', () => {
it('should successfully handle \'MarkerInfoNodes\'', () => {
const node = createMarkerInfoNode('a/b/c/foo.ts');
expect(markerTreeLabelProvider.canHandle(node)).greaterThan(0);
});
});

});

/**
Expand Down
18 changes: 12 additions & 6 deletions packages/markers/src/browser/marker-tree-label-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,19 @@ export class MarkerTreeLabelProvider implements LabelProviderContribution {

getLongName(node: MarkerInfoNode): string {
const description: string[] = [];
if (this.workspaceService.isMultiRootWorkspaceOpened) {
const rootUri = this.workspaceService.getWorkspaceRootUri(node.uri);
if (rootUri) {
description.push(this.labelProvider.getName(rootUri));
}
const rootUri = this.workspaceService.getWorkspaceRootUri(node.uri);
// In a multiple-root workspace include the root name to the label before the parent directory.
if (this.workspaceService.isMultiRootWorkspaceOpened && rootUri) {
description.push(this.labelProvider.getName(rootUri));
}
// If the given resource is not at the workspace root, include the parent directory to the label.
if (rootUri && rootUri.toString() !== node.uri.parent.toString()) {
description.push(this.labelProvider.getLongName(node.uri.parent));
}
// Get the full path of a resource which does not exist in the given workspace.
if (!rootUri) {
description.push(this.labelProvider.getLongName(node.uri.parent.withScheme('markers')));
}
description.push(this.labelProvider.getLongName(node.uri.parent));
return description.join(' ● ');
}

Expand Down