Microsoft/vscode

Inconsistencies task.json vs. task.json schema

Fermée

#243 556 ouverte le 14 mars 2025

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (1 personne assignée)TypeScript (39 847 forks)batch import
bughelp wantedtasks

Métriques du dépôt

Stars
 (184 936 étoiles)
Métriques de merge PR
 (Merge moyen 11h 43m) (1 000 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
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.
Stack technique
typescript
Domaine
developer experiencetooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptVS Code extension APIJSON schema
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60