feat: Library command + service.

Author: sustained

src/commands/documentation/library.js

@@ -0,0 +1,115 @@
+import { Command } from 'discord.js-commando'
+import { getLibrary } from '../../services/libraries'
+import { RichEmbed } from 'discord.js'
+import { EMPTY_MESSAGE } from '../../utils/constants'
+import { tryDelete } from '../../utils/messages'
+import { uppercaseFirst } from '../../utils/string'
+
+const DELETE_ERRORS_AFTER = 30000
+
+module.exports = class DocumentationLibraryCommand extends Command {
+  constructor(client) {
+    super(client, {
+      args: [
+        {
+          key: 'name',
+          type: 'string',
+          prompt: 'which library to look up?',
+        },
+      ],
+      name: 'library',
+      group: 'documentation',
+      aliases: ['lib', 'l'],
+      examples: [
+        `!library quasar`,
+        `!library vuetify`,
+        `!library nuxt`,
+        `!library gridsome`,
+        `!library saber`,
+        `!library vuepress`,
+      ],
+      guildOnly: false,
+      memberName: 'library',
+      description: 'Look up a library/framework by name.',
+    })
+  }
+
+  hasPermission() {
+    return true
+  }
+
+  async run(msg, args) {
+    const { name } = args
+
+    try {
+      let library = getLibrary(name)
+      const embed = this.buildResponseEmbed(library)
+
+      return msg.channel.send(EMPTY_MESSAGE, { embed })
+    } catch (error) {
+      console.error(error)
+      const embed = this.buildErrorEmbed(name)
+      const response = await msg.channel.send(EMPTY_MESSAGE, { embed })
+
+      tryDelete(msg)
+      tryDelete(response, DELETE_ERRORS_AFTER)
+    }
+  }
+
+  buildResponseEmbed(library) {
+    const embed = new RichEmbed()
+      .setURL(library.url.site)
+      .setTitle(library.name)
+      .setColor(library.colour)
+
+    if (library.tagline) {
+      embed.setDescription(library.tagline)
+    }
+
+    if (library.tags.length) {
+      embed.setFooter('Tags: ' + library.tags.join(', '))
+    }
+
+    if (library.icon) {
+      embed.setThumbnail(`attachment://${library.icon}`).attachFile({
+        attachment: `assets/images/icons/${library.icon}`,
+        name: library.icon,
+      })
+    }
+
+    if (library.author) {
+      embed.setAuthor(
+        library.author.name,
+        library.author.avatar,
+        library.author.url
+      )
+    }
+
+    if (library.fields) {
+      for (const field of library.fields) {
+        if (typeof field === 'object') {
+          embed.addField(field.name, field.value)
+        } else {
+          embed.addField(EMPTY_MESSAGE, field)
+        }
+      }
+    }
+
+    for (const [name, url] of Object.entries(library.url)) {
+      embed.addField(uppercaseFirst(name), url, true)
+    }
+
+    return embed
+  }
+
+  buildErrorEmbed(name) {
+    return new RichEmbed()
+      .setTitle('Library Lookup')
+      .setColor('RED')
+      .setDescription(
+        `Could not find a library with the name: ${name}.\n\nThink it should be included?`
+      )
+      .addField('Submit PR', 'https://git.io/JenP0', true)
+      .addField('File issue', 'https://git.io/JenP2', true)
+  }
+}

src/services/libraries.js

@@ -0,0 +1,107 @@
+import { join, resolve } from 'path'
+
+const DATA_DIR = resolve(__dirname, '../../data/libraries')
+const AVATAR_BASE_URL =
+  'https://raw.githubusercontent.com/sustained/vue-land-bot/feat-library/assets/images/avatars/'
+
+/*
+  TODO: We should probably just scan the directory but not sure how to handle 
+        exporting things which are loaded in a callback or a promise then handler?
+*/
+const LIBRARY_NAMES = [
+  'gridsome',
+  'nuxt',
+  'quasar',
+  'saber',
+  'vuepress',
+  'vuetify',
+]
+
+const libraries = {}
+
+for (const libraryName of LIBRARY_NAMES) {
+  try {
+    const library = require(join(DATA_DIR, `${libraryName}.json`))
+    libraries[libraryName] = _validateLibrary(library)
+  } catch (error) {
+    console.warn(
+      `[LibraryService] Something went wrong when requiring or validating "${libraryName}.json":`
+    )
+    console.error(error)
+  }
+}
+
+export default libraries
+
+console.log(libraries['saber'])
+
+/**
+ * @typedef {Object} LibraryDefinition
+ * @property {string} name The name of the library.
+ * @property {string} [icon] An optional icon path.
+ * @property {Array<string>} [tags=[]] An array of tags.
+ * @property {string} tagline The library's tagline or description.
+ * @property {Array<{name: string, value: string}>} fields An array of field objects.
+ * @property {{name: string, url: string, avatar: string}} [author] The author of the library.
+ * @property {{site: string, docs: string, repo: string, bugs: string}} url Various URLs relating to the library.
+ */
+
+/**
+ *
+ * @param {string} name The name of the library.
+ * @returns {LibraryDefinition} The library object.
+ */
+export function getLibrary(name) {
+  if (libraries[name]) {
+    return libraries[name]
+  }
+
+  // TODO: Check aliases and/or use an algorithm such as the
+  //       Levenshtein distance to find the nearest match.
+
+  throw new Error(`[LibraryService] Could not find library: ${name}`)
+}
+
+/**
+ * Ensure that the structure of the JSON is as we expect it to be,
+ * including required fields etc.
+ *
+ * @param {Object} library The parsed library JSON file.
+ * @returns {LibraryDefinition} The validated library object.
+ * @throws If certain fields are missing or of the wrong type.
+ */
+function _validateLibrary(library) {
+  if (typeof library !== 'object') {
+    throw new TypeError('Object expected')
+  }
+
+  if (typeof library.name === 'undefined') {
+    throw new Error('Field "name" required')
+  }
+
+  if (typeof library.url === 'undefined') {
+    throw new Error('Field "url" required')
+  }
+
+  if (typeof library.fields === 'undefined') {
+    throw new Error('Field "fields" required')
+  }
+
+  if (!Array.isArray(library.fields)) {
+    throw new TypeError('Field "fields" must be of type "Array"')
+  }
+
+  if (!Array.isArray(library.tags)) {
+    library.tags = []
+  }
+
+  if (typeof library.colour === 'undefined') {
+    library.colour = 'RANDOM'
+  }
+
+  if (library.author && library.author.avatar) {
+    library.author.avatar = AVATAR_BASE_URL + library.author.avatar
+  }
+
+  return library
+}