mirror of
https://github.com/hack-chat/main.git
synced 2024-03-22 13:20:33 +08:00
186 lines
6.6 KiB
HTML
186 lines
6.6 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Source: core/help.js</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">Source: core/help.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>/**
|
||
|
|
* @author Marzavec ( https://github.com/marzavec )
|
||
|
|
* @summary Get help
|
||
|
|
* @version 1.0.0
|
||
|
|
* @description Outputs information about the servers current protocol
|
||
|
|
* @module help
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Executes when invoked by a remote client
|
||
|
|
* @param {Object} env - Enviroment object with references to core, server, socket & payload
|
||
|
|
* @public
|
||
|
|
* @return {void}
|
||
|
|
*/
|
||
|
|
export async function run({
|
||
|
|
core, server, socket, payload,
|
||
|
|
}) {
|
||
|
|
// check for spam
|
||
|
|
if (server.police.frisk(socket.address, 2)) {
|
||
|
|
return server.reply({
|
||
|
|
cmd: 'warn', // @todo Add numeric error code as `id`
|
||
|
|
text: 'You are sending too much text. Wait a moment and try again.\nPress the up arrow key to restore your last message.',
|
||
|
|
channel: socket.channel, // @todo Multichannel
|
||
|
|
}, socket);
|
||
|
|
}
|
||
|
|
|
||
|
|
// verify user input
|
||
|
|
if (typeof payload.command !== 'undefined' && typeof payload.command !== 'string') {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
let reply = '';
|
||
|
|
if (typeof payload.command === 'undefined') {
|
||
|
|
reply += '# All commands:\n|Category:|Name:|\n|---:|---|\n';
|
||
|
|
|
||
|
|
const categories = core.commands.categoriesList.sort();
|
||
|
|
for (let i = 0, j = categories.length; i < j; i += 1) {
|
||
|
|
reply += `|${categories[i].replace('../src/commands/', '').replace(/^\w/, (c) => c.toUpperCase())}:|`;
|
||
|
|
const catCommands = core.commands.all(categories[i]).sort(
|
||
|
|
(a, b) => a.info.name.localeCompare(b.info.name),
|
||
|
|
);
|
||
|
|
reply += `${catCommands.map((c) => `${c.info.name}`).join(', ')}|\n`;
|
||
|
|
}
|
||
|
|
|
||
|
|
reply += '---\nFor specific help on certain commands, use either:\nText: `/help <command name>`\nAPI: `{cmd: \'help\', command: \'<command name>\'}`';
|
||
|
|
} else {
|
||
|
|
const command = core.commands.get(payload.command);
|
||
|
|
|
||
|
|
if (typeof command === 'undefined') {
|
||
|
|
reply += 'Unknown command';
|
||
|
|
} else {
|
||
|
|
reply += `# ${command.info.name} command:\n| | |\n|---:|---|\n`;
|
||
|
|
reply += `|**Name:**|${command.info.name}|\n`;
|
||
|
|
reply += `|**Aliases:**|${typeof command.info.aliases !== 'undefined' ? command.info.aliases.join(', ') : 'None'}|\n`;
|
||
|
|
reply += `|**Category:**|${command.info.category.replace('../src/commands/', '').replace(/^\w/, (c) => c.toUpperCase())}|\n`;
|
||
|
|
reply += `|**Required Parameters:**|${command.requiredData || 'None'}|\n`;
|
||
|
|
// eslint-disable-next-line no-useless-escape
|
||
|
|
reply += `|**Description:**|${command.info.description || '¯\_(ツ)_/¯'}|\n\n`;
|
||
|
|
reply += `**Usage:** ${command.info.usage || command.info.name}`;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// output reply
|
||
|
|
server.reply({
|
||
|
|
cmd: 'info',
|
||
|
|
text: reply,
|
||
|
|
channel: socket.channel, // @todo Multichannel
|
||
|
|
}, socket);
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Automatically executes once after server is ready to register this modules hooks
|
||
|
|
* @param {Object} server - Reference to server enviroment object
|
||
|
|
* @public
|
||
|
|
* @return {void}
|
||
|
|
*/
|
||
|
|
export function initHooks(server) {
|
||
|
|
server.registerHook('in', 'chat', this.helpCheck.bind(this), 28);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Executes every time an incoming chat command is invoked;
|
||
|
|
* hooks chat commands checking for /help
|
||
|
|
* @param {Object} env - Enviroment object with references to core, server, socket & payload
|
||
|
|
* @public
|
||
|
|
* @return {{Object|boolean|string}} Object = same/altered payload,
|
||
|
|
* false = suppress action,
|
||
|
|
* string = error
|
||
|
|
*/
|
||
|
|
export function helpCheck({
|
||
|
|
core, server, socket, payload,
|
||
|
|
}) {
|
||
|
|
if (typeof payload.text !== 'string') {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (payload.text.startsWith('/help')) {
|
||
|
|
const input = payload.text.substr(1).split(' ', 2);
|
||
|
|
|
||
|
|
this.run({
|
||
|
|
core,
|
||
|
|
server,
|
||
|
|
socket,
|
||
|
|
payload: {
|
||
|
|
cmd: input[0],
|
||
|
|
command: input[1],
|
||
|
|
},
|
||
|
|
});
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
return payload;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Module meta information
|
||
|
|
* @public
|
||
|
|
* @typedef {Object} help/info
|
||
|
|
* @property {string} name - Module command name
|
||
|
|
* @property {string} category - Module category name
|
||
|
|
* @property {string} description - Information about module
|
||
|
|
* @property {string} usage - Information about module usage
|
||
|
|
*/
|
||
|
|
export const info = {
|
||
|
|
name: 'help',
|
||
|
|
category: 'core',
|
||
|
|
description: 'Outputs information about the servers current protocol',
|
||
|
|
usage: `
|
||
|
|
API: { cmd: 'help', command: '<optional command name>' }
|
||
|
|
Text: /help <optional command name>`,
|
||
|
|
};
|
||
|
|
</code></pre>
|
||
|
|
</article>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-addmod.html">addmod</a></li><li><a href="module-ban.html">ban</a></li><li><a href="module-changecolor.html">changecolor</a></li><li><a href="module-changenick.html">changenick</a></li><li><a href="module-chat.html">chat</a></li><li><a href="module-disconnect.html">disconnect</a></li><li><a href="module-dumb.html">dumb</a></li><li><a href="module-emote.html">emote</a></li><li><a href="module-forcecolor.html">forcecolor</a></li><li><a href="module-help.html">help</a></li><li><a href="module-invite.html">invite</a></li><li><a href="module-join.html">join</a></li><li><a href="module-kick.html">kick</a></li><li><a href="module-listusers.html">listusers</a></li><li><a href="module-morestats.html">morestats</a></li><li><a href="module-ping.html">ping</a></li><li><a href="module-reload.html">reload</a></li><li><a href="module-removemod.html">removemod</a></li><li><a href="module-saveconfig.html">saveconfig</a></li><li><a href="module-session.html">session</a></li><li><a href="module-shout.html">shout</a></li><li><a href="module-socketreply.html">socketreply</a></li><li><a href="module-speak.html">speak</a></li><li><a href="module-stats.html">stats</a></li><li><a href="module-unban.html">unban</a></li><li><a href="module-unbanall.html">unbanall</a></li><li><a href="module-whisper.html">whisper</a></li></ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Jun 22 2022 10:04:25 GMT-0500 (Central Daylight Time)
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script> prettyPrint(); </script>
|
||
|
|
<script src="scripts/linenumber.js"> </script>
|
||
|
|
</body>
|
||
|
|
</html>
|