Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Better error handling & messages when running RuboCop formatting #297

Merged
merged 2 commits into from
Mar 14, 2018
Merged

Better error handling & messages when running RuboCop formatting #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18f6832
Better error handling & messages when running RuboCop
gurgeous Mar 13, 2018
2332a34
run prettier with useTabs
gurgeous Mar 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 143 additions & 54 deletions src/format/RuboCop.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
"use strict";
import * as fs from 'fs';
import * as path from 'path';
'use strict';

import * as cp from 'child_process';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import * as vscode from 'vscode';

// REMIND: move this into own file? seems handy
const findCfg = checkPath => {
try {
fs.accessSync(path.join(checkPath, '.rubocop.yml'));
Expand All @@ -14,69 +17,155 @@ const findCfg = checkPath => {
}
};

//
// Wrapper class around rubocop. AutoCorrect parses options and runs rubocop to
// format documents.
//

export class AutoCorrect {
private exe: string;
private ext: string;

constructor(opts) {
this.exe = "rubocop";
this.ext = process.platform === 'win32' ? ".bat" : "";
this.exe += this.ext;
if (opts.exe) this.exe = opts.exe;
// get options from ruby.lint.rubocop. We have to do this every time because
// options can change while the extension is loaded.
get opts(): any {
const opts: any = vscode.workspace.getConfiguration('ruby.lint.rubocop');
if (!opts || opts === true) {
return {};
}
return opts;
}

// What's the exe name for rubocop?
get exe(): string {
const opts = this.opts;
if (opts.exe) {
return opts.exe;
}
const ext = process.platform === 'win32' ? '.bat' : '';
return `rubocop${ext}`;
}

// Arguments for running rubocop.
//
// REMIND: is this useful? Might be better to just allow
// ruby.lint.rubocop = { args : "xxx" }
args = (root: string): string[] => {
let args = ['-a', '-f', 'simple'];
if (root) {
const cfgPath = findCfg(root);
if (cfgPath) {
args = args.concat(['-c', path.join(cfgPath, '.rubocop.yml')]);
}
}

const opts = this.opts;
if (opts.lint) {
args.push('-l');
}
if (opts.only) {
args = args.concat('--only', opts.only.join(','));
}
if (opts.except) {
args = args.concat('--except', opts.except.join(','));
}
if (opts.rails) {
args.push('-R');
}
if (opts.require) {
args = args.concat('-r', opts.require.join(','));
}

return args;
};

//
// Is rubocop ready to run? Really important to have decent error messages
// here to make it easier for users to debug config issues.
//

public test(): Promise<any> {
return new Promise((resolve, reject) => {
const rubo = cp.spawn(this.exe, ['-v']);
let rejected = false;
rubo.on("error", () => {
rejected = true;
reject();
rubo.on('error', err => {
if (err.message.includes('ENOENT')) {
vscode.window.showErrorMessage(`couldn't find ${this.exe} for formatting (ENOENT)`);
} else {
vscode.window.showErrorMessage(`couldn't run ${this.exe} '${err.message}'`);
}
reject(err);
});

rubo.stderr.on('data', data => {
// for debugging
console.log(`rubocop stderr ${data}`);
});
rubo.on("exit", e => {
if (rejected) return;
if (e) return reject();

rubo.on('exit', code => {
if (code) {
vscode.window.showErrorMessage(`rubocop failed with code=${code}`);
return reject();
}

// success!
console.log(`rubocop is ready to go!`);
resolve();
});
});
}

public correct(data, root, opts): Promise<string> {
// we get opts again here, incase it has changed
let cfgPath;
let exe = "rubocop" + this.ext;
let args = ["-a", "-f", "simple"];
if (root) cfgPath = findCfg(root);
if (cfgPath) args = args.concat(["-c", path.join(cfgPath, '.rubocop.yml')]);
if (opts.exe) exe = opts.exe;
if (opts.lint) args.push("-l");
if (opts.only) args = args.concat("--only", opts.only.join(','));
if (opts.except) args = args.concat("--except", opts.except.join(','));
if (opts.rails) args.push('-R');
if (opts.require) args = args.concat("-r", opts.require.join(','));
return new Promise((resolve, reject) => fs.mkdtemp(path.join(os.tmpdir(), 'rubocop'), (err, folder) => {
if (err) return reject(err);
let file = path.join(folder, 'tmp.rb');
args.push(file);
fs.writeFile(file, data, err => {
if (err) return reject(err);
const rubo = cp.spawn(exe, args, {
cwd: root || process.cwd(),
env: process.env
});
let rejected = false;
rubo.on("exit", (e) => {
if (rejected) return;
fs.readFile(file, 'utf8', (err, result) => {
if (err) reject(err);
resolve(result);
//
// format!
//
// Write to a temp file, format the file, then return the result.
//

public correct(data, root): Promise<string> {
return new Promise((resolve, reject) =>
fs.mkdtemp(path.join(os.tmpdir(), 'rubocop'), (err, folder) => {
if (err) return reject(err); // not common

const args = this.args(root);

const tmpfile = path.join(folder, 'tmp.rb');
args.push(tmpfile);

fs.writeFile(tmpfile, data, err => {
if (err) return reject(err); // not common

console.log(`${this.exe} ${args.join(' ')}`);

const startTm = new Date().getTime();
const rubo = cp.spawn(this.exe, args, {
cwd: root || process.cwd(),
env: process.env,
});

rubo.on('error', error => {
vscode.window.showErrorMessage(`couldn't run rubocop '${error.message}'`);
reject(error);
});

rubo.stderr.on('data', data => {
// for debugging
console.log(`rubocop stderr ${data}`);
});

rubo.on('exit', code => {
// https://github.com/bbatsov/rubocop/blob/master/manual/basic_usage.md
if (code && code !== 1) {
vscode.window.showErrorMessage(`rubocop failed with code=${code}`);
return reject();
}

fs.readFile(tmpfile, 'utf8', (err, result) => {
if (err) reject(err); // not common

// success!
const elapsedTm = new Date().getTime() - startTm;
console.log(`rubocop ran in ${elapsedTm}ms`);
resolve(result);
});
});
});
rubo.on("error", e => {
rejected = true;
reject(e);
});
});
}));
})
);
}
}
}
9 changes: 2 additions & 7 deletions src/format/rubyFormat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export class RubyDocumentFormattingEditProvider implements vscode.DocumentFormat
private autoCorrect: AutoCorrect;

constructor() {
this.autoCorrect = new AutoCorrect(vscode.workspace.getConfiguration("ruby").get("lint.rubocop") || {});
this.autoCorrect = new AutoCorrect();
}

public register(ctx: vscode.ExtensionContext) {
Expand All @@ -20,14 +20,9 @@ export class RubyDocumentFormattingEditProvider implements vscode.DocumentFormat
}

public provideDocumentFormattingEdits(document: vscode.TextDocument, options: vscode.FormattingOptions, token: vscode.CancellationToken): Thenable<vscode.TextEdit[]> {
let opts: any = vscode.workspace.getConfiguration("ruby.lint.rubocop");
if (!opts || opts === true) {
opts = {};
}

const root = document.fileName ? path.dirname(document.fileName) : vscode.workspace.rootPath;
const input = document.getText();
return this.autoCorrect.correct(input, root, opts)
return this.autoCorrect.correct(input, root)
.then(
result => {
return [new vscode.TextEdit(document.validateRange(new vscode.Range(0, 0, Infinity, Infinity)), result)];
Expand Down