Go to file
mrsdizzie 4563eb873d
Support unicode emojis and remove emojify.js (#11032)
* Support unicode emojis and remove emojify.js

This PR replaces all use of emojify.js and adds unicode emoji support to various areas of gitea.

This works in a few ways:

First it adds emoji parsing support into gitea itself. This allows us to

 * Render emojis from valid alias (😄)
 * Detect unicode emojis and let us put them in their own class with proper aria-labels and styling
 * Easily allow for custom "emoji"
 * Support all emoji rendering and features without javascript
 * Uses plain unicode and lets the system render in appropriate emoji font
 * Doesn't leave us relying on external sources for updates/fixes/features

That same list of emoji is also used to create a json file which replaces the part of emojify.js that populates the emoji search tribute. This file is about 35KB with GZIP turned on and I've set it to load after the page renders to not hinder page load time (and this removes loading emojify.js also)

For custom "emoji" it uses a pretty simple scheme of just looking for /emojis/img/name.png where name is something a user has put in the "allowed reactions" setting we already have. The gitea reaction that was previously hard coded into a forked copy of emojify.js is included and works as a custom reaction under this method.

The emoji data sourced here is from https://github.com/github/gemoji which is the gem library Github uses for their emoji rendering (and a data source for other sites). So we should be able to easily render any emoji and :alias: that Github can, removing any errors from migrated content. They also update it as well, so we can sync when there are new unicode emoji lists released.

I've included a slimmed down and slightly modified forked copy of https://github.com/knq/emoji to make up our own emoji module. The code is pretty straight forward and again allows us to have a lot of flexibility in what happens.

I had seen a few comments about performance in some of the other threads if we render this ourselves, but there doesn't seem to be any issue here. In a test it can parse, convert, and render 1,000 emojis inside of a large markdown table in about 100ms on my laptop (which is many more emojis than will ever be in any normal issue). This also prevents any flickering and other weirdness from using javascript to render some things while using go for others.

Not included here are image fall back URLS. I don't really think they are necessary for anything new being written in 2020. However, managing the emoji ourselves would allow us to add these as a feature later on if it seems necessary.

Fixes: https://github.com/go-gitea/gitea/issues/9182
Fixes: https://github.com/go-gitea/gitea/issues/8974
Fixes: https://github.com/go-gitea/gitea/issues/8953
Fixes: https://github.com/go-gitea/gitea/issues/6628
Fixes: https://github.com/go-gitea/gitea/issues/5130

* add new shared function emojiHTML

* don't increase emoji size in issue title

* Update templates/repo/issue/view_content/add_reaction.tmpl

Co-Authored-By: 6543 <6543@obermui.de>

* Support for emoji rendering in various templates

* Render code and review comments as they should be

* Better way to handle mail subjects

* insert unicode from tribute selection

* Add template helper for plain text when needed

* Use existing replace function I forgot about

* Don't include emoji greater than Unicode Version 12

Only include emoji and aliases in JSON

* Update build/generate-emoji.go

* Tweak regex slightly to really match everything including random invisible characters. Run tests for every emoji we have

* final updates

* code review

* code review

* hard code gitea custom emoji to match previous behavior

* Update .eslintrc

Co-Authored-By: silverwind <me@silverwind.io>

* disable preempt

Co-authored-by: silverwind <me@silverwind.io>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
2020-04-28 15:05:39 -03:00
.github Improve stale message (#9920) 2020-01-22 12:55:27 +02:00
assets Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
build Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
cmd Return error for authorized_keys and mergebase problems (#10990) 2020-04-08 02:04:19 -03:00
contrib Add gitea-vet (#10948) 2020-04-05 07:20:50 +01:00
custom/conf Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
docker Fix latest docker image haven't include static files. (#9252) 2019-12-05 12:18:28 -05:00
docs Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
integrations Make the PushCreate test declarative (#11229) 2020-04-28 09:32:23 +01:00
models make pagination optional for notifications (#10714) 2020-04-21 22:21:46 +01:00
modules Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
options [skip ci] Updated translations via Crowdin 2020-04-27 23:43:08 +00:00
public Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
routers Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
services Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
snap Remove explicit 'generate' calls, fix release task (#9288) 2019-12-08 18:56:59 +02:00
templates Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
vendor Use markdown frontmatter to provide Table of contents, language and frontmatter rendering (#11047) 2020-04-24 14:22:36 +01:00
web_src Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
.changelog.yml Changelog 1.11.0 (#10204) (#10211) 2020-02-10 11:16:31 -05:00
.drone.yml Skip frontend build where unnecessary (#11159) 2020-04-20 15:13:38 -04:00
.editorconfig move CSS build to webpack (#9983) 2020-01-28 07:30:39 +00:00
.eslintrc Support unicode emojis and remove emojify.js (#11032) 2020-04-28 15:05:39 -03:00
.gitattributes Rename scripts to build and add revive command as a new build tool command (#10942) 2020-04-03 22:29:12 +03:00
.gitignore Use /tmp for test repositories (#11126) 2020-04-19 14:17:02 +03:00
.golangci.yml Improve push update options (#10105) 2020-02-02 15:27:34 -05:00
.ignore remove promise-polyfill (#9812) 2020-01-16 22:52:07 +00:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06:00
.npmrc add package-lock=true in .npmrc (#9736) 2020-01-13 00:11:43 +01:00
.revive.toml refactor: replace lint to revive (#5422) 2018-12-03 09:28:46 -05:00
.stylelintrc Disallow leading zeroes in Less (#10407) 2020-02-23 13:48:27 -03:00
BSDmakefile Add BSDmakefile to prevent errors when `make` is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
CHANGELOG.md Changelog v1.11.4 (#10916) (#10917) 2020-04-01 12:59:05 -04:00
CONTRIBUTING.md move CSS build to webpack (#9983) 2020-01-28 07:30:39 +00:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile go 1.14 (#10467) 2020-03-20 10:29:31 -04:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Update Owners for upcoming year (#9290) 2019-12-07 21:51:55 -05:00
Makefile Use /tmp for test repositories (#11126) 2020-04-19 14:17:02 +03:00
README.md go 1.14 (#10467) 2020-03-20 10:29:31 -04:00
README_ZH.md update discord link (#10455) 2020-02-25 12:36:45 -05:00
build.go Add gitea-vet (#10948) 2020-04-05 07:20:50 +01:00
go.mod Use markdown frontmatter to provide Table of contents, language and frontmatter rendering (#11047) 2020-04-24 14:22:36 +01:00
go.sum Vendor Update: go-gitlab v0.22.1 -> v0.31.0 (#11136) 2020-04-19 21:23:05 +01:00
main.go Prevent support libraries from compiling into Gitea (#10964) 2020-04-05 11:35:02 +08:00
package-lock.json Update JS dependencies, highlight.js 10.0.0 (#11195) 2020-04-24 21:13:01 +02:00
package.json Update JS dependencies, highlight.js 10.0.0 (#11195) 2020-04-24 21:13:01 +02:00
semantic.json Update JS dependencies (#10450) 2020-02-25 01:56:59 -03:00
webpack.config.js Move syntax highlighting to web worker (#11017) 2020-04-13 16:02:31 +03:00

README.md

简体中文

logo Gitea - Git with a cup of tea

Build Status Join the Discord chat at https://discord.gg/Gitea codecov Go Report Card GoDoc GitHub release Help Contribute to Open Source Become a backer/sponsor of gitea License: MIT Crowdin

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. Using Go, this can be done with an independent binary distribution across all platforms which Go supports, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. Want to try it before doing anything else? Do it with the online demo! This project has been forked from Gogs since 2016.11 but changed a lot.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if sqlite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go 1.12 or greater.
  • make frontend which requires Node.js 10 or greater.

If pre-built frontend files are present it is possible to only build the backend:

	TAGS="bindata" make backend

More info: https://docs.gitea.io/en-us/install-from-source/

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server, or forum!

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark