Скрипти NPM
Скрипти NPM для побудови, обслуговування, перевірки та підтримки вебсайту OpenTelemetry.
Визначення скриптів знаходиться у файлі package.json в корені репозиторію. Скрипти запускаються командою npm run SCRIPT_NAME.
Термінологія
- Внутрішні скрипти
- Скрипти, що починаються з
_, є внутрішніми допоміжними скриптами і не призначені для безпосереднього запуску. - Так само й скрипти
NAME::pre та NAME::post — явно викликані кроки pre та post скрипту NAME.
- Стандартний чи
:all варіант скриптів- Скрипти
check, fix та test запускають найчастіше потрібні вкладені скрипти для кожної дії. - Варіанти
*:all — check:all, fix:all, test:all — запускають ширші набори вкладених скриптів; сфера дії кожного варіанта зазначена у його рядку таблиці.
Встановлення та оновлення залежностей
Build та serve
| Скрипт | Опис |
|---|
build:full | Повна збірка сайту. Детальніше див. Типи збірки. |
build:lean | Скорочена збірка сайту. Детальніше див. Типи збірки. |
build:preview | Повна збірка з мініфікацією (напр. для Netlify preview). |
build:production | Фінальна збірка Hugo з мініфікацією. |
build | Збирає сайт. Стандартно скорочена; див. Типи збірки. |
clean | Run make clean. |
serve:hugo | Запуск сервера Hugo зі створенням сторінок у памʼяті. |
serve | Запуск сервера Hugo для розробки (стандартно; повний рендеринг). |
Перевірки
| Скрипт | Опис |
|---|
check:all | Запуск всіх скриптів перевірки послідовно. |
check:code-excerpts | Перевірка фрагментів коду, помилка якщо потрібні оновлення. |
check:codeowners | Перевірка секції локалізації в CODEOWNERS відповідно до реєстру. |
check:collector-sync | Запуск перевірки collector-sync. |
check:expired | Перелік застарілого вмісту (на основі front matter). |
check:filenames | Перевірка назв файлів та виявлення застарілих файлів/тек. |
check:format | Перевірки Prettier та переносів. |
check:i18n | Перевірка front matter локалізації (default_lang_commit). |
check:l10n | Перевірка локалізації. |
check:links:diff | Перевірка посилань Lychee лише для змінених файлів. |
check:links:internal | Офлайн-перевірка посилань (тільки внутрішні посилання); спочатку lean. |
check:links | Перевірка посилань всього сайту за допомогою Lychee; спочатку lean. |
check:markdown:specs | Markdown lint для фрагментів spec в tmp/. |
check:markdown | Markdown lint (вміст та проєкти). |
check:registry | Перевірка YAML реєстру в data/registry/. |
check:spelling | Перевірка правопису cspell в content, data та layout Markdown. |
check:text | textlint в content та data. |
check | Запуск найчастіше використовуваних скриптів перевірки послідовно. |
Виправлення
| Скрипт | Опис |
|---|
fix | Запуск найпоширеніших виправлень. |
fix:code-excerpts | Оновлення фрагментів коду. |
fix:codeowners | Перегенерація секції локалізації в CODEOWNERS відповідно до реєстру. |
fix:all | Запуск всіх скриптів виправлень. |
fix:format | Застосування правил Prettier та прибирання зайвих пробілів в кінці рядків. |
fix:format:staged | Форматування тільки staged файлів. |
fix:i18n | Додавання виправлення i18n front matter (fix:i18n:new, fix:i18n:status). |
fix:l10n | Додавання виправлення локалізації. |
fix:link-cache | Перевірка посилань, оновлення зафіксованого .lycheecache. |
fix:link-cache:double-check | Повторно перевірити збійні посилання браузерним зондом. |
fix:link-cache:refresh | Очистити найстаріші запити кешу, потім fix:link-cache. |
fix:markdown | Виправлення Markdown lint помилок та прибирання пробілів в кінці рядків. |
fix:submodule | Оновлення, повторне закріплення та виведення списку версій submodule. |
fix:filenames | Перейменування файлів та видалення застарілих файлів/тек. |
fix:dict | Сортувати списки слів в cspell та нормалізувати front matter. |
fix:expired | Вилучення фалів знайдених за допомогою check:expired. |
fix:text | Запуск textlint з –fix. |
fix:collector-sync:lint | Запуск ruff з –fix у collector-sync. |
format | Псевдонім для Prettier write (шляхи content та nowrap). |
Submodules та content
| Скрипт | Опис |
|---|
code-excerpts | Оновлення фрагментів коду. ЗАСТАРІЛО: використовуйте fix:code-excerpts або check:code-excerpts. |
cp:spec | Копіювання вмісту spec (content-modules). |
get:submodule | Ініціалізація/оновлення git submodules (встановіть GET=no щоб оминути). |
pin:submodule | Зафіксувати версію submodule (опціонально PIN_SKIP). |
schemas:update | Оновлення OpenTelemetry spec submodule та вмісту. |
update:submodule | Оновлення submodules до останньої версії та отримання їх теґів. |
Тести та CI
| Скрипт | Опис |
|---|
diff:check | Попередження, якщо робоче дерево має незбережені зміни. |
diff:fail | Помилка, якщо робоче дерево має зміни (наприклад, після збірки). |
fix-and-test:all | Виконує всі виправлення (включно з i18n), потім перевірки; посилання перевіряються один раз. |
is:clean | Помилка, якщо робоче дерево Git має зміни, включно з файлами, які Git не відстежує. |
netlify-build:preview | Збірка Netlify deploy preview. |
netlify-build:production | Збірка виробничого сайту Netlify. |
test-and-fix | Виконує скрипти виправлення (за винятком i18n/link-cache/submodule), потім перевірки. |
test:all | Виконує test:base, потім test:compound-tests. |
test:base | Базові тести (такі ж, як check). |
test:collector-sync | Тести collector-sync. |
test:compound-tests | Виконує складені скрипти test:*-*. |
test:double-check:live | Live smoke-перевірка проби double-check. |
test:edge-functions:live | Опціональний live suite node:test; підтримує --help. |
test:edge-functions | Node test runner для netlify/edge-functions/**/*.test.ts. |
test:local-tools | Node test runner для scripts/**/*.test.mjs. |
test:local-tools:lychee | Частина test:local-tools, що потребує бінарного файлу lychee; пропускається, якщо його немає. |
test:public | Виконує перевірки tests/public/ над зібраним сайтом. |
test | Виконує найбільш часто потрібні тести. |
Утиліти
| Скрипт | Опис |
|---|
all | Запускає всі скрипти, навіть якщо деякі завершуються збоєм; завершується з ненульовим статусом, якщо хоч один з них не вдався. |
generate:config:links | Генерація git-ігнорованого lychee.toml з lychee.base.toml + front matter сторінок. |
locale-auto-merge | Locale auto-merge helper CLI (--help). |
log:build, log:check:links | Запустити відповідний скрипт, вивести (tee) вивід в tmp/ та передати код завершення скрипту. |
seq | Запускає вказані скрипти в зазначеному порядку; виходить після першого збою. |