Руководство Google по стилю написания кода на языке TypeScript (перевод руководства "Google TypeScript Style Guide")
С переводом руководства вы можете ознакомиться в нескольких вариантах:
- Markdown: google-typescript-style-guide-ru.md
- Веб-версия: https://olegbarabanov.github.io/google-typescript-style-guide-ru/
С оригинальным руководством по стилю вы можете ознакомиться по ссылке: https://google.github.io/styleguide/tsguide.html.
Если Вы нашли несоответствие, ошибку или неточность в переводе, вы можете оформить это в виде issue или предложить собственное исправление в виде pull request, либо написать переводчику по адресу [email protected].
В исходном варианте перевод представлен в файле google-typescript-style-guide-ru.md в формате Markdown и соответственно все изменения, касающиеся непосредственно перевода, а также различные примечания и дополнительные комментарии вносятся только в этот файл.
Оформление Markdown следует спецификации GitHub Flavored Markdown (GFM) но при этом в оформлении документа для сохранения единообразия не допускается использовать HTML разметку.
Веб-версия основана на фреймворке Primer.css и обладает следующими возможностями:
- Адаптивность под различные устройства;
- Поддержка темной темы при включенном "ночном режиме" в браузере;
- Привычный многим стиль оформления (т.к. Primer.css был изначально разработан для нужд GitHub).
Для сборки веб-страницы, вам необходимо выполнить следующие команды:
- Установить все зависимости командой
npm ci; - Запустить сборку командой
npm run build;
По завершению сборки, в директории /dist будут лежать готовые файлы веб-страницы документации.
Для разработки или предпросмотра предварительной веб-версии, вы можете запустить облегченный веб-сервер (WebPack DevServer) командой npm run serve.
Текст текущего перевода использует лицензию Creative Commons CC-By 3.0 License, как и оригинальные материалы от Google. См. https://creativecommons.org/licenses/by/3.0/ для подробностей.
