From e87e644f55c7409ae246433c9d4e3da1f8cdc45e Mon Sep 17 00:00:00 2001 From: Ben Myers Date: Sat, 16 Apr 2022 11:28:02 -0500 Subject: [PATCH] Introduce JSDocs for data.js --- src/data.js | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/src/data.js b/src/data.js index 4c3d60d3..ade0033f 100644 --- a/src/data.js +++ b/src/data.js @@ -1,5 +1,25 @@ -// keep it commonjs export -// Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68 +/** + * @typedef Person + * A single contributor with a /uses page. + * Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68 + * @property {string} name - contributor's name + * @property {string} description - tagline for contributor + * @property {string} url - link to contributor's /uses page + * @property {string} country - flag emoji for contributor's country + * @property {string} [twitter] - optional Twitter username (beginning with `@`) + * @property {string} [emoji] - some emoji corresponding to the contributor + * @property {'apple' | 'windows' | 'linux' | 'bsd'} [computer] + * @property {'iphone' | 'android' | 'windowsphone' | 'flipphone'} [phone] + * @property {string[]} tags - list of tools or other tags the contributor uses + */ + +/** + * List of all contributors with /uses pages. + * @type {Person[]} + * Data is validated against the following schema https://github.com/wesbos/awesome-uses/blob/master/scripts/utils.js#L53-L68 + * + * Keep this a commonjs export. + */ module.exports = [ { name: 'Ahmed Adebisi',