Skip to content

Friendly command names in help text #99

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

Open
JunhaoSLi wants to merge 6 commits into
base: dev-master
Choose a base branch
from
Open

Friendly command names in help text #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2424538
add proposed friendly command names config style
JunhaoSLi Feb 13, 2022
a870790
update config for friendly command name feedback
JunhaoSLi Feb 13, 2022
6809a86
implement friendly names in help text
JunhaoSLi Feb 13, 2022
8e8f355
add check against help topic alias search getting stuck in a loop
JunhaoSLi Feb 13, 2022
c1c3d20
typo
JunhaoSLi Feb 13, 2022
09bc884
and another bug fix
JunhaoSLi Feb 13, 2022
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
72 changes: 59 additions & 13 deletions bot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,12 +743,11 @@ function command(message) {
if (Object.keys(config.helpTopics).includes(target)) {
let detailsObject = config.helpTopics[target];
let response;
let targetTopicAliases = [target];
while (detailsObject.alias != null) {
// This command is an alias, try to find the help text object for the actual command
if (config.helpTopics.hasOwnProperty(detailsObject.alias)) {
detailsObject = config.helpTopics[detailsObject.alias];
} else {
log.notice(
// This command is an alias, check if we can find the object it's aliasing
if (!config.helpTopics.hasOwnProperty(detailsObject.alias)) {
log.warning(
"Help topic " +
target +
" aliases " +
Expand All @@ -758,6 +757,20 @@ function command(message) {
" does not exist."
);
return;
} else if (targetTopicAliases.includes(detailsObject.alias)) {
targetTopicAliases.push(detailsObject.alias)
Copy link
Copy Markdown
Owner

@za419 za419 Feb 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we pushing this onto the array that already contains it before returning?

Copy link
Copy Markdown
Collaborator Author

@JunhaoSLi JunhaoSLi Apr 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes, it's just for the join in the warning log which gets printed below, e.g. "Help topic nowplaying is part of an alias loop: nowplaying > nowplaying"

Copy link
Copy Markdown
Collaborator Author

@JunhaoSLi JunhaoSLi Apr 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I can add a comment to make this clearer?

Copy link
Copy Markdown
Owner

@za419 za419 Apr 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see. Yeah, I'd usually expect that to be a '+= > ${detailsObject.alias} sort of expression...

A comment is fine. Thanks

// Then check if we've entered an alias loop
log.warning(
"Help topic " +
target +
" is part of an alias loop: " +
targetTopicAliases.join(" > ")
);
return;
} else {
// Finally, get the object the command is aliasing
detailsObject = config.helpTopics[detailsObject.alias];
targetTopicAliases.push(detailsObject.alias);
}
}

Expand Down Expand Up @@ -825,21 +838,54 @@ function command(message) {
// Grab up to the first word boundary
const firstWord = term.split(/\b/)[0];

// If the first word is a command's internal name...
// Try to get the command key if a friendly name shorthand is being used
let friendlyCommandKey = null;
const friendlyShorthandPrefix = "friendly:";
if (term.startsWith(friendlyShorthandPrefix)) {
friendlyCommandKey = term
.substring(
friendlyShorthandPrefix.length
)
.split(/\b/)[0];
}

// If a friendly name is being used and the command key matches an existing command...
if (
Object.keys(
config.commandDescriptions
).includes(friendlyCommandKey)
) {
// Then add the term to result but with the shorthand replaced by the friendly name
const friendlyNameFromDescription =
config.commandDescriptions[
friendlyCommandKey
].friendlyName;

const friendlyName =
friendlyNameFromDescription != null
? friendlyNameFromDescription
: friendlyCommandKey;

result +=
friendlyName +
term.substring(
friendlyShorthandPrefix.length +
friendlyCommandKey.length
);
} else if (
// Otherwise, if the first word is a command's internal name...
Object.keys(config.commands).includes(
firstWord
)
) {
// Then add the command's trigger phrase to result
result += config.commands[firstWord].trim();
// Then add the term to result but with the first word replaced by the command's trigger phrase
result +=
config.commands[firstWord].trim() +
term.substring(firstWord.length);
} else {
// Otherwise, add firstWord back in with its % restored
result += "%" + firstWord;
// Otherwise, add term back in with its % restored
result += "%" + term;
}

// Finally, add everything after the first word boundary to result
result += term.substring(firstWord.length);
}
}
return "> " + result;
Expand Down
6 changes: 4 additions & 2 deletions default-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@
},
"helpTopic": {
"description": "Displays additional help information for a chosen <topic>.",
"friendlyName": "help",
"parameters": ["topic"]
},
"nowplaying": {
"description": "Displays the song that is currently playing on Cadence"
"description": "Displays the song that is currently playing on Cadence",
"friendlyName": "now playing"
},
"search": {
"description": "Search the Cadence database with a <query>",
Expand Down Expand Up @@ -63,7 +65,7 @@
"nowplaying": {
"internalKey": "nowplaying",
"lines": [
"The `%nowplaying` command displays the song that is currently playing on Cadence."
"The `%friendly:nowplaying` command displays the song that is currently playing on Cadence."
]
},
"now playing": {
Expand Down