discord-vscode/src/extension.ts

207 lines
7.3 KiB
TypeScript
Raw Normal View History

// Import the required functions & object types from various packages.
2017-11-23 13:06:21 +00:00
import { Client } from 'discord-rpc';
import { basename, extname } from 'path';
2017-11-23 23:53:16 +00:00
import { setInterval, clearInterval } from 'timers';
import {
2017-11-26 21:16:11 +00:00
env,
ExtensionContext,
commands,
window,
workspace,
TextDocument,
TextDocumentChangeEvent,
2017-11-26 22:06:01 +00:00
Disposable,
debug,
DebugSession
} from 'vscode';
const languages = require('./data/languages.json');
2017-11-23 13:06:21 +00:00
// Define the RPC variable and its type.
let rpc: Client;
// Define the eventHandler variable and its type.
const eventHandlers: Set<Disposable> = new Set();
// Define the config variable and its type.
let config;
// Define the reconnect timer and its type.
let reconnectTimer: NodeJS.Timer;
// Define the reconnect counter and its type.
let reconnectCounter = 0;
// Define the last known file name and its type.
let lastKnownFileName: string;
// Define the activity object.
let activity: object;
// Define the activity timer to not spam the API with requests.
let activityTimer: NodeJS.Timer;
// `Activate` is fired when the extension is enabled. This SHOULD only fire once.
2017-11-23 13:06:21 +00:00
export function activate(context: ExtensionContext) {
// Get the workspace's configuration for "discord".
config = workspace.getConfiguration('discord');
2017-11-23 13:06:21 +00:00
// Obtain whether or not the extension is activated.
2017-11-23 23:53:16 +00:00
if (config.get('enabled')) {
initRPC(config.get('clientID'));
}
// Register the `discord.enable` command, and set the `enabled` config option to true.
const enabler = commands.registerCommand('discord.enable', () => {
if (rpc) destroyRPC();
config.update('enabled', true);
initRPC(config.get('clientID'));
window.showInformationMessage('Enabled Discord Rich Presence for this workspace.');
});
// Register the `discord.disable` command, and set the `enabled` config option to false.
const disabler = commands.registerCommand('discord.disable', () => {
if (!rpc) return;
config.update('enabled', false);
destroyRPC();
window.showInformationMessage('Disabled Discord Rich Presence for this workspace.');
2017-11-23 23:53:16 +00:00
});
// Push the new commands into the subscriptions.
context.subscriptions.push(enabler, disabler);
2017-11-23 13:06:21 +00:00
}
// `Deactivate` is fired whenever the extension is deactivated.
export function deactivate(context: ExtensionContext) {
// If there's an RPC Client initalized, destroy it.
destroyRPC();
}
// Initalize the RPC systems.
function initRPC(clientID: string): void {
// Update the RPC variable with a new RPC Client.
rpc = new Client({ transport: 'ipc' });
// Once the RPC Client is ready, set the activity.
rpc.once('ready', () => {
// This is purely for safety measures.
if (reconnectTimer) {
// Clear the reconnect interval.
clearInterval(reconnectTimer);
// Null reconnect variable.
reconnectTimer = null;
}
// This is purely for safety measures.
if (activityTimer) {
// Clear the activity interval.
clearInterval(activityTimer);
// Null activity variable.
activityTimer = null;
}
// Reset the reconnect counter to 0 on a successful reconnect.
reconnectCounter = 0;
setActivity();
// Set the activity once on ready
setTimeout(() => rpc.setActivity(activity), 500);
eventHandlers.add(workspace.onDidChangeTextDocument((e: TextDocumentChangeEvent) => setActivity()))
.add(workspace.onDidOpenTextDocument((e: TextDocument) => setActivity()))
2017-11-26 22:06:01 +00:00
.add(workspace.onDidCloseTextDocument((e: TextDocument) => setActivity()))
.add(debug.onDidChangeActiveDebugSession((e: DebugSession) => setActivity()))
.add(debug.onDidStartDebugSession((e: DebugSession) => setActivity()))
.add(debug.onDidTerminateDebugSession((e: DebugSession) => setActivity()));
// Make sure to listen to the close event and dispose and destroy everything accordingly.
rpc.transport.once('close', () => {
if (!config.get('enabled')) return;
destroyRPC();
// Set an interval for reconnecting.
reconnectTimer = setInterval(() => {
reconnectCounter++;
initRPC(config.get('clientID'));
}, 5000);
});
// Update the user's activity to the `activity` variable.
activityTimer = setInterval(() => rpc.setActivity(activity), 15000);
});
// Log in to the RPC Client, and check whether or not it errors.
rpc.login(clientID).catch(error => {
if (reconnectTimer) {
2017-11-24 12:53:47 +00:00
// Destroy and dispose of everything after a default of 20 reconnect attempts
if (reconnectCounter >= config.get('reconnectThreshold')) destroyRPC();
else return;
}
if (error.message.includes('ENOENT')) window.showErrorMessage('No Discord Client detected!');
2017-11-24 02:33:50 +00:00
else window.showErrorMessage(`Couldn't connect to discord via rpc: ${error.message}`);
});
}
// Cleanly destroy the RPC client (if it isn't already).
function destroyRPC(): void {
// Do not continue if RPC isn't initalized.
if (!rpc) return;
// Clear the reconnect interval.
if (reconnectTimer) clearInterval(reconnectTimer);
// Null reconnect variable.
reconnectTimer = null;
// Clear the activity interval.
if (activityTimer) clearInterval(activityTimer);
// Null the activity timer.
activityTimer = null;
// Reset the activity.
rpc.setActivity({});
// Dispose of the event handlers.
eventHandlers.forEach(event => event.dispose());
// If there's an RPC Client initalized, destroy it.
rpc.destroy();
// Null the RPC variable.
rpc = null;
// Null the last known file name
lastKnownFileName = null;
}
2017-11-23 13:06:21 +00:00
// This function updates the activity (The Client's Rich Presence status).
function setActivity(): void {
// Do not continue if RPC isn't initalized.
2017-11-23 13:06:21 +00:00
if (!rpc) return;
if (window.activeTextEditor && window.activeTextEditor.document.fileName === lastKnownFileName) return;
lastKnownFileName = window.activeTextEditor ? window.activeTextEditor.document.fileName : null;
const details = window.activeTextEditor
2017-11-26 22:06:01 +00:00
? debug.activeDebugSession
? `${config.get('details').replace('{filename}', basename(window.activeTextEditor.document.fileName))} (Debug)`
: config.get('details').replace('{filename}', basename(window.activeTextEditor.document.fileName))
: config.get('detailsIdle');
const checkState = window.activeTextEditor
? Boolean(workspace.getWorkspaceFolder(window.activeTextEditor.document.uri))
: false;
const state = window.activeTextEditor
? checkState
? config.get('workspace').replace('{workspace}', workspace.getWorkspaceFolder(window.activeTextEditor.document.uri).name)
: config.get('workspaceNotFound')
: config.get('workspaceIdle');
const largeImageKey = window.activeTextEditor
? languages[Object.keys(languages).find(key => {
if (key.startsWith('.') && basename(window.activeTextEditor.document.fileName).endsWith(key)) return true;
const match = key.match(/^\/(.*)\/([mgiy]+)$/);
if (!match) return false;
const regex = new RegExp(match[1], match[2]);
return regex.test(basename(window.activeTextEditor.document.fileName));
})]
: 'vscode-big';
// Create a JSON Object with the user's activity information.
activity = {
details,
state,
startTimestamp: new Date().getTime() / 1000,
2017-11-26 22:06:01 +00:00
largeImageKey: largeImageKey
? largeImageKey.image
|| largeImageKey
: 'txt',
largeImageText: window.activeTextEditor
2017-11-26 22:06:01 +00:00
? config.get('largeImage')
|| window.activeTextEditor.document.languageId
2017-11-24 12:53:47 +00:00
: config.get('largeImageIdle'),
2017-11-26 22:06:01 +00:00
smallImageKey: debug.activeDebugSession
? 'debug'
: env.appName.includes('Insiders')
? 'vscode-insiders'
: 'vscode',
2017-11-26 21:16:11 +00:00
smallImageText: config.get('smallImage').replace('{appname}', env.appName),
2017-11-23 13:06:21 +00:00
instance: false
};
}