Page MenuHomePhorge
Files F2891057

No OneTemporary
Actions

View Options

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 101bf9d..970b074 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,15 +1,16 @@
// Place your settings in this file to overwrite default and user settings.
{
"files.exclude": {
"out": true // set this to true to hide the "out" folder with the compiled JS files
},
"search.exclude": {
"out": true // set this to false to include "out" folder in search results
},
// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
"typescript.tsc.autoDetect": "off",
"cSpell.words": [
+ "Arcanist",
"autofix",
"execa"
]
}
diff --git a/TODO b/TODO
index 1c2e68f..c5f780f 100644
--- a/TODO
+++ b/TODO
@@ -1,31 +1,30 @@
MVP
===
- lint everything
- [v] lint on save
- settings
- max error level
- delete lint on close file
- reasonable code layout
TODO
====
- lint current file
- [v] command clear all issues
-- define type for ArcanistLintMessage
Long Term Desired Features
==========================
- Fancy UIs for
- arc patch
- arc todo
- arc unit
- arc browse
- arc paste (upload and download)
- list open Differential in repo (for review)
- get hovercard (content) for any object
- push notifications from website ?
- preview Remarkup
- some magic to help the External Editor Link
- arc lint: special-case some messages for better visibility (find more range/information.)
- arc lint: support auto-fix (apply diff)
- arc lint: `locations` field may be parsed into `relatedInformation`.
diff --git a/src/arcanist_types.ts b/src/arcanist_types.ts
new file mode 100644
index 0000000..db59f01
--- /dev/null
+++ b/src/arcanist_types.ts
@@ -0,0 +1,26 @@
+/* {
+ "line": 248,
+ "char": 23,
+ "code": "SPELL1",
+ "severity": "warning",
+ "name": "Possible Spelling Mistake",
+ "description": "Possible spelling error. You wrote 'seperator', but did you mean 'separator'?",
+ "original": "Seperator",
+ "replacement": "Separator",
+ "granularity": 1,
+ "locations": [],
+ "bypassChangedLineFiltering": null,
+ "context": " magic = COLOR_RED;\n break;\n case 30:\n // printf(\"Record Seperator\");\n magic = COLOR_BLUE;\n break;\n case 31:"
+} */
+export interface ArcanistLintMessage {
+ line: number;
+ char: number;
+ code: string;
+ severity: string; // could technically be an enum
+ name: string;
+ description?: string;
+ original?: string;
+ replacement?: string;
+ // locations: string[];
+ // context: string;
+}
diff --git a/src/extension.ts b/src/extension.ts
index 6ad7270..4bf84a5 100644
--- a/src/extension.ts
+++ b/src/extension.ts
@@ -1,190 +1,193 @@
import * as vscode from 'vscode';
import * as execa from "execa";
import * as path from "path";
+import { ArcanistLintMessage } from './arcanist_types';
export function activate(context: vscode.ExtensionContext) {
const collection = vscode.languages.createDiagnosticCollection('arc lint');
setupCustomTranslators();
function d(disposable: vscode.Disposable) {
context.subscriptions.push(disposable);
}
d(vscode.commands.registerCommand('arc-vscode.clearLint', () => collection.clear()));
d(vscode.workspace.onDidSaveTextDocument(onTextDocumentEvent));
d(vscode.workspace.onDidOpenTextDocument(onTextDocumentEvent));
if (vscode.window.activeTextEditor) {
lintFile(vscode.window.activeTextEditor.document);
}
d(vscode.window.onDidChangeActiveTextEditor(editor => {
if (editor) {
lintFile(editor.document);
}
}));
function onTextDocumentEvent(document: vscode.TextDocument) {
lintFile(document);
}
function lintFile(document: vscode.TextDocument) {
if (document.uri.scheme != "file") return;
function handleExecResult(value: execa.ExecaReturnValue<string>) {
if (!value.stdout) return;
try {
const lintMessages = JSON.parse(value.stdout);
for (const filename in lintMessages) {
// TODO: This only probably works because we call arc with a single file.
collection.set(document.uri, lintJsonToDiagnostics(lintMessages[filename]));
}
} catch {
logError("ppfff");
}
}
const filename = document.uri.path;
execa(
'arc', ['lint', '--output', 'json', '--', path.basename(filename)],
{ cwd: path.dirname(filename) },
).then(handleExecResult, handleExecResult);
}
}
-export function deactivate() { }
+export function deactivate() {
+ // TODO collection.clear();
+ }
function logError(x: any) {
console.log("this is error", x);
}
-type LintTranslator = (lint: any) => vscode.Diagnostic;
+type LintTranslator = (lint: ArcanistLintMessage) => vscode.Diagnostic;
let customLintTranslator: Map<String, LintTranslator> = new Map();
-function lintJsonToDiagnostics(lintResults: Array<any>): vscode.Diagnostic[] {
+function lintJsonToDiagnostics(lintResults: Array<ArcanistLintMessage>): vscode.Diagnostic[] {
/*
input: Array of:
{
"line": 248,
"char": 23,
"code": "SPELL1",
"severity": "warning",
"name": "Possible Spelling Mistake",
"description": "Possible spelling error. You wrote 'seperator', but did you mean 'separator'?",
"original": "Seperator",
"replacement": "Separator",
"granularity": 1,
"locations": [],
"bypassChangedLineFiltering": null,
"context": " magic = COLOR_RED;\n break;\n case 30:\n // printf(\"Record Seperator\");\n magic = COLOR_BLUE;\n break;\n case 31:"
}
output: array of:
{
code: '',
message: 'cannot assign twice to immutable variable `x`',
range: new vscode.Range(new vscode.Position(3, 4), new vscode.Position(3, 10)),
severity: vscode.DiagnosticSeverity.Error,
source: '',
relatedInformation: [
new vscode.DiagnosticRelatedInformation(new vscode.Location(document.uri, new vscode.Range(new vscode.Position(1, 8), new vscode.Position(1, 9))), 'first assignment to `x`')
]
}
*/
/*
Extra features:
- quick-fix to apply patch
- try to get better message by parsing `description` field (per message code...)
- `locations` may be parsed into `relatedInformation`.
*/
- function translate(lint: any): vscode.Diagnostic {
+ function translate(lint: ArcanistLintMessage): vscode.Diagnostic {
let t = customLintTranslator.get(lint.code) || defaultTranslate;
return t(lint);
}
return lintResults.map(translate);
}
function nonNeg(n: number): number {
return n < 0 ? 0 : n
}
-function defaultTranslate(lint: any): vscode.Diagnostic {
+function defaultTranslate(lint: ArcanistLintMessage): vscode.Diagnostic {
return {
code: lint.code,
message: message(lint),
severity: severity(lint),
source: 'arc lint',
range: new vscode.Range(
lint.line - 1, nonNeg(lint.char - 2), // it's an artificial 3-chars wide thing.
lint.line - 1, lint.char + 1),
};
}
-function message(lint: any) {
+function message(lint: ArcanistLintMessage) {
if (lint.description)
return lint.name + ": " + lint.description
return lint.name
}
-function severity(lint: any): vscode.DiagnosticSeverity {
+function severity(lint: ArcanistLintMessage): vscode.DiagnosticSeverity {
switch (lint.severity as string) {
case 'disabled': return vscode.DiagnosticSeverity.Hint;
case 'autofix': return vscode.DiagnosticSeverity.Hint;
case 'advice': return vscode.DiagnosticSeverity.Information;
case 'warning': return vscode.DiagnosticSeverity.Warning;
case 'error': return vscode.DiagnosticSeverity.Error;
default: return vscode.DiagnosticSeverity.Error;
}
}
function setupCustomTranslators() {
customLintTranslator.set("SPELL1", lint => {
let d = defaultTranslate(lint)
- d.message = lint.description;
- let len = (<String>lint.original).length;
+ d.message = <string>lint.description;
+ let len = (<string>lint.original).length;
if (len > 0) {
d.range = new vscode.Range(
lint.line - 1, nonNeg(lint.char - 1),
lint.line - 1, lint.char + len - 1);
}
return d
});
// "This line is 116 characters long, but the convention is 80 characters."
const re_TXT3_length = /\D(\d+) characters\.$/;
customLintTranslator.set('E501', lint => {
let d = defaultTranslate(lint)
d.range = new vscode.Range(
lint.line - 1, lint.char - 1,
lint.line - 1, 1e9);
return d;
});
customLintTranslator.set('TXT3', lint => {
let d = defaultTranslate(lint)
- let match = lint.description.match(re_TXT3_length);
+ let match = (<string>lint.description).match(re_TXT3_length);
if (match) {
let len = parseInt(match[1]);
d.range = new vscode.Range(
lint.line - 1, len,
lint.line - 1, 1e9);
}
return d;
});
}

File Metadata

Mime Type
text/x-diff
Expires
Sun, Jan 19, 14:32 (3 w, 2 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1119628
Default Alt Text
(8 KB)

Event Timeline

Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0