[textmate] don't warn when same grammar is registered multiple times

Fixes #6124 Signed-off-by: Sven Efftinge <sven.efftinge@typefox.io>
eclipse-theia · Sep 6, 2019 · e2d6355 · e2d6355
1 parent e93b1d4
commit e2d6355
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/packages/monaco/src/browser/textmate/textmate-registry.ts b/packages/monaco/src/browser/textmate/textmate-registry.ts
@@ -35,6 +35,7 @@ export interface GrammarDefinitionProvider {
 export interface GrammarDefinition {
     format: 'json' | 'plist';
     content: object | string;
+    location?: string;
 }
 
 @injectable()
@@ -45,8 +46,13 @@ export class TextmateRegistry {
     readonly languageIdToScope = new Map<string, string>();
 
     registerTextmateGrammarScope(scope: string, description: GrammarDefinitionProvider): void {
-        if (this.scopeToProvider.has(scope)) {
-            console.warn(new Error(`a registered grammar provider for '${scope}' scope is overridden`));
+        const existingProvider = this.scopeToProvider.get(scope);
+        if (existingProvider) {
+            Promise.all([existingProvider.getGrammarDefinition(), description.getGrammarDefinition()]).then(([a, b]) => {
+                if (a.location !== b.location || !a.location && !b.location) {
+                    console.warn(new Error(`a registered grammar provider for '${scope}' scope is overridden`));
+                }
+            });
         }
         this.scopeToProvider.set(scope, description);
     }

diff --git a/packages/plugin-ext/src/common/plugin-protocol.ts b/packages/plugin-ext/src/common/plugin-protocol.ts
@@ -416,6 +416,7 @@ export interface GrammarsContribution {
     language?: string;
     scope: string;
     grammar?: string | object;
+    grammarLocation?: string;
     embeddedLanguages?: ScopeMap;
     tokenTypes?: ScopeMap;
     injectTo?: string[];

diff --git a/packages/plugin-ext/src/hosted/node/scanners/grammars-reader.ts b/packages/plugin-ext/src/hosted/node/scanners/grammars-reader.ts
@@ -46,6 +46,7 @@ export class GrammarsReader {
             scope: rawGrammar.scopeName,
             format: rawGrammar.path.endsWith('json') ? 'json' : 'plist',
             grammar: grammar,
+            grammarLocation: rawGrammar.path,
             injectTo: rawGrammar.injectTo,
             embeddedLanguages: rawGrammar.embeddedLanguages,
             tokenTypes: rawGrammar.tokenTypes

diff --git a/packages/plugin-ext/src/main/browser/plugin-contribution-handler.ts b/packages/plugin-ext/src/main/browser/plugin-contribution-handler.ts
@@ -138,6 +138,7 @@ export class PluginContributionHandler {
                         return {
                             format: grammar.format,
                             content: grammar.grammar || '',
+                            location: grammar.grammarLocation
                         };
                     },
                     getInjections: (scopeName: string) =>