fix #501

Author: DonJayamanne

package.json

@@ -902,6 +902,17 @@
             "type": "string"
           }
         },
+        "python.linting.ignorePatterns": {
+          "type": "array",
+          "description": "Patterns used to exclude files or folders from being linted.",
+          "default": [
+            ".vscode/*.py",
+            "**/site-packages/**/*.py"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
         "python.linting.pylamaEnabled": {
           "type": "boolean",
           "default": false,
@@ -971,6 +982,7 @@
     "fs-extra": "^0.30.0",
     "fuzzy": "^0.1.3",
     "line-by-line": "^0.1.5",
+    "minimatch": "^3.0.3",
     "named-js-regexp": "^1.3.1",
     "node-static": "^0.7.9",
     "prepend-file": "^1.3.0",

src/client/common/configSettings.ts

@@ -45,6 +45,7 @@ export interface IPylintCategorySeverity {
 }
 export interface ILintingSettings {
     enabled: boolean;
+    ignorePatterns: string[];
     prospectorEnabled: boolean;
     prospectorArgs: string[];
     pylintEnabled: boolean;
@@ -155,6 +156,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
         // Support for travis
         this.linting = this.linting ? this.linting : {
             enabled: false,
+            ignorePatterns: [],
             flake8Args: [], flake8Enabled: false, flake8Path: 'flake',
             lintOnSave: false, lintOnTextChange: false, maxNumberOfProblems: 100,
             mypyArgs: [], mypyEnabled: false, mypyPath: 'mypy',

src/client/linters/baseLinter.ts

@@ -71,7 +71,7 @@ export abstract class BaseLinter {
                 let diagnostics: ILintMessage[] = [];
                 outputLines.filter((value, index) => index <= this.pythonSettings.linting.maxNumberOfProblems).forEach(line => {
                     let match = matchNamedRegEx(line, regEx);
-                    if (match == null) {
+                    if (!match) {
                         return;
                     }
 

src/client/providers/lintProvider.ts

@@ -14,17 +14,16 @@ import * as settings from '../common/configSettings';
 import * as telemetryHelper from '../common/telemetry';
 import * as telemetryContracts from '../common/telemetryContracts';
 import * as fs from 'fs';
+import { LinterErrors } from '../common/constants';
+const Minimatch = require("minimatch").Minimatch;
 
-import { LinterErrors } from '../common/constants'
 const lintSeverityToVSSeverity = new Map<linter.LintMessageSeverity, vscode.DiagnosticSeverity>();
-lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Error, vscode.DiagnosticSeverity.Error)
-lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Hint, vscode.DiagnosticSeverity.Hint)
-lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Information, vscode.DiagnosticSeverity.Information)
-lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Warning, vscode.DiagnosticSeverity.Warning)
+lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Error, vscode.DiagnosticSeverity.Error);
+lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Hint, vscode.DiagnosticSeverity.Hint);
+lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Information, vscode.DiagnosticSeverity.Information);
+lintSeverityToVSSeverity.set(linter.LintMessageSeverity.Warning, vscode.DiagnosticSeverity.Warning);
 
 function createDiagnostics(message: linter.ILintMessage, txtDocumentLines: string[]): vscode.Diagnostic {
-    let sourceLine = txtDocumentLines[message.line - 1];
-    let sourceStart = sourceLine.substring(message.column - 1);
     let endCol = txtDocumentLines[message.line - 1].length;
 
     // try to get the first word from the startig position
@@ -51,17 +50,31 @@ export class LintProvider extends vscode.Disposable {
     private pendingLintings = new Map<string, vscode.CancellationTokenSource>();
     private outputChannel: vscode.OutputChannel;
     private context: vscode.ExtensionContext;
-
+    private disposables: vscode.Disposable[];
+    private ignoreMinmatches: { match: (fname: string) => boolean }[];
     public constructor(context: vscode.ExtensionContext, outputChannel: vscode.OutputChannel,
         private workspaceRootPath: string, private documentHasJupyterCodeCells: DocumentHasJupyterCodeCells) {
         super(() => { });
         this.outputChannel = outputChannel;
         this.context = context;
         this.settings = settings.PythonSettings.getInstance();
-
+        this.disposables = [];
+        this.ignoreMinmatches = [];
         this.initialize();
-    }
 
+        this.disposables.push(vscode.workspace.onDidChangeConfiguration(this.onConfigChanged.bind(this)));
+    }
+    dispose() {
+        this.disposables.forEach(d => d.dispose());
+    }
+    private onConfigChanged() {
+        this.initializeGlobs();
+    }
+    private initializeGlobs() {
+        this.ignoreMinmatches = settings.PythonSettings.getInstance().linting.ignorePatterns.map(pattern => {
+            return new Minimatch(pattern);
+        });
+    }
     private isDocumentOpen(uri: vscode.Uri): boolean {
         return vscode.window.visibleTextEditors.some(editor => editor.document && editor.document.uri.fsPath === uri.fsPath);
     }
@@ -89,7 +102,7 @@ export class LintProvider extends vscode.Disposable {
             if (e.languageId !== 'python' || !this.settings.linting.enabled) {
                 return;
             }
-            if (!e.uri.path || (path.basename(e.uri.path) === e.uri.path && !fs.existsSync(e.uri.path))){
+            if (!e.uri.path || (path.basename(e.uri.path) === e.uri.path && !fs.existsSync(e.uri.path))) {
                 return;
             }
             this.lintDocument(e, e.uri, e.getText().split(/\r?\n/g), 100);
@@ -106,6 +119,7 @@ export class LintProvider extends vscode.Disposable {
             }
         });
         this.context.subscriptions.push(disposable);
+        this.initializeGlobs();
     }
 
     private lastTimeout: number;
@@ -123,6 +137,11 @@ export class LintProvider extends vscode.Disposable {
     }
 
     private onLintDocument(document: vscode.TextDocument, documentUri: vscode.Uri, documentLines: string[]): void {
+        // Check if we need to lint this document
+        const relativeFileName = path.relative(vscode.workspace.rootPath, document.fileName);
+        if (this.ignoreMinmatches.some(matcher => matcher.match(document.fileName) || matcher.match(relativeFileName))) {
+            return;
+        }
         if (this.pendingLintings.has(documentUri.fsPath)) {
             this.pendingLintings.get(documentUri.fsPath).cancel();
             this.pendingLintings.delete(documentUri.fsPath);