add diagnostic & code actions features

Author: waseemdev

README.md

@@ -49,7 +49,7 @@ Extension features:
 * Generates localization code depending on json files.
 * Forms & animation made easy.
 * Customizable! so developers can add their own properties and modify some features.
-* Supports Code completion, hover information, Go to Definition.
+* Supports Code completion, hover information, Go to Definition, diagnostics and code actions.
 
 # Get Started
 

src/dart/extension/providers/dart_completion_item_provider.ts

@@ -37,7 +37,7 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 			allResults = (await this.getTagNameCompletions(document, position, token)).concat(this.getClosingTagNameCompletions(document, position));
 		}
 		else if (isAttributeValue(document, position)) {
-			allResults = this.getAttributeValueCompletions(document, position, token);
+			allResults = await this.getAttributeValueCompletions(document, position, token);
 		}
 		else if (isAttribute(document, position)) {
 			allResults = await this.getAttributeCompletions(document, position, token);
@@ -129,9 +129,26 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 		return await this.getAttributeCompletionsForElement(tag, false, document, position, token);
 	}
 
+	private hasUnnamedArgs(tag: string): boolean {
+		return tag === 'Text';
+	}
+
+	private getUnnamedArgsRange(tag: string, dartDocument: TextDocument, offset: number): number {
+		const dart = dartDocument.getText();
+		offset = dart.indexOf(' ' + tag + '(', offset - tag.length - 4);
+		const pos = dartDocument.positionAt(offset).translate({ lineDelta: 1, characterDelta: 200 });
+		offset = dartDocument.offsetAt(pos);
+		return offset;
+	}
+
 	private async getAttributeCompletionsForElement(elementTag: string, isTag: boolean, xmlDocument: TextDocument, xmlPosition: Position, token: CancellationToken): Promise<CompletionItem[]> {
 		const dartDocument = await getDartDocument(xmlDocument);
-		const dartOffset = await getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, null);
+		const hasUnnamedArgs = this.hasUnnamedArgs(elementTag);
+		const wordRange = xmlDocument.getWordRangeAtPosition(xmlPosition);
+		let dartOffset = getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange, false, !!elementTag, hasUnnamedArgs);
+		if (hasUnnamedArgs) {
+			dartOffset = this.getUnnamedArgsRange(elementTag, dartDocument, dartOffset);
+		}
 
 		const line = xmlDocument.lineAt(xmlPosition.line).text.slice(0, xmlPosition.character);
 		const nextCharacter = xmlDocument.getText(new Range(xmlPosition, xmlPosition.translate({ characterDelta: 200 }))).trim().substr(0, 1);
@@ -143,13 +160,8 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 			offset: dartOffset,
 		});
 
-		// get used attributes
-		// todo
-		const currentUsedAttributes: string[] = [];
-
 		// map results
 		const includedResults = resp.results
-			.filter((a: any) => currentUsedAttributes.indexOf(a.displayText || a.completion) === -1)
 			.map((r: any) => {
 				const a = this.convertResult(xmlDocument, nextCharacter, enableCommitCharacters, insertArgumentPlaceholders, resp, r);
 				const item = new vs.CompletionItem(a.label.replace(':', ''), a.kind);
@@ -168,7 +180,7 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 			});
 
 		const cachedResults = await this.getCachedResults(xmlDocument, token, nextCharacter, enableCommitCharacters, insertArgumentPlaceholders, xmlDocument.offsetAt(xmlPosition), resp);
-		return [...includedResults, ...cachedResults, ...(isTag ? this.getWrapperPropertiesElementsCompletionItems(xmlDocument, xmlPosition) : this.getWrapperPropertiesCompletionItems(xmlDocument, xmlPosition))];
+		return [...includedResults, ...(cachedResults && cachedResults.length ? cachedResults : []), ...(isTag ? this.getWrapperPropertiesElementsCompletionItems(xmlDocument, xmlPosition) : this.getWrapperPropertiesCompletionItems(xmlDocument, xmlPosition))];
 	}
 
 	private getAttributeCompletionsForAttribute(elementTag: string, document: TextDocument, position: Position): vs.CompletionItem[] {
@@ -267,13 +279,13 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 		return item;
 	}
 
