Auto lint opened files and re-lint upon config changes (#15)

* auto lint opened files and re-lint upon config changes * fix linter

Author: DonJayamanne

src/client/common/configSettingMonitor.ts

@@ -0,0 +1,87 @@
+import { EventEmitter } from 'events';
+import { ConfigurationTarget, Disposable, Uri, workspace, WorkspaceFolder } from 'vscode';
+import { PythonSettings } from '../common/configSettings';
+
+type settingsToMonitor = 'linting';
+
+export class ConfigSettingMonitor extends EventEmitter implements Disposable {
+ private oldSettings = new Map<string, string>();
+ // tslint:disable-next-line:no-any
+ private timeout?: any;
+ constructor(private settingToMonitor: settingsToMonitor) {
+ super();
+ this.initializeSettings();
+ // tslint:disable-next-line:no-void-expression
+ PythonSettings.getInstance().on('change', () => this.onConfigChange());
+ }
+ public dispose() {
+ if (this.timeout) {
+ // tslint:disable-next-line:no-unsafe-any
+ clearTimeout(this.timeout);
+ }
+ }
+ private onConfigChange() {
+ if (this.timeout) {
+ // tslint:disable-next-line:no-unsafe-any
+ clearTimeout(this.timeout);
+ }
+ this.timeout = setTimeout(() => {
+ this.timeout = undefined;
+ this.checkChangesToSettingsInWorkspace();
+ this.checkChangesToSettingsInWorkspaceFolders();
+ }, 1000);
+ }
+ private initializeSettings() {
+ if (!Array.isArray(workspace.workspaceFolders)) {
+ return;
+ }
+ if (workspace.workspaceFolders.length === 1) {
+ const key = this.getWorkspaceKey();
+ const currentValue = JSON.stringify(PythonSettings.getInstance()[this.settingToMonitor]);
+ this.oldSettings.set(key, currentValue);
+ } else {
+ workspace.workspaceFolders.forEach(wkspaceFolder => {
+ const key = this.getWorkspaceFolderKey(wkspaceFolder.uri);
+ const currentValue = JSON.stringify(PythonSettings.getInstance(wkspaceFolder.uri)[this.settingToMonitor]);
+ this.oldSettings.set(key, currentValue);
+ });
+ }
+ }
+ private checkChangesToSettingsInWorkspace() {
+ if (!Array.isArray(workspace.workspaceFolders) || workspace.workspaceFolders.length === 0) {
+ return;
+ }
+ const newValue = JSON.stringify(PythonSettings.getInstance()[this.settingToMonitor]);
+ this.checkChangesAndNotifiy(ConfigurationTarget.Workspace, workspace.workspaceFolders[0].uri, newValue);
+ }
+ private checkChangesToSettingsInWorkspaceFolders() {
+ if (!Array.isArray(workspace.workspaceFolders) || workspace.workspaceFolders.length <= 1) {
+ return;
+ }
+ // tslint:disable-next-line:no-void-expression
+ workspace.workspaceFolders.forEach(folder => this.checkChangesToSettingsInWorkspaceFolder(folder));
+ }
+ private checkChangesToSettingsInWorkspaceFolder(workspaceFolder: WorkspaceFolder) {
+ const newValue = JSON.stringify(PythonSettings.getInstance(workspaceFolder.uri)[this.settingToMonitor]);
+ this.checkChangesAndNotifiy(ConfigurationTarget.WorkspaceFolder, workspaceFolder.uri, newValue);
+ }
+ private checkChangesAndNotifiy(configTarget: ConfigurationTarget, uri: Uri, newValue: string) {
+ const key = configTarget === ConfigurationTarget.Workspace ? this.getWorkspaceKey() : this.getWorkspaceFolderKey(uri);
+ if (this.oldSettings.has(key)) {
+ const oldValue = this.oldSettings.get(key);
+ if (oldValue !== newValue) {
+ this.oldSettings.set(key, newValue);
+ this.emit('change', configTarget, uri);
+ }
+ } else {
+ this.oldSettings.set(key, newValue);
+ }
+ }
+ private getWorkspaceKey() {
+ // tslint:disable-next-line:no-non-null-assertion
+ return workspace.workspaceFolders[0]!.uri.fsPath;
+ }
+ private getWorkspaceFolderKey(wkspaceFolder: Uri) {
+ return `${ConfigurationTarget.WorkspaceFolder}:${wkspaceFolder.fsPath}`;
+ }
+}

src/client/providers/lintProvider.ts

@@ -3,8 +3,11 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as vscode from 'vscode';
+import { ConfigurationTarget, Uri, workspace } from 'vscode';
+import { ConfigSettingMonitor } from '../common/configSettingMonitor';
 import { PythonSettings } from '../common/configSettings';
 import { LinterErrors } from '../common/constants';
+import { PythonLanguage } from '../jupyter/common/constants';
 import * as linter from '../linters/baseLinter';
 import { sendTelemetryWhenDone } from '../telemetry';
 import { LINTING } from '../telemetry/constants';
@@ -49,18 +52,22 @@ export class LintProvider implements vscode.Disposable {
  private outputChannel: vscode.OutputChannel;
  private context: vscode.ExtensionContext;
  private disposables: vscode.Disposable[];
+ private configMonitor: ConfigSettingMonitor;
  public constructor(context: vscode.ExtensionContext, outputChannel: vscode.OutputChannel,
  public documentHasJupyterCodeCells: DocumentHasJupyterCodeCells) {
  this.outputChannel = outputChannel;
  this.context = context;
  this.disposables = [];
  this.initialize();
+ this.configMonitor = new ConfigSettingMonitor('linting');
+ this.configMonitor.on('change', this.lintSettingsChangedHandler.bind(this));
  }
  public dispose() {
  this.disposables.forEach(d => d.dispose());
+ this.configMonitor.dispose();
  }
  private isDocumentOpen(uri: vscode.Uri): boolean {
- return vscode.window.visibleTextEditors.some(editor => editor.document && editor.document.uri.fsPath === uri.fsPath);
+ return vscode.workspace.textDocuments.some(document => document.uri.fsPath === uri.fsPath);
  }
 
  private initialize() {
@@ -109,6 +116,28 @@ export class LintProvider implements vscode.Disposable {
  }
  });
  this.context.subscriptions.push(disposable);
+ this.lintOpenPythonFiles();
+ }
+
+ private lintOpenPythonFiles() {
+ workspace.textDocuments.forEach(document => {
+ if (document.languageId === PythonLanguage.language) {
+ this.onLintDocument(document, 'auto');
+ }
+ });
+ }
+ private lintSettingsChangedHandler(configTarget: ConfigurationTarget, wkspaceOrFolder: Uri) {
+ if (configTarget === ConfigurationTarget.Workspace) {
+ this.lintOpenPythonFiles();
+ return;
+ }
+ // Look for python files that belong to the specified workspace folder.
+ workspace.textDocuments.forEach(document => {
+ const wkspaceFolder = workspace.getWorkspaceFolder(document.uri);
+ if (wkspaceFolder && wkspaceFolder.uri.fsPath === wkspaceOrFolder.fsPath) {
+ this.onLintDocument(document, 'auto');
+ }
+ });
  }
 
  // tslint:disable-next-line:member-ordering