Gitter — рождение ценного апплета-клиента GitHub

GitHub Апплет WeChat

0. Предисловие

Ну, большинство людей может подумать, что когда они приходят, зачем изобретать велосипед?Сторонний клиент GitHub уже прогнил. Действительно, поначалу я чувствовал то же самое и задавался вопросом, действительно ли есть смысл снова делать такой проект. После размышлений об этом снова и снова следующие причины также определяют мою готовность сделать сторонний клиент GitHub, который меня удовлетворяет.

  • Для автора, который часто обращает внимание на список GitHub Trending, существует острая необходимость в более простом способе следить за последними технологическими тенденциями GitHub в любое время и в любом месте;

  • Внешний вид и функции некоторых существующих клиентов апплета GitHub не могут удовлетворить требования автора;

  • Я слышал, что никто не хочет разрабатывать iOS, так почему бы не освоить новый навык разработки?

  • На самом деле причин не так уж и много.Если хочешь сделать, то делай.Самое главное - быть счастливым.

1. Gitter

image

  • Гитхаб:GitHub.com/Хуан Цзянькэ…, возможно, самый красивый клиент апплета GitHub на данный момент, добро пожаловать, звездочка

  • Источники данных:GitHub API v3

На данный момент реализованы следующие функции:

  • Просмотр трендов в режиме реального времени

  • показать список пользователей

  • Репозиторий и поиск пользователей

  • Склад: отображение сведений, отображение README.md, пометка/снятие пометки, разветвление, отображение участников, просмотр содержимого файла хранилища

  • Разработчик: Follow/Unfollow, показать подписчиков/подписчиков пользователя

  • Проблема: просмотреть список проблем, добавить проблему, добавить комментарий к проблеме.

  • Делитесь репозиториями, разработчики

  • ...

Первоначальный замысел Gitter не в том, чтобы скопировать все функции веб-страницы в апплет, потому что такой опыт будет не очень дружелюбным.Например, автор не хочет читать код на мобильном телефоне, он будет быть очень болезненной вещью.

С точки зрения обеспечения пользовательского опыта интересно позволить пользователям получать то, что они хотят, более простым способом.

2. Разведка

Технический отбор

Впервые я почувствовал, что я такой незначительный в огромном мире фронтенда.

Когда я решил сделать этот проект, я начал безостановочный выбор технологий, но передо мной так много вариантов, и я должен чувствовать, что мир фронтенда действительно захватывающий.

  • Собственная разработка: в основном сдалась в начале, опыт разработки очень недружественный;

  • WePY: Ранее с использованием этого фреймворка была разработана небольшая программа,Поэтический писатель, надо сказать, ям очень много, знает каждый, кто ими пользовался;

  • mpvue: Используя Vue для разработки небольших программ, я лично чувствую, что документация не очень полная, а недавнее обслуживание относительно меньше, можно ли это стабилизировать?

  • Taro: Используя способ React для разработки небольшой программы, поддержка небольшого партнера команды TARO действительно усердна, и это также очень терпеливое решение.Все достаточно полно, опыт разработки также отличный, вы также можете создать многоконечный код ( пока не пробовал)

После хождения по магазинам, после периода проб и попыток наступить на яму и синтезировать свои текущие возможности, я наконец определился с техническим выбором Gitter:

Taro + Taro UI+ Редукс + Облачная разработка Node.js

дизайн страницы

На самом деле, как кодер, я всегда хотел найти девушку-дизайнера пользовательского интерфейса в жены (должен быть кодер, который думает так же, как я). Теперь подумайте об этом, код — это еще не вся жизнь, теперь я очень счастлив.

Возвращаясь к теме, что делать, если у меня нет дизайна страницы жены-дизайнера? В конце концов, то, что я хочу, — это ценный апплет GitHub.

Ну не паникуйте, молча достал Фотошоп и Скетч, о которых я давно молчу. Я не осмеливаюсь сказать, насколько хороши мои дизайнерские способности. Дизайн Gitter может, по крайней мере, сделать автора счастливым. Если какой-либо энтузиаст дизайна хочет улучшить дизайн Gitter, добро пожаловать и добро пожаловать!

3. Развитие

Talk is cheap. Show me the code.

Как техническая статья, как можно меньше кода.

Здесь я в основном пишу о нескольких подводных камнях.Как новичок во фронтенде, я считаю, что все читатели - предшественники автора, и надеюсь дать больше советов!

Trending

Вскоре после выхода на стадию разработки я столкнулся с первой ямой.GitHub не предоставляет API для списков трендов! ! !

Я не слишком много думал о том, почему GitHub не предоставил этот API, а только о том, как заполнить эту дыру как можно скорее. Попробуйте сначалаScrapyНапишите сканер для регулярного обхода и сохранения информации списка трендов на веб-странице для использования апплетом, но в конце концов отказался от этой практики, потому что у автора нет сервера и зарегистрированного доменного имени, а также облачная разработка апплета поддерживает только развертывание Node..js.

Сила открытого исходного кода все еще сильна, и, наконец, ее нашлиgithub-trending-api, с некоторыми изменениями, он был успешно развернут на бэкенде разработки Mini Program Cloud, Здесь я хотел бы поблагодарить оригинального автора за его усилия.

  • Сканирование популярных репозиториев

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,

});

})

);

}
  • Сканирование популярных разработчиков
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')}`,

},

});

});
}
  • Облачная функция списка трендов
// 云函数入口函数
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 в основном включает следующие решения:

  • wxParse: Автор последнего коммита уже два года назад, после его попытки, да и вообще он был признан не подходящим в качестве разрешения README.md

  • wemark: отличная библиотека рендеринга Markdown для апплета WeChat, но после того, как автор попробовал, я обнаружил, что синтаксический анализ README.md неидеален.

  • towxml: В настоящее время это самая совершенная библиотека рендеринга Markdown для апплета WeChat, которая может почти идеально анализировать и отображать README.md.

В части синтаксического анализа Markdown в конце также используется towxml, но обнаружено, что производительность синтаксического анализа в настоящее время не очень высока, а синтаксический анализ некоторых относительно больших данных выходит за пределы диапазона, который может выдержать апплет. заботливый автор(sbfkcel) обеспечивает серверную поддержку, спасибо автору за его старания!

  • Облачные функции парсинга Markdown
const Towxml = require('towxml');
const towxml = new Towxml();

// 云函数入口函数
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({
      // 要调用的云函数名称
      name: 'parse',
      // 传递给云函数的event参数
      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 в этом проекте. В начале автор думал, что все запросы к интерфейсу должны работать через Redux, позже я узнал, что не все операции должны использовать 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, что ж, впереди еще долгий путь изучения.

4. Вывод

Когда первая версия Гиттера прошла обзор, я был очень взволнован, как и мой собственный ребенок, наблюдая, как он растет понемногу, я также получил удовольствие от процесса такого проекта с нуля, поэтому я хотел бы выразить свою благодарность тем, кто мне помог.

Конечно, текущие функции и опыт могут быть несовершенными, и я надеюсь, что каждый может поделиться ценным мнением Gitter находится на пути к совершенству и надеется на вас!

Наконец, я надеюсь, что апплет Gitter может вам помочь!

Категории