0. 前言
嗯持灰，可能一進來大部分人都會覺得，為什么還會有人重復(fù)造輪子负饲，GitHub第三方客戶端都已經(jīng)爛大街啦堤魁。確實，一開始我自己也是這么覺得的返十，也問過自己是否真的有意義再去做這樣一個項目妥泉。思考再三，以下原因也決定了我愿意去做一個讓自己滿意的GitHub第三方客戶端洞坑。
對于時常關(guān)注GitHub Trending列表的筆者來說盲链，迫切需要一個更簡單的方式隨時隨地去跟隨GitHub最新的技術(shù)潮流；
已有的一些GitHub小程序客戶端顏值與功能并不能滿足筆者的要求迟杂；
聽說iOS開發(fā)沒人要了刽沾，掌握一門新的開發(fā)技能，又何嘗不可排拷？
其實也沒那么多原因侧漓，既然想做，那就去做监氢，開心最重要布蔗。
1. Gitter
GitHub：https://github.com/huangjianke/Gitter藤违，可能是目前顏值最高的GitHub小程序客戶端，歡迎star
數(shù)據(jù)來源：GitHub API v3
目前實現(xiàn)的功能有：
實時查看Trending
顯示用戶列表
倉庫和用戶的搜索
倉庫：詳情展示纵揍、README.md展示纺弊、Star/Unstar、Fork骡男、Contributors展示、查看倉庫文件內(nèi)容
開發(fā)者：Follow/Unfollow傍睹、顯示用戶的followers/following
Issue：查看issue列表隔盛、新增issue、新增issue評論
分享倉庫拾稳、開發(fā)者
...
Gitter的初衷并不是想把網(wǎng)頁端所有功能照搬到小程序上吮炕，因為那樣的體驗并不會很友好，比如說访得，筆者自己也不想在手機上閱讀代碼龙亲，那將會是一件很痛苦的事。
在保證用戶體驗的前提下悍抑，讓用戶用更簡單的方式得到自己想要的鳄炉，這是一件有趣的事。
2. 探索篇
技術(shù)選型
第一次覺得搜骡，在茫茫前端的世界里拂盯，自己是那么渺小。
當(dāng)決定去做這個項目的時候记靡，就開始了馬不停蹄的技術(shù)選型谈竿，但擺在自己面前的選擇是那么的多，也不得不感慨摸吠，前端的世界空凸，真的很精彩。
原生開發(fā)：基本上一開始就放棄了寸痢，開發(fā)體驗很不友好呀洲；
WePY：之前用這個框架已經(jīng)開發(fā)過一個小程序，詩詞墨客轿腺，不得不說两嘴，坑是真多，用過的都知道族壳；
mpvue：用Vue的方式去開發(fā)小程序憔辫，個人覺得文檔并不是很齊全，加上近期維護比較少仿荆，可能是趨于穩(wěn)定了贰您？
Taro：用React的方式去開發(fā)小程序坏平，Taro團隊的小伙伴維護真的很勤快，也很耐心的解答大家疑問锦亦，文檔也比較齊全舶替，開發(fā)體驗也很棒，還可以一鍵生成多端運行的代碼(暫沒嘗試)
貨比三家杠园，經(jīng)過一段時間的嘗試及采坑顾瞪，綜合自己目前的能力，最終確定了Gitter的技術(shù)選型：
Taro + Taro UI + Redux + 云開發(fā) Node.js
頁面設(shè)計
其實抛蚁，作為一名Coder陈醒，曾經(jīng)一直想找個UI設(shè)計師妹子做老婆的(肯定有和我一樣想法的Coder)，多搭配啊∏扑Γ現(xiàn)在想想钉跷，code不是生活的全部，現(xiàn)在的我一樣很幸福肚逸。
話回正題爷辙，沒有設(shè)計師老婆頁面設(shè)計怎么辦？畢竟筆者想要的是一款高顏值的GitHub小程序朦促。
嗯膝晾，不慌，默默的拿出了筆者沉寂已久的Photoshop和Sketch务冕。不敢說自己的設(shè)計能力如何玷犹，Gitter的設(shè)計至少是能讓筆者自己心情愉悅的，倘若哪位設(shè)計愛好者想對Gitter的設(shè)計進行改良洒疚，歡迎歡迎歹颓，十二分的歡迎！
3. 開發(fā)篇
Talk is cheap. Show me the code.
作為一篇技術(shù)性文章油湖，怎可能少得了代碼巍扛。
在這里主要寫寫幾個采坑點，作為一個前端小白乏德，相信各位讀者均是筆者的前輩撤奸，還望多多指教！
Trending
進入開發(fā)階段沒多久喊括，就遇到了第一個坑胧瓜。GitHub居然沒有提供Trending列表的API！ＶＪ病府喳！
也沒有過多的去想GitHub為什么不提供這個API，只想著怎么去盡快填好這個坑蘑拯。一開始嘗試使用[Scrapy][10]寫一個爬蟲對網(wǎng)頁端的Trending列表信息進行定時爬取及存儲供小程序端使用钝满，但最終還是放棄了這個做法兜粘，因為筆者并沒有服務(wù)器與已經(jīng)備案好的域名，小程序的云開發(fā)也只支持Node.js的部署弯蚜。
開源的力量還是強大孔轴，最終找到了[github-trending-api][11]，稍作修改碎捺，成功部署到小程序云開發(fā)后臺路鹰，在此，感謝原作者的努力收厨。
- 爬取Trending Repositories
async function fetchRepositories({
language = '',
since = 'daily',
} = {}) {
const url = `${GITHUB_URL}/trending/${language}?since=${since}`;
const data = await fetch(url);
const $ = cheerio.load(await data.text());
return (
$('.repo-list li')
.get()
// eslint-disable-next-line complexity
.map(repo => {
const $repo = $(repo);
const title = $repo
.find('h3')
.text()
.trim();
const relativeUrl = $repo
.find('h3')
.find('a')
.attr('href');
const currentPeriodStarsString =
$repo
.find('.float-sm-right')
.text()
.trim() || /* istanbul ignore next */ '';
const builtBy = $repo
.find('span:contains("Built by")')
.parent()
.find('[data-hovercard-type="user"]')
.map((i, user) => {
const altString = $(user)
.children('img')
.attr('alt');
const avatarUrl = $(user)
.children('img')
.attr('src');
return {
username: altString
? altString.slice(1)
: /* istanbul ignore next */ null,
href: `${GITHUB_URL}${user.attribs.href}`,
avatar: removeDefaultAvatarSize(avatarUrl),
};
})
.get();
const colorNode = $repo.find('.repo-language-color');
const langColor = colorNode.length
? colorNode.css('background-color')
: null;
const langNode = $repo.find('[itemprop=programmingLanguage]');
const lang = langNode.length
? langNode.text().trim()
: /* istanbul ignore next */ null;
return omitNil({
author: title.split(' / ')[0],
name: title.split(' / ')[1],
url: `${GITHUB_URL}${relativeUrl}`,
description:
$repo
.find('.py-1 p')
.text()
.trim() || /* istanbul ignore next */ '',
language: lang,
languageColor: langColor,
stars: parseInt(
$repo
.find(`[href="${relativeUrl}/stargazers"]`)
.text()
.replace(',', '') || /* istanbul ignore next */ 0,
10
),
forks: parseInt(
$repo
.find(`[href="${relativeUrl}/network"]`)
.text()
.replace(',', '') || /* istanbul ignore next */ 0,
10
),
currentPeriodStars: parseInt(
currentPeriodStarsString.split(' ')[0].replace(',', '') ||
/* istanbul ignore next */ 0,
10
),
builtBy,
});
})
);
}
- 爬取Trending Developers
async function fetchDevelopers({ language = '', since = 'daily' } = {}) {
const data = await fetch(
`${GITHUB_URL}/trending/developers/${language}?since=${since}`
);
const $ = cheerio.load(await data.text());
return $('.explore-content li')
.get()
.map(dev => {
const $dev = $(dev);
const relativeUrl = $dev.find('.f3 a').attr('href');
const name = getMatchString(
$dev
.find('.f3 a span')
.text()
.trim(),
/^\((.+)\)$/i
);
$dev.find('.f3 a span').remove();
const username = $dev
.find('.f3 a')
.text()
.trim();
const $repo = $dev.find('.repo-snipit');
return omitNil({
username,
name,
url: `${GITHUB_URL}${relativeUrl}`,
avatar: removeDefaultAvatarSize($dev.find('img').attr('src')),
repo: {
name: $repo
.find('.repo-snipit-name span.repo')
.text()
.trim(),
description:
$repo
.find('.repo-snipit-description')
.text()
.trim() || /* istanbul ignore next */ '',
url: `${GITHUB_URL}${$repo.attr('href')}`,
},
});
});
}
- Trending列表云函數(shù)
// 云函數(shù)入口函數(shù)
exports.main = async (event, context) => {
const { type, language, since } = event
let res = null;
let date = new Date()
if (type === 'repositories') {
const cacheKey = `repositories::${language || 'nolang'}::${since ||
'daily'}`;
const cacheData = await db.collection('repositories').where({
cacheKey: cacheKey
}).orderBy('cacheDate', 'desc').get()
if (cacheData.data.length !== 0 &&
((date.getTime() - cacheData.data[0].cacheDate) < 1800 * 1000)) {
res = JSON.parse(cacheData.data[0].content)
} else {
res = await fetchRepositories({ language, since });
await db.collection('repositories').add({
data: {
cacheDate: date.getTime(),
cacheKey: cacheKey,
content: JSON.stringify(res)
}
})
}
} else if (type === 'developers') {
const cacheKey = `developers::${language || 'nolang'}::${since || 'daily'}`;
const cacheData = await db.collection('developers').where({
cacheKey: cacheKey
}).orderBy('cacheDate', 'desc').get()
if (cacheData.data.length !== 0 &&
((date.getTime() - cacheData.data[0].cacheDate) < 1800 * 1000)) {
res = JSON.parse(cacheData.data[0].content)
} else {
res = await fetchDevelopers({ language, since });
await db.collection('developers').add({
data: {
cacheDate: date.getTime(),
cacheKey: cacheKey,
content: JSON.stringify(res)
}
})
}
}
return {
data: res
}
}
Markdown解析
嗯悍引，這是一個大坑。
在做技術(shù)調(diào)研的時候帽氓，發(fā)現(xiàn)小程序端Markdown解析主要有以下方案：
wxParse：作者最后一次提交已是兩年前了，經(jīng)過自己的嘗試俩块，也確實發(fā)現(xiàn)已經(jīng)不適合如README.md的解析
wemark：一款很優(yōu)秀的微信小程序Markdown渲染庫黎休，但經(jīng)過筆者嘗試之后，發(fā)現(xiàn)對README.md的解析并不完美
towxml：目前發(fā)現(xiàn)是微信小程序最完美的Markdown渲染庫玉凯，已經(jīng)能近乎完美的對README.md進行解析并展示
在Markdown解析這一塊势腮，最終采用的也是towxml，但發(fā)現(xiàn)在解析性能這一塊漫仆，目前并不是很優(yōu)秀捎拯，對一些比較大的數(shù)據(jù)解析也超出了小程序所能承受的范圍，還好貼心的作者(sbfkcel)提供了服務(wù)端的支持盲厌，在此感謝作者的努力署照！
- Markdown解析云函數(shù)
const Towxml = require('towxml');
const towxml = new Towxml();
// 云函數(shù)入口函數(shù)
exports.main = async (event, context) => {
const { func, type, content } = event
let res
if (func === 'parse') {
if (type === 'markdown') {
res = await towxml.toJson(content || '', 'markdown');
} else {
res = await towxml.toJson(content || '', 'html');
}
}
return {
data: res
}
}
- markdown.js組件
import Taro, { Component } from '@tarojs/taro'
import PropTypes from 'prop-types'
import { View, Text } from '@tarojs/components'
import { AtActivityIndicator } from 'taro-ui'
import './markdown.less'
import Towxml from '../towxml/main'
const render = new Towxml()
export default class Markdown extends Component {
static propTypes = {
md: PropTypes.string,
base: PropTypes.string
}
static defaultProps = {
md: null,
base: null
}
constructor(props) {
super(props)
this.state = {
data: null,
fail: false
}
}
componentDidMount() {
this.parseReadme()
}
parseReadme() {
const { md, base } = this.props
let that = this
wx.cloud.callFunction({
// 要調(diào)用的云函數(shù)名稱
name: 'parse',
// 傳遞給云函數(shù)的event參數(shù)
data: {
func: 'parse',
type: 'markdown',
content: md,
}
}).then(res => {
let data = res.result.data
if (base && base.length > 0) {
data = render.initData(data, {base: base, app: this.$scope})
}
that.setState({
fail: false,
data: data
})
}).catch(err => {
console.log('cloud', err)
that.setState({
fail: true
})
})
}
render() {
const { data, fail } = this.state
if (fail) {
return (
<View className='fail' onClick={this.parseReadme.bind(this)}>
<Text className='text'>load failed, try it again?</Text>
</View>
)
}
return (
<View>
{
data ? (
<View>
<import src='../towxml/entry.wxml' />
<template is='entry' data='{{...data}}' />
</View>
) : (
<View className='loading'>
<AtActivityIndicator size={20} color='#2d8cf0' content='loading...' />
</View>
)
}
</View>
)
}
}
Redux
其實，筆者在該項目中吗浩，對Redux的使用并不多建芙。一開始，筆者覺得所有的接口請求都應(yīng)該通過Redux操作懂扼，后面才發(fā)現(xiàn)禁荸，并不是所有的操作都必須使用Redux，最后阀湿，在本項目中赶熟，只有獲取個人信息的時候使用了Redux。
// 獲取個人信息
export const getUserInfo = createApiAction(USERINFO, (params) => api.get('/user', params))
export function createApiAction(actionType, func = () => {}) {
return (
params = {},
callback = { success: () => {}, failed: () => {} },
customActionType = actionType,
) => async (dispatch) => {
try {
dispatch({ type: `${customActionType }_request`, params });
const data = await func(params);
dispatch({ type: customActionType, params, payload: data });
callback.success && callback.success({ payload: data })
return data
} catch (e) {
dispatch({ type: `${customActionType }_failure`, params, payload: e })
callback.failed && callback.failed({ payload: e })
}
}
}
getUserInfo() {
if (hasLogin()) {
userAction.getUserInfo().then(()=>{
Taro.hideLoading()
Taro.stopPullDownRefresh()
})
} else {
Taro.hideLoading()
Taro.stopPullDownRefresh()
}
}
const mapStateToProps = (state, ownProps) => {
return {
userInfo: state.user.userInfo
}
}
export default connect(mapStateToProps)(Index)
export default function user (state = INITIAL_STATE, action) {
switch (action.type) {
case USERINFO:
return {
...state,
userInfo: action.payload.data
}
default:
return state
}
}
目前陷嘴，筆者對Redux還是處于一知半解的狀態(tài)映砖，嗯，學(xué)習(xí)的路還很長灾挨。
4. 結(jié)語篇
當(dāng)Gitter第一個版本通過審核的時候啊央，心情是很激動的眶诈，就像自己的孩子一樣，看著他一點一點的長大瓜饥，筆者也很享受這樣一個項目從無到有的過程逝撬，在此，對那些幫助過筆者的人一并表示感謝乓土。
當(dāng)然宪潮，目前功能和體驗上可能有些不大完善，也希望大家能提供一些寶貴的意見趣苏，Gitter走向完美的路上希望有你狡相！
最后，希望Gitter小程序能對你有所幫助食磕！
