GitHub 倉(cāng)庫(kù)按大小排序

mdluo 發(fā)布于2019-08-26 12:17 / 438人閱讀

摘要：起因?qū)τ诖a初學(xué)者來(lái)說(shuō)，是一個(gè)很好的網(wǎng)站。所以我想到了一個(gè)方法將自己過(guò)的所有優(yōu)秀項(xiàng)目按倉(cāng)庫(kù)大小代碼量進(jìn)行排序，從代碼量小的項(xiàng)目開(kāi)始研究，逐步提升代碼能力。

起因

??對(duì)于代碼初學(xué)者來(lái)說(shuō)，GitHub 是一個(gè)很好的網(wǎng)站。在這里，他們可以學(xué)習(xí)如何更好地寫(xiě)代碼并提高代碼能力，學(xué)習(xí)編碼規(guī)范，各種框架......
??然而對(duì)于像我一下的初學(xué)者來(lái)講，有時(shí)候不知道要如何從 GitHub 的優(yōu)秀項(xiàng)目中學(xué)習(xí)、要從何開(kāi)始閱讀源碼。
??所以我想到了一個(gè)方法: 將自己 star 過(guò)的所有優(yōu)秀項(xiàng)目按倉(cāng)庫(kù)大小( 代碼量 )進(jìn)行排序，從代碼量小的項(xiàng)目開(kāi)始研究，逐步提升代碼能力。

準(zhǔn)備

想好了項(xiàng)目的目的，列出以下幾種需要用到的技術(shù):

JavaScript

NodeJs

GitHub API

并找到了一個(gè)極小的 GitHub API 封裝工具: gh.js。

開(kāi)始 安裝項(xiàng)目依賴包

# 初始化項(xiàng)目
npm init 

npm install gh.js # 封裝過(guò)的 GitHub API
npm install chalk # 美化終端命令行工具的字體顏色
npm install ora   # 優(yōu)雅的終端加載條

創(chuàng)建項(xiàng)目入口 index.js

const GitHub = require("gh.js")

/**
 * sortByStarredSize
 * Sort your personal starred repos by size.
 *
 * @name sortByStarredSize
 * @function
 * @param {String} username The GitHub username.
 * @param {String} token An optional access token.
 * @param {Function} callback The callback function.
 * @return {gh.js} The `gh.js` instance.
 */
function sortByStarredSize (username, token, callback) {
  if (typeof token === "function") {
    callback = token
    token = undefined
  }

  const gh = new GitHub({ token: token })
  gh.get(`users/${username}/starred`, { all: true }, (err, repos) => {
    if (err) { return callback(err) }
    repos.sort(function (a, b) {
      return a.size > b.size ? 1 : -1
    })
    callback(null, repos)
  })

  return gh
}

module.exports = sortByStarredSize

創(chuàng)建測(cè)試樣例 example.js

const sortGhStarredSize = require(".")

// 以大神 Linus Torvalds 的GitHub用戶名torvalds為例
const username = "torvalds"

sortGhStarredSize(username, (err, repos) => {
  console.log(err || repos.map(function(c) {
    return `${c.full_name} => ${c.size} kb`
  }).join("
"))
})

運(yùn)行結(jié)果如下: