Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: typicode/husky
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v9.1.5
Choose a base ref
...
head repository: typicode/husky
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: a2d942a670b3d6a04578005a0fd2dc310e511849
Choose a head ref
  • 6 commits
  • 14 files changed
  • 4 contributors

Commits on Aug 24, 2024

  1. Copy the full SHA
    c5f4f48 View commit details

Commits on Aug 27, 2024

  1. Copy the full SHA
    c3afd5f View commit details

Commits on Aug 29, 2024

  1. Copy the full SHA
    dcf3aed View commit details

Commits on Sep 6, 2024

  1. Copy the full SHA
    3b3e7f1 View commit details

Commits on Sep 11, 2024

  1. fix: add parens around the null coalescing operator to fix issues whe…

    …n npm_config_user_agent exists (#1519)
    dexmlee authored Sep 11, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    b4465ed View commit details
  2. 9.1.6

    typicode committed Sep 11, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    a2d942a View commit details
Showing with 1,291 additions and 44 deletions.
  1. +2 −2 bin.js
  2. +93 −39 docs/.vitepress/config.mts
  3. +79 −0 docs/es/get-started.md
  4. +335 −0 docs/es/how-to.md
  5. +81 −0 docs/es/index.md
  6. +65 −0 docs/es/migrate-from-v4.md
  7. +41 −0 docs/es/troubleshoot.md
  8. +79 −0 docs/ru/get-started.md
  9. +326 −0 docs/ru/how-to.md
  10. +80 −0 docs/ru/index.md
  11. +66 −0 docs/ru/migrate-from-v4.md
  12. +41 −0 docs/ru/troubleshoot.md
  13. +2 −2 package-lock.json
  14. +1 −1 package.json
4 changes: 2 additions & 2 deletions bin.js
Original file line number Diff line number Diff line change
@@ -15,12 +15,12 @@ if (a == 'init') {
w(n, JSON.stringify(o, 0, /\t/.test(s) ? '\t' : 2) + '\n')
p.stdout.write(i())
try { f.mkdirSync('.husky') } catch {}
w('.husky/pre-commit', p.env.npm_config_user_agent?.split('/')[0] ?? 'npm' + ' test\n')
w('.husky/pre-commit', (p.env.npm_config_user_agent?.split('/')[0] ?? 'npm') + ' test\n')
p.exit()
}

d = c => console.error(`${c} command is DEPRECATED`)
if (['add', 'set', 'uninstall'].includes(a)) { d(a); p.exit(1) }
if (a == 'install') d(a)

p.stdout.write(i(a == 'install' ? undefined : a))
p.stdout.write(i(a == 'install' ? undefined : a))
132 changes: 93 additions & 39 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,71 +1,125 @@
import { defineConfig } from 'vitepress'
import { defineConfig } from "vitepress";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Husky",
description: "Git hooks made easy",
head: [
['link', { rel: 'icon', href: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><text y=".9em" font-size="85">🐶</text></svg>' }],
[
"link",
{
rel: "icon",
href: 'data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><text y=".9em" font-size="85">🐶</text></svg>',
},
],
],
base: '/husky/',
base: "/husky/",
themeConfig: {
// outline: [2, 3],
socialLinks: [
{ icon: 'github', link: 'https://github.com/typicode/husky' },
{ icon: 'twitter', link: 'https://x.com/typicode' }
{ icon: "github", link: "https://github.com/typicode/husky" },
{ icon: "twitter", link: "https://x.com/typicode" },
],
// carbonAds: {
// code: 'CWYDP53L',
// placement: 'typicodegithubio',
// },
sidebar: [
{ text: 'Introduction', link: '/' },
{ text: 'Get Started', link: '/get-started' },
{ text: 'How To', link: '/how-to' },
{ text: 'Troubleshoot', link: '/troubleshoot' },
{ text: 'Migrate from v4', link: '/migrate-from-v4' },
],
nav: [
{ text: 'Sponsor', link: 'https://github.com/sponsors/typicode' }
]
{ text: "Introduction", link: "/" },
{ text: "Get Started", link: "/get-started" },
{ text: "How To", link: "/how-to" },
{ text: "Troubleshoot", link: "/troubleshoot" },
{ text: "Migrate from v4", link: "/migrate-from-v4" },
],
nav: [{ text: "Sponsor", link: "https://github.com/sponsors/typicode" }],
},
locales: {
root: {
label: 'English',
lang: 'en-US'
label: "English",
lang: "en-US",
},
zh: {
label: '简体中文',
lang: 'zh-hans',
description: '使 Git hooks 变得简单',
link: '/zh/',
label: "简体中文",
lang: "zh-hans",
description: "使 Git hooks 变得简单",
link: "/zh/",
themeConfig: {
sidebar: [
{ text: '简介', link: '/zh/' },
{ text: '快速开始', link: '/zh/get-started' },
{ text: '如何使用', link: '/zh/how-to' },
{ text: '故障排查', link: '/zh/troubleshoot' },
{ text: '从 v4 迁移', link: '/zh/migrate-from-v4' },
{ text: "简介", link: "/zh/" },
{ text: "快速开始", link: "/zh/get-started" },
{ text: "如何使用", link: "/zh/how-to" },
{ text: "故障排查", link: "/zh/troubleshoot" },
{ text: "从 v4 迁移", link: "/zh/migrate-from-v4" },
],
docFooter: {
prev: '上一页',
next: '下一页'
prev: "上一页",
next: "下一页",
},
outline: {
label: '页面导航'
label: "页面导航",
},
nav: [
{
text: 'v9.0.1',
text: "v9.0.1",
items: [
{
text: '更新日志',
link: 'https://github.com/typicode/husky/releases/tag/v9.0.1'
}
]
}
]
}
}
}
})
text: "更新日志",
link: "https://github.com/typicode/husky/releases/tag/v9.0.1",
},
],
},
],
},
},
ru: {
label: "Русский",
lang: "ru-RU",
description: "Git hooks made easy",
link: "/ru/",
themeConfig: {
sidebar: [
{ text: "Введение", link: "/ru/" },
{ text: "Начало работы", link: "/ru/get-started" },
{ text: "Как использовать", link: "/ru/how-to" },
{ text: "Устранение неполадок", link: "/ru/troubleshoot" },
{ text: "Миграция с v4", link: "/ru/migrate-from-v4" },
],
docFooter: {
prev: "Предыдущая страница",
next: "Следующая страница",
},
outline: {
label: "Содержание страницы",
},
nav: [
{ text: "Sponsor", link: "https://github.com/sponsors/typicode" },
],
},
},
es: {
label: "Español",
lang: "es-EC",
description: "Git hooks se vuelven fáciles",
link: "/es/",
themeConfig: {
sidebar: [
{ text: "Introducción", link: "/es/" },
{ text: "Comenzar", link: "/es/get-started" },
{ text: "Cómo hacerlo", link: "/es/how-to" },
{ text: "Solucionar problemas", link: "/es/troubleshoot" },
{ text: "Migrar desde v4", link: "/es/migrate-from-v4" },
],
docFooter: {
prev: "Página anterior",
next: "Página siguiente",
},
outline: {
label: "Contenido de la página",
},
nav: [
{ text: "Sponsor", link: "https://github.com/sponsors/typicode" },
],
},
},
},
});
79 changes: 79 additions & 0 deletions docs/es/get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Comenzar

