Skip to content

[Repo Assist] fix: replace console.group/time with VS Code OutputChannel for debug logging #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[Repo Assist] fix: replace console.group/time with VS Code OutputChannel for debug logging #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 22 additions & 22 deletions extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,19 @@ const { findFiles } = require("./lib/utils");
const TmpDir = os.tmpdir();

class PHPCBF {
constructor() {
constructor(outputChannel) {
this.outputChannel = outputChannel;
this.loadSettings();
}

_debugLog(message) {
if (this.outputChannel) {
this.outputChannel.appendLine(message);
} else {
console.log(message);
}
}

loadSettings(uri) {
// Use the provided URI (e.g. the document being formatted), fall back to
// the active editor, or null (global settings) if neither is available.
Expand Down Expand Up @@ -96,10 +105,7 @@ class PHPCBF {
args.push("--standard=" + this.standard);
}
if (this.debug) {
console.group("PHPCBF");
console.log(
"PHPCBF args: " + this.executablePath + " " + args.join(" ")
);
this._debugLog("PHPCBF args: " + this.executablePath + " " + args.join(" "));
}
return args;
}
Expand Down Expand Up @@ -133,11 +139,10 @@ class PHPCBF {
this.loadSettings(document.uri);

if (this.debug) {
console.time("phpcbf");
this._debugStart = Date.now();
}
let text = document.getText();

let phpcbfError = false;
let fileName =
TmpDir +
"/temp-" +
Expand All @@ -156,7 +161,7 @@ class PHPCBF {
let promise = new Promise((resolve, reject) => {
exec.on("error", err => {
reject();
console.log(err);
this._debugLog("PHPCBF spawn error: " + err.message);
if (err.code == "ENOENT") {
window.showErrorMessage(
"PHPCBF: " + err.message + ". executablePath not found."
Expand All @@ -183,7 +188,9 @@ class PHPCBF {
}
break;
case 3:
phpcbfError = true;
// General phpcbf execution error — reject so the Promise settles.
window.showErrorMessage("PHPCBF: general script execution errors.");
reject();
break;
default:
let msgs = {
Expand All @@ -201,25 +208,17 @@ class PHPCBF {
});
});

if (phpcbfError) {
exec.stdout.on("data", buffer => {
console.log(buffer.toString());
window.showErrorMessage(buffer.toString());
});
}
if (this.debug) {
exec.stdout.on("data", buffer => {
console.log(buffer.toString());
this._debugLog(buffer.toString());
});
}
exec.stderr.on("data", buffer => {
console.log(buffer.toString());
this._debugLog(buffer.toString());
});
exec.on("close", code => {
// console.log(code);
if (this.debug) {
console.timeEnd("phpcbf");
console.groupEnd();
this._debugLog("phpcbf done (" + (Date.now() - (this._debugStart || Date.now())) + "ms)");
}
});

Expand Down Expand Up @@ -259,7 +258,9 @@ class PHPCBF {
}

exports.activate = context => {
let phpcbf = new PHPCBF();
const outputChannel = vscode.window.createOutputChannel("phpcbf");
context.subscriptions.push(outputChannel);
let phpcbf = new PHPCBF(outputChannel);

context.subscriptions.push(
workspace.onWillSaveTextDocument(event => {
Expand Down Expand Up @@ -312,7 +313,6 @@ exports.activate = context => {
}
})
.catch(err => {
console.log(err);
reject();
});
});
Expand Down