Microsoft/vscode

Inconsistencies task.json vs. task.json schema

Geschlossen

#243.556 geöffnet am 14.03.2025

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (39.847 Forks)batch import
bughelp wantedtasks

Repository-Metriken

Stars
 (184.936 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 11h 43m) (1.000 gemergte PRs in 30 T)

Beschreibung

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-Richtung
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
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptVS Code extension APIJSON schema
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60