---
type: JS Module
title: ensure-tool.mjs
resource: npm/scripts/lib/ensure-tool.mjs
docgen:
  crc: 230254b3
---

Модуль `ensure-tool.mjs` — єдина точка резолву зовнішніх CLI-залежностей пакета `@nitra/cursor`. Він гарантує, що потрібний бінарник (`hk`, `conftest`, `shellcheck`, `actionlint`, `dotenv-linter`, `opa`, `regal`, `hadolint`, `kubeconform`, `kubescape`) доступний у системі, виконуючи послідовний пошук:

1. У системному `PATH` (через `resolveCmd`).
2. У керованому кеші бінарників (`~/.cache/@nitra/cursor/bin/` на Linux/macOS або `%LOCALAPPDATA%\@nitra\cursor\bin\` на Windows).
3. Авто-встановлення відповідно до OS (`brew` для macOS, `scoop` для Windows із fallback на GitHub Release, прямий завантажувач GitHub Release для Linux).
4. Hard-fail з персоналізованою підказкою, якщо авто-встановлення вимкнено змінною середовища `N_CURSOR_NO_AUTO_INSTALL`.

Така архітектура усуває дублювання install-логіки в кожному `lint.mjs` / `fix.mjs`: щоб додати нову зовнішню утиліту, достатньо одного запису в реєстрі `TOOLS`. Додатково модуль експортує `ensureHkInstall`, який реєструє git pre-commit hook через `hk install` (пропускається в CI).

Файл написаний для Node.js (ESM), використовує лише стандартну бібліотеку та один локальний хелпер `resolveCmd`.

## Експорти / API

| Експорт                  | Тип        | Призначення                                                                                                    |
| ------------------------ | ---------- | -------------------------------------------------------------------------------------------------------------- |
| `ensureTool(toolId)`     | `function` | Резолвить і за потреби встановлює зовнішній CLI. Повертає абсолютний шлях до бінарника або кидає `Error`.      |
| `ensureHkInstall(hkBin)` | `function` | Виконує `hk install` для реєстрації git pre-commit hook. Жодного return value; на помилку лише `console.warn`. |

Внутрішні (не експортуються, але формують контракт модуля):

- `TOOLS` — реєстр `Record<string, ToolEntry>` із описом install-стратегії для кожного тула.
- `ToolEntry` — JSDoc-тип, що описує поля одного запису реєстру.
- Допоміжні функції: `getCacheDir`, `mapArch`, `fetchLatestVersion`, `installFromGithub`, `installViaBrew`, `installViaScoop`, `autoInstall`, `buildHint`.

## Функції

### `getCacheDir()`

- **Сигнатура:** `getCacheDir(): string`
- **Параметри:** немає.
- **Повертає:** абсолютний шлях до каталогу кешу бінарників.
- **Логіка:**
  - На `win32` бере `process.env.LOCALAPPDATA` (fallback `homedir()/AppData/Local`) і додає `@nitra/cursor/bin`.
  - На інших платформах повертає `homedir()/.cache/@nitra/cursor/bin`.
- **Side effects:** немає (тільки читає env / `os.homedir`).

### `mapArch(nodeArch, style)`

- **Сигнатура:** `mapArch(nodeArch: 'x64'|'arm64'|string, style: 'hk'|'conftest'|'actionlint'): string`
- **Параметри:**
  - `nodeArch` — значення `process.arch`.
  - `style` — стиль іменування платформи для release-asset:
    - `'actionlint'` → `amd64` / `arm64`.
    - `'conftest'` → `x86_64` / `arm64`.
    - `'hk'` (та інші release-asset стилі: shellcheck, dotenv-linter) → `x86_64` / `aarch64`.
- **Повертає:** рядок архітектури, очікуваний у назві release-asset.
- **Side effects:** немає.

### `fetchLatestVersion(repo, curlBin)`

- **Сигнатура:** `fetchLatestVersion(repo: string, curlBin: string): string`
- **Параметри:**
  - `repo` — репозиторій у форматі `owner/repo`.
  - `curlBin` — абсолютний шлях до бінарника `curl`.
- **Повертає:** версію останнього релізу без префікса `v` (наприклад `0.4.1`).
- **Поведінка:** через `spawnSync` викликає `curl -sSL -H "Accept: application/vnd.github+json" https://api.github.com/repos/<repo>/releases/latest`, парсить JSON, бере поле `tag_name`, прибирає префікс `v` за допомогою регексу `TAG_V_PREFIX_RE`.
- **Помилки:**
  - `curl failed: ...` — `r.error` ненульове.
  - `curl exit <status>: ...` — ненульовий exit-код.
  - `GitHub API response is not JSON: ...` — некоректний JSON.
  - `GitHub API: tag_name missing for <repo>` — у відповіді немає `tag_name`.
- **Side effects:** мережевий HTTP-запит до GitHub API.

### `installFromGithub(toolId, entry, cacheDir)`

- **Сигнатура:** `installFromGithub(toolId: string, entry: ToolEntry, cacheDir: string): string`
- **Параметри:**
  - `toolId` — ключ у `TOOLS`.
  - `entry` — `ToolEntry` для цього тула.
  - `cacheDir` — абсолютний шлях до каталогу кешу.
- **Повертає:** абсолютний шлях до встановленого бінарника.
- **Послідовність дій:**
  1. Резолвить `curl` та `tar` у PATH; за відсутності — кидає `Error`.
  2. Через `fetchLatestVersion` отримує актуальну версію.
  3. Формує назву asset через `entry.asset(ver)` і URL `https://github.com/<github>/releases/download/v<ver>/<asset>`.
  4. Створює `cacheDir` (`mkdirSync` з `recursive: true`).
  5. Завантажує asset через `curl -sSL -o <archivePath> <downloadUrl>`.
  6. Якщо `entry.archive === false` — перейменовує завантажений файл у `<cacheDir>/<toolId>`, виставляє права `0o755` і повертає шлях.
  7. Інакше викликає `tar` із прапорцем `-xJf` (для `.tar.xz`) або `-xzf` (для `.tar.gz`) для розпакування в `cacheDir`.
  8. Визначає реальний шлях до бінарника через `entry.binFinder(ver)` або просто `toolId`. Перевіряє існування файлу.
  9. Опціонально видаляє завантажений архів через `rm` (м’яко: якщо `rm` не знайдено, продовжує).
- **Помилки:**
  - `curl не знайдено в PATH — потрібен для завантаження <toolId>`.
  - `tar не знайдено в PATH — потрібен для встановлення <toolId>`.
  - `Завантаження <toolId> не вдалось: ...` / `curl exit <status> при завантаженні <toolId>: ...`.
  - `tar failed for <toolId>: ...` / `tar exit <status> для <toolId>: ...`.
  - `Бінарник <toolId> не знайдено після розпакування: <binPath>`.
- **Side effects:** мережа, файлова система (створення/перейменування файлів, chmod, видалення архіву).

### `installViaBrew(toolId, entry)`

- **Сигнатура:** `installViaBrew(toolId: string, entry: ToolEntry): string`
- **Параметри:** `toolId` і `entry` як у попередній функції.
- **Повертає:** абсолютний шлях до бінарника після встановлення (через повторний `resolveCmd(toolId)`).
- **Послідовність дій:**
  1. Резолвить `brew` у PATH; на відсутність кидає `brew не знайдено в PATH. Встанови Homebrew: https://brew.sh`.
  2. Виконує `brew install <entry.brew>` із `stdio: 'inherit'` (інтерактивний прогрес).
  3. Перевіряє exit-код і `error` об’єкт.
  4. Після успіху повторно резолвить `toolId` у PATH; якщо й тоді нема — кидає `... не знайдено в PATH після brew install`.
- **Side effects:** виклик зовнішнього `brew install` (мережа, мутація системного стану на macOS).

### `installViaScoop(toolId, entry)`

- **Сигнатура:** `installViaScoop(toolId: string, entry: ToolEntry): string`
- **Параметри:** як вище.
- **Повертає:** абсолютний шлях до бінарника після встановлення.
- **Поведінка:** дзеркало `installViaBrew`, але для `scoop install`.
  - Якщо `entry.scoop === null` — кидає `... недоступний у Scoop. Встанови вручну: https://github.com/<repo>/releases`.
  - Якщо `scoop` не у PATH — кидає `scoop не знайдено в PATH. Встанови Scoop: https://scoop.sh`.
- **Side effects:** виклик зовнішнього `scoop install`.

### `autoInstall(toolId, entry, cacheDir)`

- **Сигнатура:** `autoInstall(toolId: string, entry: ToolEntry, cacheDir: string): string`
- **Поведінка диспетчера за платформою:**
  - `darwin` → `installViaBrew`.
  - `win32` → пробує `installViaScoop`, на будь-який throw — fallback на `installFromGithub` (наприклад, для `dotenv-linter` чи `regal`, де `scoop: null`).
  - Інше (Linux) → `installFromGithub`.
- **Повертає:** абсолютний шлях до бінарника.
- **Side effects:** делегує своїм внутрішнім installer-ам.

### `buildHint(toolId, entry)`

- **Сигнатура:** `buildHint(toolId: string, entry: ToolEntry): string`
- **Параметри:** як вище.
- **Повертає:** багаторядкове повідомлення для error message при заблокованому авто-installі.
- **Формат:**
  - Перший рядок — `❌ <toolId> не знайдено в PATH і авто-встановлення відключено (N_CURSOR_NO_AUTO_INSTALL).`.
  - Другий рядок — `   Встанови:`.
  - Далі — OS-specific підказка:
    - macOS: `     macOS: brew install <entry.brew>`.
    - Windows: `     Windows: scoop install <entry.scoop>` (якщо доступний) та `     або: https://github.com/<repo>/releases`.
    - Linux: `     Linux: https://github.com/<repo>/releases`.
- **Side effects:** немає.

### `ensureTool(toolId)` _(export)_

- **Сигнатура:** `ensureTool(toolId: string): string`
- **Параметри:** `toolId` — ключ у реєстрі `TOOLS` (`'hk'`, `'conftest'`, `'shellcheck'`, `'actionlint'`, `'dotenv-linter'`, `'opa'`, `'regal'`, `'hadolint'`, `'kubeconform'`, `'kubescape'`).
- **Повертає:** абсолютний шлях до бінарника.
- **Послідовність резолву:**
  1. **Валідація** — якщо `TOOLS[toolId]` відсутній, кидає `ensureTool: невідомий тул '<toolId>'`.
  2. **PATH** — `resolveCmd(toolId)`; якщо знайдено — повертає одразу.
  3. **Кеш** — `join(getCacheDir(), toolId)`; якщо файл існує — повертає його шлях. Зауваження: перевірка спрощена і не враховує `entry.binFinder` (для cached binaries `installFromGithub` уже клав фінальний бінарник у відоме місце або кеш просто не містить такого файлу — у такому разі переходимо до install).
  4. **Авто-install** — якщо змінна середовища `N_CURSOR_NO_AUTO_INSTALL` не виставлена, викликає `autoInstall(toolId, entry, cacheDir)`.
  5. **Hard-fail** — кидає `Error(buildHint(toolId, entry))`.
- **Помилки:** будь-яка з помилок `autoInstall` / `installFrom*` піднімається вгору; додатково — `невідомий тул` та `❌ ... не знайдено в PATH`.
- **Side effects:** мережа, файлова система, виклик зовнішніх install-команд (`brew`, `scoop`, `curl`, `tar`, `rm`).

### `ensureHkInstall(hkBin)` _(export)_

- **Сигнатура:** `ensureHkInstall(hkBin: string): void`
- **Параметри:**
  - `hkBin` — абсолютний шлях до бінарника `hk` (зазвичай отриманий через `ensureTool('hk')`).
- **Повертає:** `void`.
- **Логіка:**
  - Якщо `process.env.CI` truthy — функція виходить без дії (не реєструємо hook у CI).
  - Інакше виконує `spawnSync(hkBin, ['install'], { stdio: 'inherit' })`.
  - На `r.error` або ненульовий `r.status` виводить попередження через `console.warn` (не кидає!).
- **Side effects:** запис git pre-commit hook у `.git/hooks/pre-commit` (через `hk`), вивід у stdout/stderr.

## Залежності

### Стандартна бібліотека Node.js

- `node:child_process` — `spawnSync` для синхронного запуску `curl`, `tar`, `brew`, `scoop`, `rm`, `hk`.
- `node:fs` — `chmodSync`, `existsSync`, `mkdirSync`, `renameSync`.
- `node:os` — `homedir` для побудови шляху кешу.
- `node:path` — `join` для конструювання шляхів.
- `node:process` — `arch`, `env`, `platform`.

### Внутрішні

- `../utils/resolve-cmd.mjs` → `resolveCmd(cmd)` — кросплатформне резолвлення абсолютного шляху до бінарника в PATH (Linux/macOS — like `which`, Windows — like `where`).

### Зовнішні CLI (виконуються через `spawnSync`)

- `curl` — завантаження GitHub API і release-asset.
- `tar` — розпакування `.tar.gz` / `.tar.xz`.
- `rm` — м’яке видалення завантаженого архіву (необов’язково).
- `brew` — install на macOS.
- `scoop` — install на Windows.
- `hk` — реєстрація git pre-commit hook у `ensureHkInstall`.

### Змінні середовища

- `N_CURSOR_NO_AUTO_INSTALL` — якщо встановлена, блокує авто-install і змушує `ensureTool` кидати помилку з install-hint.
- `CI` — якщо truthy, `ensureHkInstall` нічого не робить.
- `LOCALAPPDATA` (Windows) — використовується для побудови шляху кешу.

## Потік виконання / Використання

### Типовий сценарій `ensureTool('shellcheck')` на Linux x64

1. Викликається `ensureTool('shellcheck')`.
2. `resolveCmd('shellcheck')` — не знайдено в `PATH`.
3. `getCacheDir()` повертає `/home/<user>/.cache/@nitra/cursor/bin`.
4. Перевірка `/home/<user>/.cache/@nitra/cursor/bin/shellcheck` — не існує.
5. `N_CURSOR_NO_AUTO_INSTALL` не виставлено → `autoInstall(...)`.
6. На Linux диспетчер викликає `installFromGithub('shellcheck', entry, cacheDir)`:
   - `fetchLatestVersion('koalaman/shellcheck', curl)` → наприклад `0.10.0`.
   - asset name = `shellcheck-v0.10.0.linux.x86_64.tar.xz`.
   - URL = `https://github.com/koalaman/shellcheck/releases/download/v0.10.0/<asset>`.
   - `mkdirSync(cacheDir, { recursive: true })`.
   - `curl -sSL -o <cacheDir>/<asset> <url>`.
   - `tar -xJf <asset> -C <cacheDir>` (бо `.tar.xz`).
   - `binFinder('0.10.0')` → `shellcheck-v0.10.0/shellcheck`.
   - Перевірка `existsSync(<cacheDir>/shellcheck-v0.10.0/shellcheck)`.
   - `rm <archivePath>`.
   - Повертає `<cacheDir>/shellcheck-v0.10.0/shellcheck`.
7. Викликач отримує абсолютний шлях і запускає `spawnSync(bin, [...args])`.

### Сценарій блокування авто-installу

```js
process.env.N_CURSOR_NO_AUTO_INSTALL = '1'
ensureTool('hk')
// throws Error із багаторядковим hint, наприклад на macOS:
// ❌ hk не знайдено в PATH і авто-встановлення відключено (N_CURSOR_NO_AUTO_INSTALL).
//    Встанови:
//      macOS: brew install hk
```

### Сценарій реєстрації git hook

```js
import { ensureTool, ensureHkInstall } from './lib/ensure-tool.mjs'

const hkBin = ensureTool('hk') // PATH → кеш → brew/scoop/github
ensureHkInstall(hkBin) // git hook у .git/hooks/pre-commit
```

У CI (`process.env.CI=true`) другий виклик стає no-op, що зручно для pipeline-ів, де hooks не потрібні.

### Розширення реєстру

Щоб додати новий тул `foo`:

1. Підбрати `brew`-формулу та `scoop`-пакет (або `null`, якщо відсутній).
2. Знайти GitHub-репо релізів і визначити `archStyle` (`hk` / `conftest` / `actionlint`).
3. Описати `asset(ver)` та, якщо потрібно, `binFinder(ver)` (коли бінарник лежить не в корені архіву).
4. Виставити `archive: false` для прямого бінарника без архіву.
5. Додати запис у `TOOLS`. Жодних змін у викликачах не потрібно — `ensureTool('foo')` запрацює одразу.

### Гарантії та інваріанти

- **Ідемпотентність:** повторний виклик `ensureTool` повертає шлях за O(1) після першого install — спочатку PATH, потім кеш.
- **Hard-fail:** на будь-яку нерозв’язну помилку install кидається `Error` із описовим повідомленням; немає silent fallback на «обірваний» бінарник.
- **Кросплатформність:** єдиний публічний API для трьох ОС; OS-specific деталі інкапсульовані всередині модуля.
- **Безпека для CI:** `ensureHkInstall` ніколи не змінює git-репозиторій під CI, навіть якщо `hk` доступний.
