close
Skip to content

fix(workbench): add preference to disable recently used tasks #61994

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

Closed
kumarharsh wants to merge 1 commit into from
Closed

fix(workbench): add preference to disable recently used tasks #61994

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
5 changes: 5 additions & 0 deletions src/vs/workbench/parts/preferences/browser/settingsLayout.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ export const tocData: ITOCEntry = {
label: localize('terminal', "Terminal"),
settings: ['terminal.*']
},
{
id: 'features/tasks',
label: localize('tasks', "Tasks"),
settings: ['tasks.*']
},
{
id: 'features/problems',
label: localize('problems', "Problems"),
Expand Down
51 changes: 42 additions & 9 deletions src/vs/workbench/parts/tasks/electron-browser/task.contribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import Severity from 'vs/base/common/severity';
import * as Objects from 'vs/base/common/objects';
import { URI } from 'vs/base/common/uri';
import { IStringDictionary } from 'vs/base/common/collections';
import { IConfigurationRegistry, Extensions as ConfigurationExtensions } from 'vs/platform/configuration/common/configurationRegistry';
import { Action } from 'vs/base/common/actions';
import * as Dom from 'vs/base/browser/dom';
import { IDisposable, dispose, toDisposable, Disposable } from 'vs/base/common/lifecycle';
Expand All @@ -25,7 +26,7 @@ import * as strings from 'vs/base/common/strings';
import { ValidationStatus, ValidationState } from 'vs/base/common/parsers';
import * as UUID from 'vs/base/common/uuid';
import * as Platform from 'vs/base/common/platform';
import { LinkedMap, Touch } from 'vs/base/common/map';
import { LRUCache } from 'vs/base/common/map';
import { OcticonLabel } from 'vs/base/browser/ui/octiconLabel/octiconLabel';

import { Registry } from 'vs/platform/registry/common/platform';
Expand Down Expand Up @@ -95,6 +96,7 @@ import { TaskDefinitionRegistry } from 'vs/workbench/parts/tasks/common/taskDefi
import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';

let tasksCategory = nls.localize('tasksCategory', "Tasks");
const QUICKOPEN_HISTORY_LIMIT_CONFIG = 'tasks.quickOpen.history';

namespace ConfigureTaskAction {
export const ID = 'workbench.action.tasks.configureTaskRunner';
Expand Down Expand Up @@ -459,7 +461,7 @@ class TaskService extends Disposable implements ITaskService {

private _taskSystem: ITaskSystem;
private _taskSystemListener: IDisposable;
private _recentlyUsedTasks: LinkedMap<string, string>;
private _recentlyUsedTasks: LRUCache<string, string>;

private _taskRunningState: IContextKey<boolean>;

Expand Down Expand Up @@ -526,13 +528,16 @@ class TaskService extends Disposable implements ITaskService {
this.updateSetup(folderSetup);
this.updateWorkspaceTasks();
}));
this._register(this.configurationService.onDidChangeConfiguration(() => {
this._register(this.configurationService.onDidChangeConfiguration((e) => {
if (!this._taskSystem && !this._workspaceTasksPromise) {
return;
}
if (!this._taskSystem || this._taskSystem instanceof TerminalTaskSystem) {
this._outputChannel.clear();
}
if (e.affectsConfiguration(QUICKOPEN_HISTORY_LIMIT_CONFIG)) {
this.setTaskLRUCacheLimit();
}
this.updateWorkspaceTasks();
}));
this._taskRunningState = TASK_RUNNING_STATE.bindTo(contextKeyService);
Expand Down Expand Up @@ -774,11 +779,12 @@ class TaskService extends Disposable implements ITaskService {
return TPromise.as(this._taskSystem.getActiveTasks());
}

public getRecentlyUsedTasks(): LinkedMap<string, string> {
public getRecentlyUsedTasks(): LRUCache<string, string> {
if (this._recentlyUsedTasks) {
return this._recentlyUsedTasks;
}
this._recentlyUsedTasks = new LinkedMap<string, string>();
const quickOpenHistoryLimit = this.configurationService.getValue<number>(QUICKOPEN_HISTORY_LIMIT_CONFIG);
this._recentlyUsedTasks = new LRUCache<string, string>(quickOpenHistoryLimit);
let storageValue = this.storageService.get(TaskService.RecentlyUsedTasks_Key, StorageScope.WORKSPACE);
if (storageValue) {
try {
Expand All @@ -795,13 +801,25 @@ class TaskService extends Disposable implements ITaskService {
return this._recentlyUsedTasks;
}

private setTaskLRUCacheLimit() {
const quickOpenHistoryLimit = this.configurationService.getValue<number>(QUICKOPEN_HISTORY_LIMIT_CONFIG);
if (this._recentlyUsedTasks) {
this._recentlyUsedTasks.limit = quickOpenHistoryLimit;
}
}

private saveState(): void {
if (!this._taskSystem || !this._recentlyUsedTasks) {
return;
}
const quickOpenHistoryLimit = this.configurationService.getValue<number>(QUICKOPEN_HISTORY_LIMIT_CONFIG);
// setting history limit to 0 means no LRU sorting
if (quickOpenHistoryLimit === 0) {
return;
}
let values = this._recentlyUsedTasks.values();
if (values.length > 30) {
values = values.slice(0, 30);
if (values.length > quickOpenHistoryLimit) {
values = values.slice(0, quickOpenHistoryLimit);
}
this.storageService.store(TaskService.RecentlyUsedTasks_Key, JSON.stringify(values), StorageScope.WORKSPACE);
}
Expand Down Expand Up @@ -1221,11 +1239,11 @@ class TaskService extends Disposable implements ITaskService {

private executeTask(task: Task, resolver: ITaskResolver): TPromise<ITaskSummary> {
return ProblemMatcherRegistry.onReady().then(() => {
return this.textFileService.saveAll().then((value) => { // make sure all dirty files are saved
return this.textFileService.saveAll().then(() => { // make sure all dirty files are saved
let executeResult = this.getTaskSystem().run(task, resolver);
let key = Task.getRecentlyUsedKey(task);
if (key) {
this.getRecentlyUsedTasks().set(key, key, Touch.AsOld);
this.getRecentlyUsedTasks().set(key, key);
}
if (executeResult.kind === TaskExecuteKind.Active) {
let active = executeResult.active;
Expand Down Expand Up @@ -2601,3 +2619,18 @@ schema.oneOf = [...schemaVersion2.oneOf, ...schemaVersion1.oneOf];

let jsonRegistry = <jsonContributionRegistry.IJSONContributionRegistry>Registry.as(jsonContributionRegistry.Extensions.JSONContribution);
jsonRegistry.registerSchema(schemaId, schema);

const configurationRegistry = Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration);
configurationRegistry.registerConfiguration({
id: 'tasks',
order: 100,
title: nls.localize('TasksConfigurationTitle', "Tasks"),
type: 'object',
properties: {
'tasks.quickOpen.history': {
type: 'number',
default: 30,
description: nls.localize('tasks.quickOpen.history', "Controls the number of recent items tracked in task quick open dialog.")
},
}
});