spfx-assurance: Offline Release Checks for SharePoint Framework Projects

Описание и применение

spfx-assurance — это автономный CLI‑инструмент, проверяющий проекты SharePoint Framework на наличие распространённых ошибок перед выпуском, таких как дублирующиеся ID, небезопасные URL и скрытые секреты, и генерирующий отчёты в JSON/Markdown.

Задача

SharePoint Framework (SPFx) web parts often fail during release due to issues like invalid manifests, duplicate component IDs, unsafe URLs, committed secrets, missing tenant approvals, or build failures that surface only at deployment time.

Результат

spfx-assurance provides a fast, offline validation step that identifies common SPFx release issues, reducing costly deployment failures and ensuring code quality before tenant interaction.

Рабочий процесс

• 1. Install spfx-assurance via npx or locally.
• 2. Run npx spfx-assurance check . --json assurance.json --md assurance.md --fail-on blocked in the project root.
• 3. Review the generated JSON/Markdown reports for verified, warning, blocked, and skipped items.
• 4. Address any blocked or warning issues (e.g., duplicate IDs, unsafe URLs, secret assignments).
• 5. Re-run the check until all critical issues are resolved before proceeding to release.

Доказательства

The MVP checks: package and SPFx metadata; Node engine mismatch; solution metadata and four-part version; component manifest shape and duplicate IDs; secret-shaped assignments; unsafe URL schemes at obvious sinks; non-local HTTP URLs; webApiPermissionRequests requiring tenant admin approval; configured build/test commands.

Источник

The tool makes no network calls, accepts no credentials, and does not modify the project being inspected.

Источник