Возможность подсветки синтаксиса «dotless dotfiles» на GitHub

Question

Я управляю своими дотфами, используя Git и GitHub, как и многие из вас. Я называю исходные файлы без точки (например, zshrc, а не .zshrc), чтобы я мог распознать их в Finder и сделать их символические ссылки с точкой;

ln -s ~/.dotfiles/gitignore_global ~/.gitignore_global 
ln -s ~/.dotfiles/zshrc ~/.zshrc 
# and so on... 

Когда я смотрю их удаленный репозиторий на сайте GitHub, синтаксис блик на мой gitconfig и gitignore_global являются недействительными, а другие .gitconfig правильно окрашены. Однако мой zshrc имеет подсветку синтаксиса, хотя он не содержит точки в его названии.

Я хотел бы выделить gitconfig и gitignore_global как .gitconfig и .gitignore. Есть ли способ достичь этого?

Заранее спасибо.

Answer 1

Внутри Github использует Linguist library для определения статистики языка вашего репозитория и для подсветки синтаксиса ваших файлов при просмотре на веб-сайте Github. Однако, как вы заметили, некоторые синтаксисы неверно определены, например, ваши файлы gitconfig и gitignore_global, вероятно, потому, что точка отсутствует перед именем файла.

Чтобы вручную установить подсветку синтаксиса в своих файлах, вы можете добавить emacs или vim modeline в один комментарий файла в любом месте файла. Библиотека Linguist обнаружит ее во время разбора вашего файла, и подсветка синтаксиса по вашему выбору будет включена.

Таким образом, чтобы точно ответить вам вопрос, если вы хотите, чтобы подсветка синтаксиса файла gitconfig (то есть в качестве основной синтаксис файла INI, вы можете добавить один из этих ModeLines в любом месте внутри:

ВИМ режимной_строки:

# vim: set filetype=dosini: 

Emacs режимной_строки:

# -*- mode: ini;-*- 

Эта функция документирована на Linguist Github Page.

Для файла gitignore_global я не знаю о наличии подсветки синтаксиса для файлов .gitignore.