linter issues (if errors, promise wasn't resolved)

Author: DonJayamanne

src/client/linters/baseLinter.ts

@@ -6,26 +6,26 @@ import {execPythonFile} from './../common/utils';
 import * as settings from './../common/configSettings';
 import {OutputChannel, window} from 'vscode';
 
-var NamedRegexp = null;
+let NamedRegexp = null;
 const REGEX = '(?<line>\\d+),(?<column>\\d+),(?<type>\\w+),(?<code>\\w\\d+):(?<message>.*)\\r?(\\n|$)';
 
 export interface IRegexGroup {
- line: number
- column: number
- code: string
- message: string
- type: string
+ line: number;
+ column: number;
+ code: string;
+ message: string;
+ type: string;
 }
 
 export interface ILintMessage {
- line: number
- column: number
- code: string
- message: string
- type: string
- possibleWord?: string
- severity?: LintMessageSeverity
- provider: string
+ line: number;
+ column: number;
+ code: string;
+ message: string;
+ type: string;
+ possibleWord?: string;
+ severity?: LintMessageSeverity;
+ provider: string;
 }
 export enum LintMessageSeverity {
  Hint,
@@ -39,10 +39,10 @@ export function matchNamedRegEx(data, regex): IRegexGroup {
  NamedRegexp = require('named-js-regexp');
  }
 
- var compiledRegexp = NamedRegexp(regex, 'g');
- var rawMatch = compiledRegexp.exec(data);
+ let compiledRegexp = NamedRegexp(regex, 'g');
+ let rawMatch = compiledRegexp.exec(data);
  if (rawMatch !== null) {
- return <IRegexGroup>rawMatch.groups()
+ return <IRegexGroup>rawMatch.groups();
  }
 
  return null;
@@ -59,17 +59,17 @@ export abstract class BaseLinter {
  public abstract runLinter(filePath: string, txtDocumentLines: string[]): Promise<ILintMessage[]>;
 
  protected run(command: string, args: string[], filePath: string, txtDocumentLines: string[], cwd: string, regEx: string = REGEX): Promise<ILintMessage[]> {
- var outputChannel = this.outputChannel;
- var linterId = this.Id;
+ let outputChannel = this.outputChannel;
+ let linterId = this.Id;
 
  return new Promise<ILintMessage[]>((resolve, reject) => {
  execPythonFile(command, args, cwd, true).then(data => {
  outputChannel.append('#'.repeat(10) + 'Linting Output - ' + this.Id + '#'.repeat(10) + '\n');
  outputChannel.append(data);
- var outputLines = data.split(/\r?\n/g);
- var diagnostics: ILintMessage[] = [];
+ let outputLines = data.split(/\r?\n/g);
+ let diagnostics: ILintMessage[] = [];
  outputLines.filter((value, index) => index <= this.pythonSettings.linting.maxNumberOfProblems).forEach(line => {
- var match = matchNamedRegEx(line, regEx);
+ let match = matchNamedRegEx(line, regEx);
  if (match == null) {
  return;
  }
@@ -78,13 +78,13 @@ export abstract class BaseLinter {
  match.line = Number(<any>match.line);
  match.column = Number(<any>match.column);
 
- var sourceLine = txtDocumentLines[match.line - 1];
- var sourceStart = sourceLine.substring(match.column - 1);
- var endCol = txtDocumentLines[match.line - 1].length;
+ let sourceLine = txtDocumentLines[match.line - 1];
+ let sourceStart = sourceLine.substring(match.column - 1);
+ let endCol = txtDocumentLines[match.line - 1].length;
 
- //try to get the first word from the startig position
- var possibleProblemWords = sourceStart.match(/\w+/g);
- var possibleWord: string;
+ // try to get the first word from the startig position
+ let possibleProblemWords = sourceStart.match(/\w+/g);
+ let possibleWord: string;
  if (possibleProblemWords != null && possibleProblemWords.length > 0 && sourceStart.startsWith(possibleProblemWords[0])) {
  possibleWord = possibleProblemWords[0];
  }
@@ -100,16 +100,16 @@ export abstract class BaseLinter {
  });
  }
  catch (ex) {
- //Hmm, need to handle this later
- //TODO:
- var y = '';
+ // Hmm, need to handle this later
+ // TODO:
+ let y = '';
  }
  });
 
  resolve(diagnostics);
  }).catch(error => {
  this.handleError(this.Id, command, error);
- return [];
+ resolve([]);
  });
  });
  }

src/client/linters/flake8.ts

@@ -5,7 +5,7 @@ import * as baseLinter from './baseLinter';
 import {OutputChannel, workspace} from 'vscode';
 export class Linter extends baseLinter.BaseLinter {
  constructor(outputChannel: OutputChannel, workspaceRootPath: string) {
- super("flake8", outputChannel, workspaceRootPath);
+ super('flake8', outputChannel, workspaceRootPath);
  }
 
  public isEnabled(): Boolean {
@@ -16,11 +16,11 @@ export class Linter extends baseLinter.BaseLinter {
  return Promise.resolve([]);
  }
 
- var flake8Path = this.pythonSettings.linting.flake8Path;
+ let flake8Path = this.pythonSettings.linting.flake8Path;
  let flake8Args = Array.isArray(this.pythonSettings.linting.flake8Args) ? this.pythonSettings.linting.flake8Args : [];
  return new Promise<baseLinter.ILintMessage[]>((resolve, reject) => {
- this.run(flake8Path, flake8Args.concat(["--format=%(row)d,%(col)d,%(code)s,%(code)s:%(text)s", filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
- //All messages in pep8 are treated as warnings for now
+ this.run(flake8Path, flake8Args.concat(['--format=%(row)d,%(col)d,%(code)s,%(code)s:%(text)s', filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
+ // All messages in pep8 are treated as warnings for now
  messages.forEach(msg => {
  msg.severity = baseLinter.LintMessageSeverity.Information;
  });

src/client/linters/pep8Linter.ts

@@ -6,7 +6,7 @@ import {OutputChannel, workspace} from 'vscode';
 
 export class Linter extends baseLinter.BaseLinter {
  constructor(outputChannel: OutputChannel, workspaceRootPath: string) {
- super("pep8", outputChannel, workspaceRootPath);
+ super('pep8', outputChannel, workspaceRootPath);
  }
 
  public isEnabled(): Boolean {
@@ -17,11 +17,11 @@ export class Linter extends baseLinter.BaseLinter {
  return Promise.resolve([]);
  }
 
- var pep8Path = this.pythonSettings.linting.pep8Path;
+ let pep8Path = this.pythonSettings.linting.pep8Path;
  let pep8Args = Array.isArray(this.pythonSettings.linting.pep8Args) ? this.pythonSettings.linting.pep8Args : [];
  return new Promise<baseLinter.ILintMessage[]>(resolve => {
- this.run(pep8Path, pep8Args.concat(["--format=%(row)d,%(col)d,%(code)s,%(code)s:%(text)s", filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
- //All messages in pep8 are treated as warnings for now
+ this.run(pep8Path, pep8Args.concat(['--format=%(row)d,%(col)d,%(code)s,%(code)s:%(text)s', filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
+ // All messages in pep8 are treated as warnings for now
  messages.forEach(msg => {
  msg.severity = baseLinter.LintMessageSeverity.Information;
  });

src/client/linters/prospector.ts

@@ -9,9 +9,9 @@ interface IProspectorResponse {
  messages: IProspectorMessage[];
 }
 interface IProspectorMessage {
- source: "string";
- message: "string";
- code: "string";
+ source: string;
+ message: string;
+ code: string;
  location: IProspectorLocation;
 }
 interface IProspectorLocation {
@@ -78,7 +78,7 @@ export class Linter extends baseLinter.BaseLinter {
  resolve(diagnostics);
  }).catch(error => {
  this.handleError(this.Id, prospectorPath, error);
- return [];
+ resolve([]);
  });
  });
  }

src/client/linters/pydocstyle.ts

@@ -20,11 +20,11 @@ export class Linter extends baseLinter.BaseLinter {
  return Promise.resolve([]);
  }
 
- var pydocStylePath = this.pythonSettings.linting.pydocStylePath;
+ let pydocStylePath = this.pythonSettings.linting.pydocStylePath;
  let pydocstyleArgs = Array.isArray(this.pythonSettings.linting.pydocstleArgs) ? this.pythonSettings.linting.pydocstleArgs : [];
  return new Promise<baseLinter.ILintMessage[]>(resolve => {
  this.run(pydocStylePath, pydocstyleArgs.concat([filePath]), filePath, txtDocumentLines).then(messages => {
- //All messages in pep8 are treated as warnings for now
+ // All messages in pep8 are treated as warnings for now
  messages.forEach(msg => {
  msg.severity = baseLinter.LintMessageSeverity.Information;
  });
@@ -35,21 +35,21 @@ export class Linter extends baseLinter.BaseLinter {
  }
 
  protected run(commandLine: string, args: string[], filePath: string, txtDocumentLines: string[]): Promise<ILintMessage[]> {
- var outputChannel = this.outputChannel;
- var linterId = this.Id;
+ let outputChannel = this.outputChannel;
+ let linterId = this.Id;
 
  return new Promise<ILintMessage[]>((resolve, reject) => {
- var fileDir = path.dirname(filePath);
+ let fileDir = path.dirname(filePath);
  execPythonFile(commandLine, args, this.workspaceRootPath, true).then(data => {
  outputChannel.append('#'.repeat(10) + 'Linting Output - ' + this.Id + '#'.repeat(10) + '\n');
  outputChannel.append(data);
- var outputLines = data.split(/\r?\n/g);
- var diagnostics: ILintMessage[] = [];
- var baseFileName = path.basename(filePath);
+ let outputLines = data.split(/\r?\n/g);
+ let diagnostics: ILintMessage[] = [];
+ let baseFileName = path.basename(filePath);
 
  // Remember, the first line of the response contains the file name and line number, the next line contains the error message
  // So we have two lines per message, hence we need to take lines in pairs
- var maxLines = this.pythonSettings.linting.maxNumberOfProblems * 2;
+ let maxLines = this.pythonSettings.linting.maxNumberOfProblems * 2;
  // First line is almost always empty
  let oldOutputLines = outputLines.filter(line => line.length > 0);
  outputLines = [];
@@ -85,14 +85,14 @@ export class Linter extends baseLinter.BaseLinter {
  });
  }
  catch (ex) {
- //Hmm, need to handle this later
- var y = '';
+ // Hmm, need to handle this later
+ let y = '';
  }
  });
  resolve(diagnostics);
  }, error => {
  this.handleError(this.Id, commandLine, error);
- return [];
+ resolve([]);
  });
  });
  }

src/client/linters/pylint.ts

@@ -6,20 +6,20 @@ import {OutputChannel, workspace} from 'vscode';
 
 export class Linter extends baseLinter.BaseLinter {
  constructor(outputChannel: OutputChannel, workspaceRootPath: string) {
- super("pylint", outputChannel, workspaceRootPath);
+ super('pylint', outputChannel, workspaceRootPath);
  }
 
  private parseMessagesSeverity(category: string): baseLinter.LintMessageSeverity {
  if (this.pythonSettings.linting.pylintCategorySeverity[category]) {
  let severityName = this.pythonSettings.linting.pylintCategorySeverity[category];
  switch (severityName) {
- case "Error":
+ case 'Error':
  return baseLinter.LintMessageSeverity.Error;
- case "Hint":
+ case 'Hint':
  return baseLinter.LintMessageSeverity.Hint;
- case "Information":
+ case 'Information':
  return baseLinter.LintMessageSeverity.Information;
- case "Warning":
+ case 'Warning':
  return baseLinter.LintMessageSeverity.Warning;
  default: {
  if (baseLinter.LintMessageSeverity[severityName]) {
@@ -43,7 +43,7 @@ export class Linter extends baseLinter.BaseLinter {
  let pylintPath = this.pythonSettings.linting.pylintPath;
  let pylintArgs = Array.isArray(this.pythonSettings.linting.pylintArgs) ? this.pythonSettings.linting.pylintArgs : [];
  return new Promise<baseLinter.ILintMessage[]>((resolve, reject) => {
- this.run(pylintPath, pylintArgs.concat(["--msg-template='{line},{column},{category},{msg_id}:{msg}'", "--reports=n", "--output-format=text", filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
+ this.run(pylintPath, pylintArgs.concat(['--msg-template=\'{line},{column},{category},{msg_id}:{msg}\'', '--reports=n', '--output-format=text', filePath]), filePath, txtDocumentLines, this.workspaceRootPath).then(messages => {
  messages.forEach(msg => {
  msg.severity = this.parseMessagesSeverity(msg.type);
  });