utils.js

// Help message content
const helpmessage =  [
  {
    name: "**New Users**",
    value: "tutorial, syllabus, building, flashing, testing, debugging"
  },
  {
    name: "**FAQs**",
    value: "faq, faq-build, faq-debug, faq-keymap, squeeze-avr, glossary"
  },
  {
    name: "**Building, Flashing, Drivers**",
    value: "configurator, api, zadig, toolbox, flashing, flashing-bootloadhid, keymap, vagrant, ide-eclipse, ide-vscode, git, hand-wire, isp-flashing, msys, udev, vid, vidq, promicro, protonc, elitec, blackpill, bluepill, wrong-drivers"
  },
  {
    name: "**QMK CLI**",
    value: "cli, cli-configuration, cli-commands"
  },
  {
    name: "**Keycodes**",
    value: "keycodes, keycodes-basic, keycodes-quantum, keycodes-advanced, keycodes-shifted"
  },
  {
    name: "**Advanced Keycodes**",
    value: "command, dynamic-macros, grave-escape, leader, mod-tap, macros, mouse-keys, space-cadet, keycodes-shifted"
  },
  {
    name: "**Software Features**",
    value: "auto-shift, combos, debounce, key-lock, key-overrides, layers, one-shot-keys, pointing-device, swap-hands, tap-dance, tap-hold, terminal, unicode, wpm, sync-options, intercept-taps, eehands, handedness"
  },
  {
    name: "**Hardware Features**",
    value: "*Displays:* lcd, oled\n*Lighting:* backlight, led-matrix, rgblight, rgbmatrix, indicators\naudio, bluetooth, bootmagic, custom-matrix, dip-switch, encoders, haptic-feedback, joystick, ctpc, ps2-mouse, split-keyboard, stenography, velocikey"
  },
  {
    name: "**Development Information**",
    value: "pr-checklist, breaking-changes, changelog, mcus, contributing"
  },
  {
    name: "**Other Information**",
    value: "lighting, translating, config-options, understanding-keyboards, understanding-matrix, understanding-qmk, conduct, kbdfans, sonix, openrgb, vial, input-language, zmk"
  }];

// Construct plaintext help menu fallback
var array = [];
for (const [key, value] of helpmessage.entries()) {
  array.push(`${helpmessage[key].name}\n${helpmessage[key].value}\n`);
}
plaintext = array.join("\n");