-	private getAttributeValueCompletions(document: TextDocument, position: Position, token: CancellationToken): CompletionItem[] {
-		const completions: CompletionItem[] = [];
-
+	private async getAttributeValueCompletions(xmlDocument: TextDocument, xmlPosition: Position, token: CancellationToken): Promise<CompletionItem[]> {
 		// Get the attribute name
-		const wordRange = document.getWordRangeAtPosition(position);
-		const wordStart = wordRange ? wordRange.start : position;
-		const line = document.getText(new Range(wordStart.line, 0, wordStart.line, wordStart.character));
+		const wordRange = xmlDocument.getWordRangeAtPosition(xmlPosition);
+		const wordStart = wordRange ? wordRange.start : xmlPosition;
+		const wordEnd = wordRange ? wordRange.end : xmlPosition;
+		const lineRange = new Range(wordStart.line, 0, wordStart.line, wordEnd.character);
+		const line = xmlDocument.getText(lineRange);
 		const attrNamePattern = /[\.\-:_a-zA-Z0-9]+=/g;
 		const match = line.match(attrNamePattern);
 
@@ -285,7 +297,7 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 		attrName = attrName.slice(0, -1);
 
 		// Get the XPath
-		const xPath = getXPath(document, position);
+		const xPath = getXPath(xmlDocument, xmlPosition);
 		const isTopLevelElement = xPath.length === 1;
 		const isSecondLevelElement = xPath.length === 2;
 
@@ -300,15 +312,37 @@ export class DartCompletionItemProvider implements CompletionItemProvider, IAmDi
 			}
 		}
 
-		// todo
-		const children: any[] = [];
+		const dartDocument = await getDartDocument(xmlDocument);
+		let attrValue = xmlDocument.getText(new Range(new Position(xmlPosition.line, 0), xmlPosition.translate({ characterDelta: 200 })));
+		let endIndex = attrValue.indexOf('" ');
+		endIndex = endIndex === -1 ? attrValue.indexOf('">') : endIndex;
+		attrValue = attrValue.substring(attrValue.indexOf(attrName + '="') + attrName.length + 2, endIndex);
+		const cursorPos = line.substr(line.lastIndexOf(attrName + '="') + 2).length - attrName.length - Math.abs(wordEnd.character - xmlPosition.character);
+		const dartOffset = dartDocument.getText().indexOf(attrName + ': ' + attrValue) + attrName.length + 2 + cursorPos;
+		const nextCharacter = xmlDocument.getText(new Range(xmlPosition, xmlPosition.translate({ characterDelta: 200 }))).trim().substr(0, 1);
+		const conf = config.for(xmlDocument.uri);
+		const enableCommitCharacters = conf.enableCompletionCommitCharacters;
+		const insertArgumentPlaceholders = !enableCommitCharacters && conf.insertArgumentPlaceholders && this.shouldAllowArgPlaceholders(line);
 
