debt - mention our wiki when putting out layer errors (#157768)

microsoft · Aug 10, 2022 · e430631 · e430631
1 parent c612dc7
commit e430631
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/build/lib/layersChecker.js b/build/lib/layersChecker.js
@@ -229,7 +229,7 @@ function checkFile(program, sourceFile, rule) {
         }
         if (rule.disallowedTypes?.some(disallowed => disallowed === text)) {
             const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-            console.log(`[build/lib/layersChecker.ts]: Reference to type '${text}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1})`);
+            console.log(`[build/lib/layersChecker.ts]: Reference to type '${text}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1}). Learn more about our source code organization at https://github.com/microsoft/vscode/wiki/Source-Code-Organization.`);
             hasErrors = true;
             return;
         }
@@ -253,7 +253,7 @@ function checkFile(program, sourceFile, rule) {
                                 for (const disallowedDefinition of rule.disallowedDefinitions) {
                                     if (definitionFileName.indexOf(disallowedDefinition) >= 0) {
                                         const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-                                        console.log(`[build/lib/layersChecker.ts]: Reference to symbol '${text}' from '${disallowedDefinition}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1})`);
+                                        console.log(`[build/lib/layersChecker.ts]: Reference to symbol '${text}' from '${disallowedDefinition}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1}) Learn more about our source code organization at https://github.com/microsoft/vscode/wiki/Source-Code-Organization.`);
                                         hasErrors = true;
                                         return;
                                     }

diff --git a/build/lib/layersChecker.ts b/build/lib/layersChecker.ts
@@ -269,7 +269,7 @@ function checkFile(program: ts.Program, sourceFile: ts.SourceFile, rule: IRule)
 
 		if (rule.disallowedTypes?.some(disallowed => disallowed === text)) {
 			const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-			console.log(`[build/lib/layersChecker.ts]: Reference to type '${text}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1})`);
+			console.log(`[build/lib/layersChecker.ts]: Reference to type '${text}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1}). Learn more about our source code organization at https://github.com/microsoft/vscode/wiki/Source-Code-Organization.`);
 
 			hasErrors = true;
 			return;
@@ -296,7 +296,7 @@ function checkFile(program: ts.Program, sourceFile: ts.SourceFile, rule: IRule)
 									if (definitionFileName.indexOf(disallowedDefinition) >= 0) {
 										const { line, character } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
 
-										console.log(`[build/lib/layersChecker.ts]: Reference to symbol '${text}' from '${disallowedDefinition}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1})`);
+										console.log(`[build/lib/layersChecker.ts]: Reference to symbol '${text}' from '${disallowedDefinition}' violates layer '${rule.target}' (${sourceFile.fileName} (${line + 1},${character + 1}) Learn more about our source code organization at https://github.com/microsoft/vscode/wiki/Source-Code-Organization.`);
 
 										hasErrors = true;
 										return;