Skip to content

Commit c5f4f48

Browse files
docs: support Russian documentation (#1495)
1 parent 2fee8d2 commit c5f4f48

File tree

6 files changed

+617
-0
lines changed

6 files changed

+617
-0
lines changed

docs/.vitepress/config.mts

+25
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,31 @@ export default defineConfig({
6666
}
6767
]
6868
}
69+
},
70+
ru: {
71+
label: 'Русский',
72+
lang: 'ru-RU',
73+
description: 'Git hooks made easy',
74+
link: '/ru/',
75+
themeConfig: {
76+
sidebar: [
77+
{ text: 'Введение', link: '/ru/' },
78+
{ text: 'Начало работы', link: '/ru/get-started' },
79+
{ text: 'Как использовать', link: '/ru/how-to' },
80+
{ text: 'Устранение неполадок', link: '/ru/troubleshoot' },
81+
{ text: 'Миграция с v4', link: '/ru/migrate-from-v4' },
82+
],
83+
docFooter: {
84+
prev: 'Предыдущая страница',
85+
next: 'Следующая страница'
86+
},
87+
outline: {
88+
label: 'Содержание страницы'
89+
},
90+
nav: [
91+
{ text: 'Sponsor', link: 'https://github.com/sponsors/typicode' }
92+
]
93+
}
6994
}
7095
}
7196
})

docs/ru/get-started.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Начало работы
2+
3+
## Установить
4+
5+
::: code-group
6+
7+
```shell [npm]
8+
npm install --save-dev husky
9+
```
10+
11+
```shell [pnpm]
12+
pnpm add --save-dev husky
13+
```
14+
15+
```shell [yarn]
16+
yarn add --dev husky
17+
# Добавить pinst ТОЛЬКО если ваш пакет не является закрытым
18+
yarn add --dev pinst
19+
```
20+
21+
```shell [bun]
22+
bun add --dev husky
23+
```
24+
25+
:::
26+
27+
## `husky init` (рекомендуется)
28+
29+
Команда `init` упрощает настройку husky в проекте. Она создает скрипт `pre-commit` в `.husky/` и обновляет скрипт `prepare` в `package.json`. Изменения можно внести позже в соответствии с вашим рабочим процессом.
30+
31+
::: code-group
32+
33+
```shell [npm]
34+
npx husky init
35+
```
36+
37+
```shell [pnpm]
38+
pnpm exec husky init
39+
```
40+
41+
```shell [yarn]
42+
# Из-за особых оговорок и различий с другими менеджерами пакетов,
43+
# обратитесь к разделу «Как использовать».
44+
```
45+
46+
```shell [bun]
47+
bunx husky init
48+
```
49+
50+
:::
51+
52+
## Попробуйте
53+
54+
Поздравляем! Вы успешно настроили свой первый Git hook всего одной командой 🎉. Давайте проверим:
55+
56+
```shell
57+
git commit -m "Keep calm and commit"
58+
# тестовый скрипт будет запускаться каждый раз при коммите
59+
```
60+
61+
## Несколько слов...
62+
63+
### Скриптинг
64+
65+
Хотя большую часть времени вы просто запускаете несколько команд `npm run` или `npx` в своих хуках, вы также можете записать их с помощью оболочки POSIX для пользовательских рабочих процессов.
66+
67+
Например, вот как можно линтинговать подготовленные файлы на каждом коммите, используя всего две строки кода оболочки и без внешней зависимости:
68+
69+
```shell
70+
# .husky/pre-commit
71+
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
72+
git update-index --again
73+
```
74+
75+
_Это простой, но рабочий пример, проверьте [lint-staged](https://github.com/lint-staged/lint-staged), если вам нужно больше._
76+
77+
### Отключение хуков
78+
79+
Husky не принудительно использует хуки Git. Его можно отключить глобально (`HUSKY=0`) или включить, если нужно. См. раздел [Как сделать](how-to) для ручной настройки и дополнительной информации.

0 commit comments

Comments
 (0)