-		// Apply a filter with the current prefix and return.
-		children.forEach((child: any) => {
-			const suggestion = new CompletionItem(child.displayText);
-			suggestion.detail = child.rightLabel;
-			completions.push(suggestion);
+		const resp = await this.analyzer.completionGetSuggestionsResults({
+			file: fsPath(dartDocument.uri),
+			offset: dartOffset,
 		});
+		
+		// todo
+		const completions: CompletionItem[] = resp.results
+			.map((r: any) => {
+				const a = this.convertResult(xmlDocument, nextCharacter, enableCommitCharacters, insertArgumentPlaceholders, resp, r);
+				const item = new vs.CompletionItem(a.label.replace(':', ''), a.kind);
+				(item as any)._documentation = (a as any)._documentation;
+				// item.insertText = new SnippetString(item.label + '>$0</' + item.label + '>');
+				// item.insertText = new SnippetString(item.label + '>$0');
+				// item.insertText = new SnippetString(item.label + '="$0"');
+				item.detail = a.detail;
+				item.filterText = a.filterText;
+				item.sortText = a.sortText;
+				return item;
+			});
 
 		return completions;
 	}

src/dart/extension/providers/dart_diagnostic_provider.ts

@@ -0,0 +1,116 @@
+import { Diagnostic, DiagnosticCollection, DiagnosticSeverity, DiagnosticTag, Uri, TextDocument, workspace } from "vscode";
+import * as as from "../../shared/analysis_server_types";
+// import { Analyzer } from "../analysis/analyzer";
+import { config } from "../config";
+import { toRangeOnLine } from "../utils";
+import * as fs from 'fs';
+import { denodeify } from 'q';
+import { getXmlCodeWordLocation } from "../../utils";
+// const readFileSync = denodeify(fs.readFileSync);
+
+// TODO: This is not a provider?
+export class DartDiagnosticProvider {
+	private lastErrorJson: string | undefined;
+	constructor(private readonly analyzer: any, private readonly diagnostics: DiagnosticCollection) {
+		this.analyzer.registerForAnalysisErrors((es: any) => this.handleErrors(es));
+
+		// Fired when files are deleted
+		this.analyzer.registerForAnalysisFlushResults((es: any) => this.flushResults(es));
+	}
+
+	private async handleErrors(notification: as.AnalysisErrorsNotification) {
+		const notificationJson = JSON.stringify(notification);
+
+		// As a workaround for https://github.com/Dart-Code/Dart-Code/issues/1678, if
+		// the errors we got are exactly the same as the previous set, do not give
+		// them to VS Code. This avoids a potential loop of refreshing the error view
+		// which triggers a request for Code Actions, which could result in analysis
+		// of the file (which triggers errors to be sent, which triggers a refresh
+		// of the error view... etc.!).
+		if (this.lastErrorJson === notificationJson) {
+			// TODO: Come up with a better fix than this!
+			// log("Skipping error notification as it was the same as the previous one");
+			return;
+		}
+
+		const errors = notification.errors.filter((error) => error.severity === 'ERROR');
+		if (errors.length) {
+			const dartCode = fs.readFileSync(notification.file).toString();
+			const file = notification.file.replace('.xml.dart', '.xml');
+			const xmlDocument = await workspace.openTextDocument(Uri.file(file));
+			const allMessages: string[] = [];
+			const mappedErrors = errors
+				.map((e) => DartDiagnosticProvider.createDiagnostic(dartCode, xmlDocument, e))
+				.filter(a => {
+					// remove duplicated diagnostics
+					const res = !allMessages.find(m => m === a.message);
+					if (res) {
+						allMessages.push(a.message);
+					}
+					return res;
+				});
+			this.diagnostics.set(
+				Uri.file(file),
+				mappedErrors
+			);
+		}
+		else {
+			const file = notification.file.replace('.xml.dart', '.xml');
+			this.diagnostics.set(Uri.file(file), []);
+		}
+
+		this.lastErrorJson = notificationJson;
+	}
+
+	public static createDiagnostic(dartCode: string, xmlDocument: TextDocument, error: as.AnalysisError): Diagnostic {
+		const xmlWordRange = getXmlCodeWordLocation(xmlDocument, dartCode, error.location);
+		const diag = new DartDiagnostic(
+			xmlWordRange,
+			error.message,
+			DartDiagnosticProvider.getSeverity(error.severity, error.type),
+		);
+		diag.code = error.code;
+		diag.source = "dart";
+		diag.tags = DartDiagnosticProvider.getTags(error);
+		diag.type = error.type;
+		if (error.correction) {
+			diag.message += `\n${error.correction}`;
+		}
+		return diag;
+	}
+
+	public static getSeverity(severity: as.AnalysisErrorSeverity, type: as.AnalysisErrorType): DiagnosticSeverity {
+		switch (severity) {
+			case "ERROR":
+				return DiagnosticSeverity.Error;
+			case "WARNING":
+				return DiagnosticSeverity.Warning;
+			case "INFO":
+				switch (type) {
+					case "TODO":
+						return DiagnosticSeverity.Information; // https://github.com/Microsoft/vscode/issues/48376
+					default:
+						return DiagnosticSeverity.Information;
+				}
+			default:
+				throw new Error("Unknown severity type: " + severity);
+		}
+	}
+
+	public static getTags(error: as.AnalysisError): DiagnosticTag[] {
+		const tags: DiagnosticTag[] = [];
+		if (error.code === "dead_code" || error.code === "unused_local_variable" || error.code === "unused_import")
+			tags.push(DiagnosticTag.Unnecessary);
+		return tags;
+	}
+
+	private flushResults(notification: as.AnalysisFlushResultsNotification) {
+		this.lastErrorJson = undefined;
+		const entries = notification.files.map<[Uri, Diagnostic[]]>((file) => [Uri.file(file), undefined]);
+		this.diagnostics.set(entries);
+	}
+}
+
+export class DartDiagnostic extends Diagnostic {
+	public type: string;
+}

src/dart/extension/providers/dart_hover_provider.ts

@@ -18,7 +18,7 @@ export class DartHoverProvider implements HoverProvider {
 			}
 
 			const dartDocument = await getDartDocument(xmlDocument);
-			const dartOffset = await getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange, true);
+			const dartOffset = getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange, true);
 
 			if (dartOffset < 0) {
 				return;

src/dart/extension/providers/dart_reference_provider.ts

@@ -16,7 +16,7 @@ export class DartReferenceProvider implements ReferenceProvider, DefinitionProvi
 		}
 
 		const dartDocument = await getDartDocument(xmlDocument);
-		const dartOffset = await getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange);
+		const dartOffset = getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange);
 		let dartPosition = null;
 
 		if (dartOffset < 0) {
@@ -57,7 +57,7 @@ export class DartReferenceProvider implements ReferenceProvider, DefinitionProvi
 		}
 
 		const dartDocument = await getDartDocument(xmlDocument);
