Скрипти NPM

Скрипти NPM для побудови, обслуговування, перевірки та підтримки вебсайту OpenTelemetry.

Визначення скриптів знаходиться у файлі package.json в корені. Скрипти запускаються командоюnpm run <script-name>. Скрипти, що містять в назві на початку символ _ є внутрішніми допоміжними скриптами і не призначені для безпосереднього запуску.

Build та serve

СкриптОпис
build:fullПовна збірка сайту. Детальніше див. Типи збірки.
build:leanСкорочена збірка сайту. Детальніше див. Типи збірки.
build:previewПовна збірка з мініфікацією (напр. для Netlify preview).
build:productionФінальна збірка Hugo з мініфікацією.
buildЗбирає сайт. Стандартно скорочена; див. Типи збірки.
cleanRun make clean.
serve:hugoЗапуск сервера Hugo зі створенням сторінок у памʼяті.
serve:netlifyЗапуск Netlify Dev з використанням 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:htmltestПеревірка посилань всього сайту за допомогою htmltest; спочатку lean.
check:links:lycheeПеревірка посилань всього сайту за допомогою Lychee; спочатку lean.
check:linksПеревірка посилань всього сайту (htmltest, стандартно); спочатку lean.
check:markdown:specsMarkdown lint для фрагментів spec в tmp/.
check:markdownMarkdown lint (вміст та проєкти).
check:registryПеревірка YAML реєстру в data/registry/.
check:spellingПеревірка правопису cspell в content, data та layout Markdown.
check:texttextlint в 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:markdownВиправлення Markdown lint помилок та прибирання пробілів в кінці рядків.
fix:refcacheОчистити refcache і повторно виконати перевірку посилань (оновлення refcache).
fix:refcache:refreshОчистити refcache за кількістю..
fix:submoduleЗафіксувати версію submodule (теж саме що й pin: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), потім перевірки; посилання перевіряються один раз.1
netlify-build:previewbuild:preview потім diff:check.
netlify-build:productionbuild:production потім diff:check.
test-and-fixВиконує скрипти виправлення (за винятком i18n/refcache/submodule), потім перевірки.
test:allВиконує test:base, потім test:compound-tests.
test:baseБазові тести (такі ж, як check).
test:collector-syncТести collector-sync.
test:compound-testsВиконує складені скрипти test:*-*.2
test:edge-functions:liveОпціональний live suite node:test; підтримує --help.
test:edge-functionsNode test runner для netlify/edge-functions/**/*.test.ts.
test:local-toolsNode test runner для scripts/**/*.test.mjs.2
test:local-tools:lycheeЧастина test:local-tools, що потребує бінарного файлу lychee (див. Примітки).
test:publicВиконує перевірки tests/public/ над зібраним сайтом.2
testВиконує найбільш часто потрібні тести.

Утиліти

СкриптОпис
seqЗапускає вказані скрипти в зазначеному порядку; виходить після першого збою.
allЗапускає всі скрипти; виконуються всі скрипти навіть якщо якийсь з низ зазнав збою.
locale-auto-mergeLocale auto-merge helper CLI (--help).
prepareКрок встановлення: get:submodule, потім встановлення теми Docsy через npm install.
prebuild:*Pre-build* хуки; кожен запускає _prebuild.
update:hugoВстановлення останньої версії hugo-extended.
update:packagesЗапуск npm-check-updates для оновлення залежностей.
generate:config:linksГенерація git-ігнорованого .htmltest.yml з .htmltest.base.yml
generate:config:links:lycheeГенерація git-ігнорованого lychee.toml з lychee.base.toml.
log:build, log:check:linksЗапустити відповідний скрипт та вивести (tee) вивід в tmp/.

Примітки

  • Підтримка refcache є специфічною для htmltest. Детальніше див. Refcache.
  • Перевірка посилань Lychee (пілот). Скрипти :lychee та :diff використовують Lychee як швидшу альтернативу htmltest, з тим же покриттям. Вони генерують lychee.toml та (пере)заповнюють .lycheecache з refcache автоматично. Lychee працює як CI пілот без блокування, поки його оцінюють у #10449.
  • test:local-tools:lychee є частиною test:local-tools, яка потребує бінарного файлу lychee (поведінкові тести фрагментів та конфігурації). Ці тести пропускаються, коли бінарний файл відсутній, тому test:local-tools вже охоплює їх у загальному тестовому завданні; кінцевий :lychee залишає цей скрипт поза test:compound-tests (який відповідає test:*-*), щоб набір не виконувався двічі. Завдання CI з перевірки посилань встановлює lychee та запускає цей скрипт для реального виконання.
  • all запускає всі перелічені скрипти, навіть якщо один з них не працює, а потім завершується з ненульовим статусом, якщо хоча б один з них не працює.

  1. Зазвичай для обслуговування: запускає fix:refcache (очищення, потім перевірка посилань) після виправлень контенту; використовує runner all з опцією keep-going, щоб зафіксувати всі виправлення. Фаза перевірки виключає check:links (fix:refcache покриває це) та check:i18n (зайве після того, як fix:i18n записує стан відхилення). Див. Housekeeping↩︎

  2. Ці скрипти відповідають конвенціям іменування тестових скриптів; див. Категорії тестів↩︎ ↩︎ ↩︎

Востаннє змінено July 12, 2026: [uk] Ukrainian documentation for OpenTelemetry (0301c8f3)