Microsoft/vscode

Inconsistencies task.json vs. task.json schema

Closed

#243,556 opened on Mar 14, 2025

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)TypeScript (39,847 forks)batch import
bughelp wantedtasks

Repository metrics

Stars
 (184,936 stars)
PR merge metrics
 (Avg merge 11h 43m) (1,000 merged PRs in 30d)

Description

Type: Bug

When trying to validate my task.json against the task.json schema published in the Appendix I noticed some inconsistencies.

  1. beginsPattern/ endsPattern The schema defines them this way in the BackgroundMatcher interface

    beginsPattern?: string;
endsPattern?: string;

    But in VS Code I can define them this way:

    "problemMatcher": {
  "base": "$tsc-watch",
  "background": {
    "activeOnStart": true,
    "beginsPattern": {
      "regexp": "(.*?)"
    },
    "endsPattern": {
      "regexp": "bundle generation complete"
    }
  }
},

    So while the schema restricts the value to be string, it also accepts regexp in reality. Also IntelliSense provides this as a valid entry.

  2. Missing property "type"

    The TaskDescription interface defines the type like this

    type: 'shell' | 'process';

    It is therefore defined as a mandatory field. But in reality it is not. Otherwise it would not be possible to create a compound task as described in Compound Tasks

  3. Missing property "command"

    The TaskDescription interface defines the command like this

    command: string;

    It is therefore defined as a mandatory field. But in reality it is not. Otherwise it would not be possible to create a compound task as described in Compound Tasks

VS Code version: Code 1.98.1 (2fc07b811f760549dab9be9d2bedd06c51dfcb9a, 2025-03-10T15:38:08.854Z) OS version: Windows_NT x64 10.0.22631 Modes: Remote OS version: Linux x64 5.15.167.4-microsoft-standard-WSL2

Contributor guide

Research direction
The issue identifies three inconsistencies in the task.json schema versus actual runtime behavior. First, `beginsPattern` and `endsPattern` in `BackgroundMatcher` should accept an object with a `regexp` property instead of just a string. Second, the `type` property in `TaskDescription` should be optional to allow compound tasks. Third, the `command` property should also be optional. The fix likely involves updating the TypeScript interfaces in files such as `src/vs/workbench/contrib/tasks/common/tasks.ts` and the corresponding JSON schema file. Review the existing tests for task validation to ensure changes don't break anything. Start by locating the schema definitions and modifying the property types accordingly.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptVS Code extension APIJSON schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60