-		const dartOffset = await getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange);
+		const dartOffset = getDartCodeIndex(xmlDocument, xmlPosition, dartDocument, wordRange);
 
 		const resp = await this.analyzer.analysisGetNavigation({
 			file: fsPath(dartDocument.uri),
@@ -76,10 +76,17 @@ export class DartReferenceProvider implements ReferenceProvider, DefinitionProvi
 				if (target.startColumn === 0)
 					target.startColumn = 1;
 
+				let file = resp.files[target.fileIndex];
+				if (file.endsWith('.xml.dart')) {
+					file = file.replace('.xml.dart', '.xml');
+					target.startColumn = 1;
+					target.startLine = 1;
+				}
+
 				return {
 					originSelectionRange: util.toRange(dartDocument, region.offset, region.length),
 					targetRange: util.toRangeOnLine(target),
-					targetUri: Uri.file(resp.files[target.fileIndex]),
+					targetUri: Uri.file(file),
 				} as DefinitionLink;
 			});
 		});

src/dart/extension/providers/fix_code_action_provider.ts

@@ -0,0 +1,93 @@
+import { CancellationToken, CodeAction, CodeActionContext, CodeActionKind, CodeActionProviderMetadata, DocumentSelector, Range, TextDocument } from "vscode";
+import * as as from "../../shared/analysis_server_types";
+import { Logger } from "../../shared/interfaces";
+import { fsPath } from "../../shared/vscode/utils";
+import { isAnalyzableAndInWorkspace } from "../utils";
+import { RankedCodeActionProvider } from "./ranking_code_action_provider";
+import { getDartDocument, getDartCodeWordIndex } from "../../utils";
+
+export class FixCodeActionProvider implements RankedCodeActionProvider {
+	constructor(private readonly logger: Logger, public readonly selector: DocumentSelector, private readonly analyzer: any) { }
+
+	public readonly rank = 1;
+
+	public readonly metadata: CodeActionProviderMetadata = {
+		providedCodeActionKinds: [CodeActionKind.QuickFix],
+	};
+
+	public async provideCodeActions(xmlDocument: TextDocument, xmlRange: Range, context: CodeActionContext, token: CancellationToken): Promise<CodeAction[] | undefined> {
+		const dartDocument = await getDartDocument(xmlDocument);
+		const dartOffset = await getDartCodeWordIndex(xmlDocument, dartDocument, xmlDocument.getWordRangeAtPosition(xmlRange.start));
+		if (dartOffset === -1) {
+			return undefined;
+		}
+		
+		const rangeStart = dartDocument.positionAt(dartOffset);
+
+		if (!isAnalyzableAndInWorkspace(dartDocument)) {
+			return undefined;
+		}
+
+		// If we were only asked for specific action types and that doesn't include
+		// quickfix (which is all we supply), bail out.
+		if (context && context.only && !context.only.contains(CodeActionKind.QuickFix)) {
+			return undefined;
+		}
+
+		try {
+			const result = await this.analyzer.editGetFixes({
+				file: fsPath(dartDocument.uri),
+				offset: dartDocument.offsetAt(rangeStart),
+			});
+
+			if (token && token.isCancellationRequested) {
+				return;
+			}
+
+			// Because fixes may be the same for multiple errors, we'll de-dupe them based on their edit.
+			const allActions: { [key: string]: CodeAction } = {};
+
+			for (const errorFix of result.fixes) {
+				for (const fix of errorFix.fixes) {
+					allActions[JSON.stringify(fix.edits)] = this.convertResult(xmlDocument, fix, errorFix.error);
+				}
+			}
+
+			return Object.keys(allActions).map((a) => allActions[a]).filter(a => !!a);
+		}
+		catch (e) {
+			this.logger.error(e);
+			throw e;
+		}
+	}
+
+	private convertResult(document: TextDocument, change: as.SourceChange, error: as.AnalysisError): CodeAction {
+		const title = change.message;
+		
+		if (title.startsWith('Import library')) {
+			this.buildImportNamespace(document, change);
+		}
+		else {
+			return null;
+		}
+
+		// const diagnostics = error ? [DartDiagnosticProvider.createDiagnostic(error)] : undefined;
+		const action = new CodeAction(title, CodeActionKind.QuickFix);
+		action.command = {
+			arguments: [document, change],
+			command: "_dart.applySourceChange",
+			title,
+		};
+		// action.diagnostics = diagnostics;
+		return action;
+	}
+
+	private buildImportNamespace(document: TextDocument, change: as.SourceChange) {
+		change.edits[0].edits[0].offset = document.getText().indexOf('>');
+		change.edits[0].file = change.edits[0].file.replace('.xml.dart', '.xml');
+		let replacement = change.edits[0].edits[0].replacement;
+		replacement = replacement.substring(9, replacement.length - 2);
+		const namespace = replacement.substring(replacement.lastIndexOf('/') + 1).replace('.dart', '').toLowerCase();
+		change.edits[0].edits[0].replacement = '\n\txmlns:' + namespace + '="' + replacement + '"';
+	}
+}