module.exports = {

  // Object Literal alternative to switch/if-else mess
  docsSwitch: (docs) => ({
    "docs": "",
    "newbs": "newbs",
    "tutorial": "newbs",
    "setup": "newbs_getting_started",
    "syllabus": "syllabus",
    "building": "newbs_building_firmware",
    "flashing": "newbs_flashing",
    "testing": "newbs_testing_debugging",
    "debugging": "newbs_testing_debugging",
    "faq": "faq_general",
    "faqbuild": "faq_build",
    "faqdebug": "faq_debug",
    "faqkeymap": "faq_keymap",
    "squeezeavr": "squeezing_avr",
    "glossary": "reference_glossary",
    "configurator": "newbs_building_firmware_configurator",
    "api": "api_overview",
    "cli": "cli",
    "cliconfiguration": "cli_configuration",
    "clicommands": "cli_commands",
    "customizing": "custom_quantum_functions",
    "zadig": "driver_installation_zadig",
    "keymap": "keymap",
    "vagrant": "getting_started_vagrant",
    "flashing": "flashing",
    "flashingbootloadhid": "flashing_bootloadhid",
    "ideeclipse": "other_eclipse",
    "idevscode": "other_vscode",
    "handwire": "hand_wire",
    "ispflashing": "isp_flashing_guide",
    "keycodes": "keycodes",
    "keycodesbasic": "keycodes_basic",
    "keycodesquantum": "quantum_keycodes",
    "keycodesshifted": "keycodes_us_ansi_shifted",
    "keycodesadvanced": "feature_advanced_keycodes",
    "command": "feature_command",
    "dynamicmacros": "feature_dynamic_macros",
    "graveescape": "feature_grave_esc",
    "leader": "feature_leader_key",
    "modtap": "mod_tap",
    "macros": "feature_macros",
    "mousekeys": "feature_mouse_keys",
    "spacecadet": "feature_space_cadet",
    "autoshift": "feature_auto_shift",
    "combos": "feature_combo",
    "debounce": "feature_debounce_type",
    "keylock": "feature_key_lock",
    "keyoverrides": "feature_key_overrides",
    "layers": "feature_layers",
    "oneshotkeys": "one_shot_keys",
    "pointingdevice": "feature_pointing_device",
    "swaphands": "feature_swap_hands",
    "tapdance": "feature_tap_dance",
    "taphold": "tap_hold",
    "terminal": "feature_terminal",
    "unicode": "feature_unicode",
    "userspace": "feature_userspace",
    "wpm": "feature_wpm",
    "lcd": "feature_hd44780",
    "oled": "feature_oled_driver",
    "backlight": "feature_backlight",
    "ledmatrix": "feature_led_matrix",
    "rgblight": "feature_rgblight",
    "rgbmatrix": "feature_rgb_matrix",
    "audio": "feature_audio",
    "bluetooth": "feature_bluetooth",
    "bootmagic": "feature_bootmagic",
    "custommatrix": "custom_matrix",
    "dipswitch": "feature_dip_switch",
    "encoders": "feature_encoders",
    "hapticfeedback": "feature_haptic_feedback",
    "joystick": "feature_joystick",
    "indicators": "feature_led_indicators",
    "ctpc": "proton_c_conversion",
    "ps2mouse": "feature_ps2_mouse",
    "splitkeyboard": "feature_split_keyboard",
    "stenography": "feature_stenography",
    "velocikey": "feature_velocikey",
    "prchecklist": "pr_checklist",
    "breakingchanges": "breaking_changes",
    "changelog": "ChangeLog/20211127",
    "mcus": "compatible_microcontrollers",
    "contributing": "contributing",
    "translating": "translating",
    "configoptions": "config_options",
    "understandingkeyboards": "how_keyboards_work",
    "understandingmatrix": "how_a_matrix_works",
    "understandingqmk": "understanding_qmk",
    "wrongdrivers": "driver_installation_zadig?id=recovering-from-installation-to-wrong-device",
    "eehands": "feature_split_keyboard?id=handedness-by-eeprom",
    "handedness": "feature_split_keyboard?id=setting-handedness",
    "syncoptions": "feature_split_keyboard?id=data-sync-options",
    "intercepttaps": "mod_tap?id=intercepting-mod-taps",
    "udev": "faq_build?id=linux-udev-rules",
  })[docs],

  // Format embedded message
  msg: {embed: {
    color: "344703",
    author: {
      name: `Use any of the following commands starting with '!' for more information`
    },
    fields: helpmessage,
    footer: {
      text: `I respond to DMs, too!`
    },
  }},

  plainhelp: plaintext,
  prefix: '!',
  baseurl: 'https://docs.qmk.fm/#/',
  firmware: 'https://github.com/qmk/qmk_firmware/',
  toolbox: 'https://github.com/qmk/qmk_toolbox/',
  disclaimer: "If you don't see an embed, try `!plain`",
  ohshitgit: 'https://ohshitgit.com/',
  git: 'https://docs.qmk.fm/#/newbs_git_best_practices',
  //xkcd: 'https://xkcd.com/1597/',
  xkcd: 'https://imgs.xkcd.com/comics/git.png',
  promicro: 'https://i.imgur.com/GsrDNHK.png',
  protonc: 'https://i.imgur.com/nICqWLo.jpg',
  elitec: 'https://i.imgur.com/WWnicKw.png',
  blackpill: 'https://i.imgur.com/nCgeolT.png',
  bluepill: 'https://i.imgur.com/mpiVwDX.jpg',
  msys: 'https://msys.qmk.fm/',
  wsl: 'https://qmk.github.io/qmk_distro_wsl/',
  coc: 'https://qmk.fm/coc/',
  kbdfans: 'Against our best advice, KBDfans have chosen a less than ideal bootloader for their newer board revisions. The latest QMK Toolbox does support it which can be downloaded from <https://github.com/qmk/qmk_toolbox/releases>. Otherwise you may have luck using <https://tinyurl.com/KBDFansFlashNew> for reference, but if you are still stuck you will have to visit KBDfans discord for support: <https://discord.gg/kbdfans>',
  sonixinvite: 'https://discord.gg/q8VjhRgzRw',
  sonix: 'Support is maintained in another fork and is not part of QMK yet.\n\nGitHub: <https://github.com/SonixQMK/>\nDiscord: ',
  openrgbinvite: 'https://discord.com/invite/AQwjJPY',
  openrgb: 'Support is maintained in another fork and is not part of QMK yet.\n\nSite: <https://openrgb.org/>\nGitHub: <https://github.com/Kasper24/QMK-OpenRGB>\nDiscord: ',
  vialinvite: 'https://discord.gg/zNKEUXTKwF',
  vial: 'Support is maintained in another fork and is not part of QMK yet.\n\nSite: <https://get.vial.today/>\nGitHub: <https://github.com/vial-kb/vial-qmk>\nDiscord: ',
  vid: 'https://yanfali.github.io/qmk_usb_usage/',
  vidq: 'https://www.the-sz.com/products/usbid/index.php',
  lighting: '**Backlight:** Single color, per key, not individually addressable (all on or off)\n**RGBLight:** Underglow RGB, linear design (single chain), individually addressable\n**LED Matrix:** Single color, per key, individually addressable\n**RGB Matrix:** RGB, per key, individually addressable\n**Indicators:** Scroll/Caps/Num Lock LEDs',
  markdown: 'Inserting triple backticks at the beginning and end of your code will create a code block. You can specify a language after the first triple back tick, applicable options would be c, make, python and markdown.\n \n\\\`\\\`\\\`c\n\`\`\`c\nif (is_fancy_example) {\n   return false;\n}\n\`\`\`\n\\\`\\\`\\\`',
  inputlanguage: 'Keyboards don\'t send characters, they send keycodes. The input language set by the OS maps those keycodes to characters. If you have swapped round the keys in your keyboard firmware try setting your OS input language to English, otherwise make sure you have the correct input language selected in your OS.\n\nThere are also keymap header files that map specific languages to keycodes. Follow this link for more information <https://docs.qmk.fm/#/reference_keymap_extras?id=language-specific-keycodes>',
  standards: 'https://imgs.xkcd.com/comics/standards.png',
  snip: 'https://i.imgur.com/Us2oNzW.png',
  cooldown: [],
  authroles: ['Directors', 'Collaborators', 'Mods'],
  zmk: 'Information and support for ZMK firmware can be found here:\n\nSite: <https://zmk.dev/>\nGitHub: <https://github.com/zmkfirmware/zmk/>\nDiscord: ',
  zmkinvite: 'https://discord.com/invite/sycytVQ',
  prstatus: 'You asked about the status of your PR.\n\nWhile we know that your PR is important to you, it may take some time for us to get to your PR.\n\nPull Request reviews are something that is done in our free time. We are not paid nor compensated for the time we spend reviewing, as it is a labor of love. As such, this means that it can take time for us to get to your Pull Request. Things like family, or life can get in the way of us getting to PRs, and burnout is a serious consideration. The QMK firmware repository averages 200 PRs opened and 200 PRs merged every month, so please have patience.\n\nAlso, anyone can review PRs. And adding meaningful reviews to other PRs is a great way to contribute back.  This helps reduce the burden on collaboraters, as well. Which means that we may be able to get to your PR that much faster.',


  // Parser
  parse: function(string) {
    return string.toLowerCase().substring(1).replace(/[^a-z\- ]+/g, '').split(/ +/g, 2);
  },

  // Bare link constructor (inhibits embeds)
  bare: function(string) {
    return `<${string}>`;
  },

/**
 * @param {string} string - Text inside code block
 * @param {string} format - Language for code block
 * @param {string} author - Authors name
 * @param {string} invoker - Invokers name
 */
  automark: function (string, format, author, invoker) {
    return `\`\`\`${format}\n// original message by ${author}, send !markdown in discord for instructions to create code blocks.\n\n${string}\n\n// ${invoker} invoked !mdlast\`\`\``;
  },

/**
 * @param {GuildMember} guildmember - Member to check
 * @param {string} rolenames - Array of role names to check
 */
  checkrole: function (guildmember, rolenames) {
    return guildmember.roles.cache.find(r => rolenames.includes(r.name))
  },

/**
 * @param {Client} client - Connected client to use
 * @param {string} inviteurl - Invite url to grab icon from
 */
  iconfrominvite: async function (client, inviteurl) {
    var icon = client.fetchInvite(inviteurl)
      .then(invite => {
        var icon = invite.guild.iconURL();
        return icon;
      })
      .catch(err => {
        console.log(err);
      });
    return icon;
  },
};