## Instalar

::: code-group

```shell [npm]
npm install --save-dev husky
```

```shell [pnpm]
pnpm add --save-dev husky
```

```shell [yarn]
yarn add --dev husky
# Agregue pinst SÓLO si su paquete no es privado
yarn add --dev pinst
```

```shell [bun]
bun add --dev husky
```

:::

## `husky init` (recomendado)

El comando `init` simplifica la configuración de husky en un proyecto. Crea un script `pre-commit` en `.husky/` y actualiza el script `prepare` en `package.json`. Luego se pueden realizar modificaciones para que se adapten a su flujo de trabajo.

::: code-group

```shell [npm]
npx husky init
```

```shell [pnpm]
pnpm exec husky init
```

```shell [yarn]
# Debido a advertencias específicas y diferencias con otros administradores de paquetes,
# consulte la sección Cómo hacerlo.
```

```shell [bun]
bunx husky init
```

:::

## Pruébalo

¡Felicitaciones! Has configurado exitosamente tu primer gancho de Git (Git hook) con solo un comando 🎉. Probémoslo:

```shell
git commit -m "Keep calm and commit"
# El script de prueba se ejecutará cada vez que realices un commit
```

## Unas pocas palabras...

### Scripting

Si bien la mayoría de las veces, solo ejecutarás algunos comandos `npm run` o `npx` en tus ganchos (hooks), también puedes crear scripts con el shell POSIX para flujos de trabajo personalizados (custom workflows).

Por ejemplo, aquí se muestra cómo puedes analizar (lint) tus archivos preparados (staged files) en cada confirmación (commit) con solo dos líneas de código de shell y sin dependencia externa:

```shell
# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again
```

