support modifying existing problem matchers

- VS Code supports the possibility of modifying existing problem matchers. With this change, Theia users can define a base problem matcher in which they can further customize the properties `background`, `fileLocation`, `applyTo`, `owner`, `severity`, `pattern`, and `source`. - resolves #6427 Signed-off-by: Liang Huang <lhuang4@ualberta.ca>
eclipse-theia · Apr 1, 2020 · cf86e86 · cf86e86
1 parent 5d20fac
commit cf86e86
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 11 deletions.
diff --git a/packages/task/src/browser/task-problem-matcher-registry.ts b/packages/task/src/browser/task-problem-matcher-registry.ts
@@ -112,7 +112,22 @@ export class ProblemMatcherRegistry {
      * @return the problem matcher
      */
     async getProblemMatcherFromContribution(matcher: ProblemMatcherContribution): Promise<ProblemMatcher> {
-        const { fileLocation, filePrefix } = this.getFileLocationKindAndPrefix(matcher);
+        let baseMatcher: NamedProblemMatcher | undefined;
+        if (matcher.base) {
+            baseMatcher = this.get(matcher.base);
+        }
+
+        let fileLocation: FileLocationKind | undefined;
+        let filePrefix: string | undefined;
+        if (matcher.fileLocation === undefined) {
+            fileLocation = baseMatcher ? baseMatcher.fileLocation : FileLocationKind.Relative;
+            filePrefix = baseMatcher ? baseMatcher.filePrefix : '${workspaceFolder}';
+        } else {
+            const locationAndPrefix = this.getFileLocationKindAndPrefix(matcher);
+            fileLocation = locationAndPrefix.fileLocation;
+            filePrefix = locationAndPrefix.filePrefix;
+        }
+
         const patterns: ProblemPattern[] = [];
         if (matcher.pattern) {
             if (typeof matcher.pattern === 'string') {
@@ -128,19 +143,42 @@ export class ProblemMatcherRegistry {
             } else {
                 patterns.push(ProblemPattern.fromProblemPatternContribution(matcher.pattern));
             }
+        } else if (baseMatcher) {
+            patterns.push(...baseMatcher.pattern);
+        }
+
+        let deprecated: boolean | undefined = matcher.deprecated;
+        if (deprecated === undefined && baseMatcher) {
+            deprecated = baseMatcher.deprecated;
+        }
+
+        let applyTo: ApplyToKind | undefined;
+        if (matcher.applyTo === undefined) {
+            applyTo = baseMatcher ? baseMatcher.applyTo : ApplyToKind.allDocuments;
+        } else {
+            applyTo = ApplyToKind.fromString(matcher.applyTo) || ApplyToKind.allDocuments;
+        }
+
+        let severity: Severity = Severity.fromValue(matcher.severity);
+        if (matcher.severity === undefined && baseMatcher && baseMatcher.severity !== undefined) {
+            severity = baseMatcher.severity;
+        }
+        let watching: WatchingMatcher | undefined = WatchingMatcher.fromWatchingMatcherContribution(matcher.background || matcher.watching);
+        if (watching === undefined && baseMatcher) {
+            watching = baseMatcher.watching;
         }
         const problemMatcher = {
-            name: matcher.name,
-            label: matcher.label,
-            deprecated: matcher.deprecated,
-            owner: matcher.owner,
-            source: matcher.source,
-            applyTo: ApplyToKind.fromString(matcher.applyTo) || ApplyToKind.allDocuments,
+            name: matcher.name || (baseMatcher ? baseMatcher.name : undefined),
+            label: matcher.label || (baseMatcher ? baseMatcher.label : undefined),
+            deprecated,
+            owner: matcher.owner || (baseMatcher ? baseMatcher.owner : ''),
+            source: matcher.source || (baseMatcher ? baseMatcher.source : undefined),
+            applyTo,
             fileLocation,
             filePrefix,
             pattern: patterns,
-            severity: Severity.fromValue(matcher.severity),
-            watching: WatchingMatcher.fromWatchingMatcherContribution(matcher.background || matcher.watching)
+            severity,
+            watching
         };
         return problemMatcher;
     }

diff --git a/packages/task/src/browser/task-schema-updater.ts b/packages/task/src/browser/task-schema-updater.ts
@@ -413,6 +413,7 @@ const problemMatcherObject: IJSONSchema = {
     properties: {
         base: {
             type: 'string',
+            enum: problemMatcherNames,
             description: 'The name of a base problem matcher to use.'
         },
         owner: {

diff --git a/packages/task/src/browser/task-service.ts b/packages/task/src/browser/task-service.ts
@@ -754,7 +754,7 @@ export class TaskService implements TaskConfigurationClient {
         const resolvedTask = await this.getResolvedTask(task);
         if (resolvedTask) {
             // remove problem markers from the same source before running the task
-            await this.removeProblemMarks(option);
+            await this.removeProblemMarkers(option);
             return this.runResolvedTask(resolvedTask, option);
         }
     }
@@ -869,7 +869,7 @@ export class TaskService implements TaskConfigurationClient {
         return customizationObject;
     }
 
-    private async removeProblemMarks(option?: RunTaskOption): Promise<void> {
+    private async removeProblemMarkers(option?: RunTaskOption): Promise<void> {
         if (option && option.customization) {
             const matchersFromOption = option.customization.problemMatcher || [];
             for (const matcher of matchersFromOption) {

diff --git a/packages/task/src/common/task-protocol.ts b/packages/task/src/common/task-protocol.ts
@@ -248,6 +248,7 @@ export interface WatchingMatcherContribution {
 }
 
 export interface ProblemMatcherContribution {
+    base?: string;
     name?: string;
     label: string;
     deprecated?: boolean;