An open API service indexing awesome lists of open source software.

https://github.com/atls/raijin

Atlantis working toolset
https://github.com/atls/raijin

performance-optimization yarn-custom-bundle yarn3 yarn4

Last synced: 6 days ago
JSON representation

Atlantis working toolset

Awesome Lists containing this project

README

          

toolset-github-cover@2x 1

# Atlantis Raijin

[![Raijin Docs RU](https://img.shields.io/badge/Raijin%20Docs-RU-0b5fff)](README.md)
[![Raijin Docs EN](https://img.shields.io/badge/Raijin%20Docs-EN-1f8a70)](README_EN.md)

## Что это

Raijin — это подход к работе в едином инженерном контуре, поставляемый как кастомный Yarn-бандл `atls`
Он объединяет команды вокруг строгих стандартов и мощных контрактов, чтобы повышать предсказуемость поставки и реальную производительность

## Для кого

- Для команд, которые поддерживают несколько `Node.js`/`TypeScript` проектов
- Для разработчиков, которым нужен единый контракт команд в локальной среде и в `GitHub Actions`
- Для опенсорс и внутренних репозиториев, где важны предсказуемые проверки и обновления

## Что умеет Raijin

- Проверки кода: `check`, `lint`, `typecheck`, `test`, `checks *`
- Работа с изменениями: `files changed *`, `workspaces changed *`
- Сборка и выпуск: `service build`, `library build`, `release create`, `npm publish`
- Генераторы и служебные команды для инфраструктуры монорепозитория

## Быстрый старт

### Новый проект

```bash
yarn set version https://raw.githubusercontent.com/atls/raijin/master/yarn/cli/dist/yarn.mjs
yarn set version atls
```

Ожидаемый результат:

- В проекте появляется/обновляется `.yarn/releases/yarn.mjs`
- Команды `raijin` становятся доступны через `yarn`

### Обновление

```bash
yarn set version atls
```

Ожидаемый результат:

- Подтягивается актуальная версия бандла

### Проверка

```bash
yarn check
yarn files changed list
```

Ожидаемый результат:

- Команды выполняются без ошибки маршрутизации и с ожидаемым набором шагов

## Как использовать в чужом проекте

1. Подключите бандл по разделу [Быстрый старт](./docs/raijin/quickstart.ru.md)
2. Зафиксируйте изменения `.yarn/releases` и `.yarnrc.yml` в системе контроля версий
3. Обновляйте бандл командой `yarn set version atls` по мере выхода новых версий

## Где читать дальше

- RU (по умолчанию): [README.md](README.md)
- EN: [README_EN.md](README_EN.md)
- Индекс документации RU: [docs/README.ru.md](docs/README.ru.md)
- Индекс документации EN: [docs/README.md](docs/README.md)
- Роутер раздела Raijin: [docs/raijin/README.ru.md](docs/raijin/README.ru.md)
- Быстрый старт: [docs/raijin/quickstart.ru.md](docs/raijin/quickstart.ru.md)
- Карта команд: [docs/raijin/commands.ru.md](docs/raijin/commands.ru.md)
- Карта пакетов: [docs/raijin/packages.ru.md](docs/raijin/packages.ru.md)