_Este es un ejemplo básico pero funcional, si necesita saber más verifique [lint-staged](https://github.com/lint-staged/lint-staged)._

### Deshabilitar ganchos (hooks)

Husky no fuerza los ganchos de Git (Git hooks). Se pueden deshabilitar globalmente (`HUSKY=0`) o se pueden habilitar si se desea. Consulta la sección [Cómo hacerlo](how-to) para obtener más información y realizar una configuración manual.
335 changes: 335 additions & 0 deletions docs/es/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,335 @@
# Cómo hacerlo

## Agregar un nuevo gancho (Hook)

Agregar un gancho (hook) es tan simple como crear un archivo. Esto se puede lograr usando su editor favorito, un script o un comando echo básico. Por ejemplo, en Linux/macOS:

```shell
echo "npm test" > .husky/pre-commit
```

## Archivos de inicio

Husky le permite ejecutar comandos locales antes de ejecutar ganchos (hooks). Husky lee comandos de estos archivos:

- `$XDG_CONFIG_HOME/husky/init.sh`
- `~/.config/husky/init.sh`
- `~/.huskyrc` (obsoleto (deprecated))

En Windows: `C:\Users\yourusername\.config\husky\init.sh`

## Omitir ganchos de Git (Git Hooks)

### Para un solo comando

La mayoría de los comandos de Git incluyen una opción `-n/--no-verify` para omitir ganchos (hooks):

```sh
git commit -m "..." -n # Skips Git hooks
```

Para los comandos sin esta bandera, deshabilite los ganchos (hooks) temporalmente con HUSKY=0:

```shell
HUSKY=0 git ... # Desactiva temporalmente todos los ganchos de Git (Git hooks)
git ... # Los ganchos (Hooks) se ejecutarán nuevamente
```

### Para varios comandos

Para deshabilitar los ganchos (hooks) durante un período prolongado (por ejemplo, durante la rebase/fusión (rebase/merge)):

```shell
export HUSKY=0 # Deshabilita todos los ganchos (hooks) de Git
git ...
git ...
unset HUSKY # Vuelve a habilitar los ganchos (hooks)
```

### Para una GUI o globalmente

Para deshabilitar los ganchos (hooks) de Git en un cliente GUI o globalmente, modifica la configuración de husky:

```sh
# ~/.config/husky/init.sh
export HUSKY=0 # Husky no instalará ni ejecutará ganchos (hooks) en tu máquina
```

## Servidor CI y Docker

Para evitar instalar ganchos de Git (Git Hooks) en servidores de CI o en Docker, use `HUSKY=0`. Por ejemplo, en acciones de GitHub (GitHub Actions):

```yml
# https://docs.github.com/en/actions/learn-github-actions/variables
env:
HUSKY: 0
```
Si instala solo `dependencies` (no `devDependencies`), el script `"prepare": "husky"` puede fallar porque Husky no se instalará.

Tiene varias soluciones.

Modifique el script `prepare` para que nunca falle:

```json
// package.json
"prepare": "husky || true"
```

Aún recibirá un mensaje de error `command not found` en su salida que puede ser confuso. Para que sea silencioso, cree `.husky/install.mjs`:

<!-- Dado que es posible que husky no esté instalado, se debe importar dinámicamente después de la verificación de producción/CI (prod/CI) -->

```js
// Omitir la instalación de Husky en producción y CI
if (process.env.NODE_ENV === "production" || process.env.CI === "true") {
process.exit(0);
}
const husky = (await import("husky")).default;
console.log(husky());
```

Luego, úsalo en `prepare`:

```json
"prepare": "node .husky/install.mjs"
```

## Probar (testear) Ganchos (Hooks) sin confirmar (Committing)

Para probar/testear un gancho (hook), agregue `exit 1` al script del gancho (hook) para cancelar el comando Git:

```shell
# .husky/pre-commit
# Your WIP script
# ...
exit 1
```

```shell
git commit -m "testing pre-commit code"
# No se creará una confirmación (commit)
```

## El proyecto no está en el directorio raíz de Git

Por razones de seguridad, Husky no se instala en los directorios padres (`../`). Sin embargo, puedes cambiar el directorio en el script `prepare`.

Considera esta estructura de proyecto:

```
.
├── .git/
├── backend/ # No package.json
└── frontend/ # Package.json con husky
```

Configure su script de preparación de la siguiente manera:

```json
"prepare": "cd .. && husky frontend/.husky"
```

En el script de gancho (hook script), cambie el directorio nuevamente al subdirectorio correspondiente:

```shell
# frontend/.husky/pre-commit
cd frontend
npm test
```

## Ganchos (hooks) que no son de shell

Para ejecutar scripts que requieren el uso de un lenguaje de script, use el siguiente patrón para cada gancho (hook) en el que aplique:

(Ejemplo usando el gancho (hook) `pre-commit` y NodeJS)

1. Cree un punto de entrada para el gancho (hook):

```shell
.husky/pre-commit
```

2. En el archivo agregue lo siguiente

```shell
node .husky/pre-commit.js
```

3. en `.husky/pre-commit.js`

```javascript
// Su código NodeJS
// ...
```

## Bash

Los scripts de gancho (hook) deben ser compatibles con POSIX para garantizar la mejor compatibilidad, ya que no todos tienen "bash" (por ejemplo, los usuarios de Windows).

Dicho esto, si su equipo no usa Windows, puede usar Bash de esta manera:

```shell
# .husky/pre-commit
bash << EOF
# Coloque dentro su script de bash
# ...
EOF
```

## Administradores de versiones de Node y GUI

Si usas ganchos de Git (Git hooks) en GUI con Node instalado a través de un administrador de versiones (como `nvm`, `n`, `fnm`, `asdf`, `volta`, etc.), es posible que te aparezca un error de `comando no encontrado` debido a problemas con la variable de entorno `PATH`.

### Entender `PATH` y los administradores de versiones

`PATH` es una variable de entorno que contiene una lista de directorios. Su shell busca comandos en estos directorios. Si no encuentra un comando, recibirá un mensaje de `comando no encontrado`.

Ejecute `echo $PATH` en un shell para ver su contenido.

Los administradores de versiones funcionan de la siguiente manera:

1. Agregando el código de inicialización al archivo de inicio de su shell (`.zshrc`, `.bashrc`, etc.), que se ejecuta cada vez que abre una terminal.
2. Descargando versiones de Node a un directorio en su carpeta de inicio (home folder).

Por ejemplo, si tiene dos versiones de Node:

```shell
~/version-manager/Node-X/node
~/version-manager/Node-Y/node
```

Al abrir una terminal se inicializa el administrador de versiones, que selecciona una versión (por ejemplo, `Node-Y`) y antepone su ruta a `PATH`:

```shell
echo $PATH
# Salida
~/version-manager/Node-Y/:...
```

Ahora, el node hace referencia a `Nodo-Y`. Al cambiar a `Nodo-X`, `PATH` cambia en concordancia:

```shell
echo $PATH
# Salida
~/version-manager/Node-X/:...
```

El problema surge porque las GUI, lanzadas fuera de una terminal, no inicializan el administrador de versiones, lo que deja a `PATH` sin la ruta de instalación de Node. Por lo tanto, los ganchos de Git (Git hooks) desde las GUI suelen fallar.

### Solución

Husky obtiene `~/.config/husky/init.sh` antes de cada gancho de Git (Git hooks). Copie aquí el código de inicialización del administrador de versiones para asegurarse de que se ejecute en las GUI.

Ejemplo con `nvm`:

```shell
# ~/.config/husky/init.sh
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
```

Como alternativa, si su archivo de inicio de shell es rápido y liviano, consígalo directamente:

```shell
# ~/.config/husky/init.sh
. ~/.zshrc
```

## Configuración manual

Git necesita ser configurado y husky debe configurar los archivos en `.husky/`.

Ejecute el comando `husky` una vez en su repositorio. Lo ideal es incluirlo en el script `prepare` en `package.json` para su ejecución automática después de cada instalación (recomendado).

::: code-group

```json [npm]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

```json [pnpm]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

```json [yarn]
{
"scripts": {
// Yarn doesn't support prepare script
"postinstall": "husky",
// Include this if publishing to npmjs.com
"prepack": "pinst --disable",
"postpack": "pinst --enable"
}
}
```

```json [bun]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

:::

Ejecute `prepare` una vez

::: code-group

```sh [npm]
npm run prepare
```

```sh [pnpm]
pnpm run prepare
```

```sh [yarn]
# Yarn doesn't support `prepare`
yarn run postinstall
```

```sh [bun]
bun run prepare
```

:::

Cree un archivo `pre-commit` en el directorio `.husky/`:

::: code-group

```shell [npm]
# .husky/pre-commit
npm test
```

```shell [pnpm]
# .husky/pre-commit
pnpm test
```

```shell [yarn]
# .husky/pre-commit
yarn test
```

```sh [bun]
# .husky/pre-commit
bun test
```

:::
81 changes: 81 additions & 0 deletions docs/es/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
![npm](https://img.shields.io/npm/dm/husky)

> Hooks nativos de Git ultrarrápidos y modernos
Husky mejora tus commits y más 🐶 _¡guau!_

Automáticamente hace un **análisis (lint) de tus mensages de commit**, **código**, y **ejecuta pruebas (test)** al confirmarse (committing ) o al enviar (pushing).

Comienza [aquí](/es/get-started.md).

## Características

- Solo `2 kB` (📦 _gzipped_) sin dependencias
- Extremadamente rápido (se ejecuta en `~1ms`)
- Utiliza la nueva característica de Git (`core.hooksPath`)
- Soporta:
- macOS, Linux, Windows
- GUI de Git (Git GUIs), administradores de versiones de Node, directorio de ganchos personalizados (custom hooks directory), proyectos anidados, monorepositorios (monorepos)
- [Todos los 13 ganchos de Git (Git hooks) del lado del cliente](https://git-scm.com/docs/githooks)

Y más:

- Ganchos específicos de la rama
- Uso de shell POSIX para crear scripts de casos avanzados
- Se adhiere a la organización de ganchos (hooks) nativa de Git (Git's native hook organization)
- Se alinea con las mejores prácticas de [npm](https://docs.npmjs.com/cli/v10/using-npm/scripts#best-practices) usando el script `prepare`
- Opciones de inclusión/exclusión (Opt-in/opt-out)
- Se puede deshabilitar globalmente
- Mensajes de error amigables con el usuario

## Patrocinadores (Sponsors)

Apoya este proyecto convirtiéndote en patrocinador (sponsor) [aquí](https://github.com/sponsors/typicode) 💖

### Patrocinador especial (Special Sponsor)

<p align="center">
<a href="https://app.tea.xyz/sign-up?r=8L2HWfJB6hs">
<img src="https://github.com/typicode/husky/assets/5502029/1b95c571-0157-48bc-a147-0d8d2fbc1d8a" /><br/>
Obtenga recompensas por sus contribuciones de código abierto
</a>
</p>

### GitHub

<p align="center">
<a href="../sponsorkit/sponsors.svg">
<img src='../sponsorkit/sponsors.svg'/>
</a>
</p>

### Colectivo Abierto (Open Collective)

<a href="https://opencollective.com/husky/tiers/company/0/website"><img src="https://opencollective.com/husky/tiers/company/0/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/1/website"><img src="https://opencollective.com/husky/tiers/company/1/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/2/website"><img src="https://opencollective.com/husky/tiers/company/2/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/3/website"><img src="https://opencollective.com/husky/tiers/company/3/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/4/website"><img src="https://opencollective.com/husky/tiers/company/4/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a>

## Usado por

Husky se utiliza en [**más de 1,5 millones de proyectos**](https://github.com/typicode/husky/network/dependents?package_id=UGFja2FnZS0xODQzNTgwNg%3D%3D) en GitHub, incluidos:

- [vercel/next.js](https://github.com/vercel/next.js)
- [vercel/hyper](https://github.com/vercel/hyper)
- [webpack/webpack](https://github.com/webpack/webpack)
- [angular/angular](https://github.com/angular/angular)
- [facebook/docusaurus](https://github.com/facebook/docusaurus)
- [microsoft/vscode](https://github.com/microsoft/vscode)
- [11ty/eleventy](https://github.com/11ty/eleventy)
- [stylelint/stylelint](https://github.com/stylelint/stylelint)
- [colinhacks/zod](https://github.com/colinhacks/zod)
- [rollup/rollup](https://github.com/rollup/rollup)
- [tinyhttp/tinyhttp](https://github.com/tinyhttp/tinyhttp)
- ...

## Artículos

- [Por qué Husky ha abandonado la configuración JS convencional](https://blog.typicode.com/posts/husky-git-hooks-javascript-config/)
- [Por qué Husky ya no se instala automáticamente](https://blog.typicode.com/posts/husky-git-hooks-autoinstall/)
65 changes: 65 additions & 0 deletions docs/es/migrate-from-v4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Migrar desde v4

Si estabas llamando a los scripts `package.json` usando `npm` o `yarn`, **puedes simplemente copiar tus comandos** desde tu archivo de configuración al gancho (hook) correspondiente:

Husky v4

```json
// package.json
{
"hooks": {
"pre-commit": "npm test && npm run foo" // [!code hl]
}
}
```

Husky v9

```shell
# .husky/pre-commit
# Tenga en cuenta que ahora puede tener comandos en varias líneas.
npm test // [!code hl]
npm run foo // [!code hl]
```

Si estaba llamando a binarios instalados localmente, **ahora necesita ejecutarlos a través de su administrador de paquetes**:

::: code-group

```js [.huskyrc.json (v4)]
{
"hooks": {
"pre-commit": "jest"
}
}
```

```shell [.husky/pre-commit (v9)]
jest
```

:::

La variable de entorno `HUSKY_GIT_PARAMS` ahora se reemplaza por los parámetros nativos `$1`, `$2`, etc.

::: code-group

```js [.huskyrc.json (v4)]
{
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
```

```shell [.husky/commit-msg (v9)]
commitlint --edit $1
```

:::

Otros cambios en las variables del entorno:

- `HUSKY_SKIP_HOOKS` se reemplaza por `HUSKY`.
- `HUSKY_SKIP_INSTALL` se reemplaza por `HUSKY`.
- `HUSKY_GIT_PARAMS` se elimina. En su lugar, los parámetros de Git deben usarse directamente en los scripts (por ejemplo, `$1`).
41 changes: 41 additions & 0 deletions docs/es/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Solución de problemas

## Comando no encontrado

Consulte [Cómo hacerlo](how-to) para obtener soluciones.

## Los ganchos (hooks) no se están ejecutando

1. Verifique que el nombre del archivo sea correcto. Por ejemplo, `precommit` o `pre-commit.sh` son nombres inválidos. Consulte la [documentación](https://git-scm.com/docs/githooks) de los Ganchos de Git (Git hooks ) para conocer los nombres válidos.
2. Ejecute `git config core.hooksPath` y asegúrase de que apunte a `.husky/_` (o a su directorio de ganchos personalizado (custom hooks directory)).
3. Confirme que su versión de Git sea superior a `2.9`.

## `.git/hooks/` no funciona después de la desinstalación

Si los ganchos (hooks) en `.git/hooks/` no funcionan después de desinstalar `husky`, ejecuta `git config --unset core.hooksPath`.

## Yarn en Windows

Los ganchos de Git (Git hooks) pueden fallar con Yarn en Windows usando Git Bash (`stdin no es un tty`). Para los usuarios de Windows, implemente esta solución alternativa (workaround):

1. Cree `.husky/common.sh`:

```shell
command_exists () {
command -v "$1" >/dev/null 2>&1
}

# Solución alternativa (Workaround) para Windows 10, Git Bash, and Yarn
if command_exists winpty && test -t 1; then
exec < /dev/tty
fi
```

2. Obtenga la fuente donde se ejecutan los comandos Yarn:

```shell
# .husky/pre-commit
. .husky/common.sh

yarn ...
```
79 changes: 79 additions & 0 deletions docs/ru/get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Начало работы

## Установить

::: code-group

```shell [npm]
npm install --save-dev husky
```

```shell [pnpm]
pnpm add --save-dev husky
```

```shell [yarn]
yarn add --dev husky
# Добавить pinst ТОЛЬКО если ваш пакет не является закрытым
yarn add --dev pinst
```

```shell [bun]
bun add --dev husky
```

:::

## `husky init` (рекомендуется)

Команда `init` упрощает настройку husky в проекте. Она создает скрипт `pre-commit` в `.husky/` и обновляет скрипт `prepare` в `package.json`. Изменения можно внести позже в соответствии с вашим рабочим процессом.

::: code-group

```shell [npm]
npx husky init
```

```shell [pnpm]
pnpm exec husky init
```

```shell [yarn]
# Из-за особых оговорок и различий с другими менеджерами пакетов,
# обратитесь к разделу «Как использовать».
```

```shell [bun]
bunx husky init
```

:::

## Попробуйте

Поздравляем! Вы успешно настроили свой первый Git hook всего одной командой 🎉. Давайте проверим:

```shell
git commit -m "Keep calm and commit"
# тестовый скрипт будет запускаться каждый раз при коммите
```

## Несколько слов...

### Скриптинг

Хотя большую часть времени вы просто запускаете несколько команд `npm run` или `npx` в своих хуках, вы также можете записать их с помощью оболочки POSIX для пользовательских рабочих процессов.

Например, вот как можно линтинговать подготовленные файлы на каждом коммите, используя всего две строки кода оболочки и без внешней зависимости:

```shell
# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\\ |g') --write --ignore-unknown
git update-index --again
```

_Это простой, но рабочий пример, проверьте [lint-staged](https://github.com/lint-staged/lint-staged), если вам нужно больше._

### Отключение хуков

Husky не принудительно использует хуки Git. Его можно отключить глобально (`HUSKY=0`) или включить, если нужно. См. раздел [Как сделать](how-to) для ручной настройки и дополнительной информации.
326 changes: 326 additions & 0 deletions docs/ru/how-to.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,326 @@
# Как использовать

## Добавление нового хука

Добавление хука так же просто, как создание файла. Это можно сделать с помощью вашего любимого редактора, скрипта или базовой команды echo. Например, в Linux/macOS:
```shell
echo "npm test" > .husky/pre-commit
```

## Файлы запуска

Husky позволяет выполнять локальные команды перед запуском хуков. Он считывает команды из следующих файлов:

- `$XDG_CONFIG_HOME/husky/init.sh`
- `~/.config/husky/init.sh`
- `~/.huskyrc` (устарело)

В Windows: `C:\Users\yourusername\.config\husky\init.sh`

## Пропуск хуков Git

### Для одной команды

Большинство команд Git включают опцию `-n/--no-verify` для пропуска хуков:

```sh
git commit -m "..." -n # Пропускает хуки Git
```

Для команд без этого флага временно отключите хуки с помощью HUSKY=0:

```shell
HUSKY=0 git ... # Временно отключает все хуки Git
git ... # Хуки снова запустятся
```

### Для нескольких команд

Чтобы отключить хуки для длительный период (например, во время rebase/merge):

```shell
export HUSKY=0 # Отключает все хуки Git
git ...
git ...
unset HUSKY # Повторно включает хуки
```

### Для GUI или глобально

Чтобы отключить хуки Git в клиенте GUI или глобально, измените конфигурацию husky:

```sh
# ~/.config/husky/init.sh
export HUSKY=0 # Husky не установит и не запустит хуки на вашей машине
```

## CI-сервер и Docker

Чтобы избежать установки хуков Git на CI-серверах или в Docker, используйте `HUSKY=0`. Например, в GitHub Actions:

```yml
# https://docs.github.com/en/actions/learn-github-actions/variables
env:
HUSKY: 0
```
Если устанавливается только `dependencies` (не `devDependencies`), скрипт `"prepare": "husky"` может завершиться ошибкой, поскольку Husky не будет установлен.

У вас есть несколько решений.

Измените скрипт `prepare`, чтобы он никогда не завершался ошибкой:

```json
// package.json
"prepare": "husky || true"
```

Вы все равно получите сообщение об ошибке `command not found` в выводе, что может сбивать с толку. Чтобы сделать его тихим, создайте `.husky/install.mjs`:

<!-- Поскольку husky может быть не установлен, его необходимо импортировать динамически после проверки prod/CI -->
```js
// Пропустить установку Husky в production и CI
if (process.env.NODE_ENV === 'production' || process.env.CI === 'true') {
process.exit(0)
}
const husky = (await import('husky')).default
console.log(husky())
```

Затем используйте его в `prepare`:

```json
"prepare": "node .husky/install.mjs"
```

## Тестирование хуков без коммита

Чтобы протестировать хук, добавьте `exit 1` в скрипт хука, чтобы прервать Git команду:

```shell
# .husky/pre-commit
# Ваш скрипт WIP
# ...
exit 1
```

```shell
git commit -m "testing pre-commit code"
# Коммит не будет создан
```

## Проект не в корневом каталоге Git

Husky не устанавливается в родительские каталоги (`../`) по соображениям безопасности. Однако вы можете изменить каталог в скрипте `prepare`.

Рассмотрим следующую структуру проекта:

```
.
├── .git/
├── backend/ # Нет package.json
└── frontend/ # Package.json с husky
```

Настройте скрипт подготовки следующим образом:

```json
"prepare": "cd .. && husky frontend/.husky"
```

В скрипте хука измените каталог обратно на соответствующий подкаталог:

```shell
# frontend/.husky/pre-commit
cd frontend
npm test
```

## Хуки, не относящиеся к оболочке

Чтобы запустить скрипты, требующие использования языка сценариев, используйте следующий шаблон для каждого применимого хука:

(Пример использования хука `pre-commit` и NodeJS)
1. Создайте точку входа для хука:
```shell
.husky/pre-commit
```
2. В файл добавьте следующее
```shell
node .husky/pre-commit.js
```
3. в `.husky/pre-commit.js`
```javascript
// Ваш код NodeJS
// ...
```

## Bash

Скрипты хуков должны быть совместимы с POSIX, чтобы обеспечить лучшую совместимость, так как не у всех есть `bash` (например, у пользователей Windows).

При этом, если ваша команда не использует Windows, вы можете использовать Bash следующим образом:

```shell
# .husky/pre-commit
bash << EOF
# Поместите свой скрипт bash внутрь
# ...
EOF
```

## Менеджеры версий Node и графические интерфейсы

Если вы используете хуки Git в графических интерфейсах с Node, установленным через менеджер версий (например, `nvm`, `n`, `fnm`, `asdf`, `volta` и т. д.), вы можете столкнуться с ошибкой `command not found` из-за проблем с переменной среды `PATH`.

### Понимание `PATH` и менеджеров версий

`PATH` — это переменная среды, содержащая список каталогов. Ваша оболочка ищет команды в этих каталогах. Если она не находит команду, вы получаете сообщение `command not found`.

Запустите `echo $PATH` в оболочке, чтобы просмотреть ее содержимое.

Менеджеры версий работают следующим образом:
1. Добавляют код инициализации в файл запуска оболочки (`.zshrc`, `.bashrc` и т. д.), который запускается каждый раз при открытии терминала.
2. Загружают версии Node в каталог в вашей домашней папке.

Например, если у вас две версии Node:

```shell
~/version-manager/Node-X/node
~/version-manager/Node-Y/node
```

Открытие терминала инициализирует менеджер версий, который выбирает версию (например, `Node-Y`) и добавляет ее путь к `PATH`:

```shell
echo $PATH
# Вывод
~/version-manager/Node-Y/:...
```

Теперь node ссылается на `Node-Y`. Переключение на `Node-X` соответственно изменяет `PATH`:

```shell
echo $PATH
# Вывод
/version-manager/Node-X/:...
```

Проблема возникает из-за того, что GUI, запущенные вне терминала, не инициализируют менеджер версий, оставляя `PATH` без пути установки Node. Таким образом, хуки Git из GUI часто терпят неудачу.

### Решение

Husky создает `~/.config/husky/init.sh` перед каждым хуком Git. Скопируйте сюда код инициализации вашего менеджера версий, чтобы он работал в GUI.

Пример с `nvm`:

```shell
# ~/.config/husky/init.sh
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # Это загружает nvm
```

В качестве альтернативы, если ваш файл запуска оболочки быстрый и легкий, используйте его напрямую:

```shell
# ~/.config/husky/init.sh
. ~/.zshrc
```

## Ручная настройка

Git необходимо настроить, а husky необходимо настроить файлы в `.husky/`.

Запустите команду `husky` один раз в вашем репозитории. В идеале включите ее в скрипт `prepare` в `package.json` для автоматического выполнения после каждой установки (рекомендуется).

::: code-group

```json [npm]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

```json [pnpm]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

```json [yarn]
{
"scripts": {
// Yarn не поддерживает скрипт подготовки
"postinstall": "husky",
// Включить это при публикации на npmjs.com
"prepack": "pinst --disable",
"postpack": "pinst --enable"
}
}
```

```json [bun]
{
"scripts": {
"prepare": "husky" // [!code hl]
}
}
```

:::

Запустить `prepare` once:

::: code-group

```sh [npm]
npm run prepare
```

```sh [pnpm]
pnpm run preparation
```

```sh [yarn]
# Yarn не поддерживает `prepare`
yarn run postinstall
```

```sh [bun]
bun run preparation
```

:::

Создайте файл `pre-commit` в каталоге `.husky/`:

::: code-group

```shell [npm]
# .husky/pre-commit
npm test
```

```shell [pnpm]
# .husky/pre-commit
pnpm test
```

```shell [yarn]
# .husky/pre-commit
yarn test
```

```sh [bun]
# .husky/pre-commit
тест булочки
```

:::
80 changes: 80 additions & 0 deletions docs/ru/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
![npm](https://img.shields.io/npm/dm/husky)

> Сверхбыстрые современные собственные хуки git
Husky улучшает ваши коммиты и многое другое 🐶 _woof!_

Автоматически **линтует ваши сообщения коммитов**, **код** и **запускает тесты** при коммите или отправке.

Начните [здесь](/get-started.md).

## Возможности

- Всего `2 КБ` (📦 _gzipped_) без зависимостей
- Очень быстрый (запускается за `~1 мс`)
- Использует новую функцию Git (`core.hooksPath`)
- Поддерживает:
- macOS, Linux, Windows
- Git GUI, менеджеры версий Node, каталог пользовательских хуков, вложенные проекты, монорепозитории
- [Все 13 клиентских хуков Git](https://git-scm.com/docs/githooks)

И многое другое:
- Хуки, специфичные для веток
- Используйте оболочку POSIX для скриптов сложных случаев
- Соответствует собственной организации хуков Git
- Соответствует лучшим практикам [npm](https://docs.npmjs.com/cli/v10/using-npm/scripts#best-practices) с использованием скрипта `prepare`
- Параметры согласия/отказа
- Может быть глобально отключено
- Удобные сообщения об ошибках

## Спонсоры

Поддержите этот проект, став спонсором [здесь](https://github.com/sponsors/typicode) 💖

### Специальный спонсор

<p align="center">
<a href="https://app.tea.xyz/sign-up?r=8L2HWfJB6hs">
<img src="https://github.com/typicode/husky/assets/5502029/1b95c571-0157-48bc-a147-0d8d2fbc1d8a" /><br/>
Получите награды за свой вклад в открытый исходный код
</a>
</p>

### GitHub

<p align="center">
<a href="../sponsorkit/sponsors.svg">
<img src='../sponsorkit/sponsors.svg'/>
</a>
</p>

### Открытый коллектив

<a href="https://opencollective.com/husky/tiers/company/0/website"><img src="https://opencollective.com/husky/tiers/company/0/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/1/website"><img src="https://opencollective.com/husky/tiers/company/1/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/2/website"><img src="https://opencollective.com/husky/tiers/company/2/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/3/website"><img src="https://opencollective.com/husky/tiers/company/3/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/4/website"><img src="https://opencollective.com/husky/tiers/company/4/avatar.svg?avatarHeight=120"></a>
<a href="https://opencollective.com/husky/tiers/company/5/website"><img src="https://opencollective.com/husky/tiers/company/5/avatar.svg?avatarHeight=120"></a>

## Используется

Husky используется в [**более 1,5 млн проектов**](https://github.com/typicode/husky/network/dependents?package_id=UGFja2FnZS0xODQzNTgwNg%3D%3D) на GitHub, включая:

- [vercel/next.js](https://github.com/vercel/next.js)
- [vercel/hyper](https://github.com/vercel/hyper)
- [webpack/webpack](https://github.com/webpack/webpack)
- [angular/angular](https://github.com/angular/angular)
- [facebook/docusaurus](https://github.com/facebook/docusaurus)
- [microsoft/vscode](https://github.com/microsoft/vscode)
- [11ty/eleventy](https://github.com/11ty/eleventy)
- [stylelint/stylelint](https://github.com/stylelint/stylelint)
- [colinhacks/zod](https://github.com/colinhacks/zod)
- [rollup/rollup](https://github.com/rollup/rollup)
- [tinyhttp/tinyhttp](https://github.com/tinyhttp/tinyhttp)
- ...

## Статьи

- [Почему husky отказался от обычного JS config](https://blog.typicode.com/posts/husky-git-hooks-javascript-config/)
- [Почему husky больше не устанавливается автоматически](https://blog.typicode.com/posts/husky-git-hooks-autoinstall/)
66 changes: 66 additions & 0 deletions docs/ru/migrate-from-v4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Переход с v4

Если вы вызывали скрипты `package.json` с помощью `npm` или `yarn`, **вы можете просто скопировать свои команды** из файла конфигурации в соответствующий хук:

Husky v4

```json
// package.json
{
"hooks": {
"pre-commit": "npm test && npm run foo" // [!code hl]
}
}
```

Husky v9

```shell
# .husky/pre-commit
# Обратите внимание, что теперь вы можете иметь команды в нескольких строках
npm test // [!code hl]
npm run foo // [!code hl]
```

Если вы вызывали локально установленные двоичные файлы, **теперь вам нужно запустить их через менеджер пакетов**:

::: code-group

```js [.huskyrc.json (v4)]
{
"hooks": {
"pre-commit": "jest"
}
}
```

```shell [.husky/pre-commit (v9)]
jest
```

:::

Переменная окружения `HUSKY_GIT_PARAMS` теперь заменена на собственные параметры `$1`, `$2` и т. д.

::: code-group

```js [.huskyrc.json (v4)]
{
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
```

```shell [.husky/commit-msg (v9)]
commitlint --edit $1
```

:::

Другие изменения переменных окружения:

- `HUSKY_SKIP_HOOKS` заменен на `HUSKY`.

- `HUSKY_SKIP_INSTALL` заменен на `HUSKY`.
- `HUSKY_GIT_PARAMS` удален. Вместо этого параметры Git следует использовать непосредственно в скриптах (например, `$1`).
41 changes: 41 additions & 0 deletions docs/ru/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Устранение неполадок

## Команда не найдена (Command not found)

См. [Как сделать](how-to) для решений.

## Хуки не работают

1. Проверьте правильность имени файла. Например, `precommit` или `pre-commit.sh` — недопустимые имена. Обратитесь к [документации] Git hooks (https://git-scm.com/docs/githooks) для допустимых имен.
2. Запустите `git config core.hooksPath` и убедитесь, что он указывает на `.husky/_` (или на ваш пользовательский каталог hooks).
1. Убедитесь, что версия Git выше `2.9`.

## `.git/hooks/` не работает после удаления

Если хуки в `.git/hooks/` не работают после удаления `husky`, выполните `git config --unset core.hooksPath`.

## Yarn в Windows

Git-хуки могут не работать с Yarn в Windows с использованием Git Bash (`stdin не является tty`). Для пользователей Windows реализуйте этот обходной путь:

1. Создайте `.husky/common.sh`:

```shell
command_exists () {
command -v "$1" >/dev/null 2>&1
}

# Обходной путь для Windows 10, Git Bash и Yarn
if command_exists winpty && test -t 1; then
exec < /dev/tty
fi
```

2. Укажите его там, где выполняются команды Yarn:

```shell
# .husky/pre-commit
. .husky/common.sh

yarn ...
```
4 changes: 2 additions & 2 deletions package-lock.json
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "husky",
"version": "9.1.5",
"version": "9.1.6",
"type": "module",
"description": "Modern native Git hooks",
"keywords": [