Webiny-js preflight
Webiny-only. Run all checks required before packages are ready for publish: deps, build, lint, format, tests.
install
source · Clone the upstream repo
git clone https://github.com/webiny/webiny-js
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/webiny/webiny-js "$T" && mkdir -p ~/.claude/skills && cp -r "$T/.claude/skills/preflight" ~/.claude/skills/webiny-webiny-js-preflight && rm -rf "$T"
manifest:
.claude/skills/preflight/SKILL.mdsource content
Preflight
Webiny-only skill. Run all checks required before packages are ready for publish.
Important
- Run steps in order.
- If any step fails, diagnose and fix the issue, then restart from step 1.
- Never run tests in parallel. Run each package sequentially.
- Before running tests for each package, count active test cases and shard at 32 tests per shard.
- To count active tests:
rg "^\s*(it|test|it\.each|test\.each)\s*\(" packages/<name>/__tests__ -t ts --count-matches | awk -F: '{s+=$2} END {print s}' - Calculate shards:
. If shards is 1, noshards = ceil(count / 32)
flag needed.--shard - Suppress noisy output: redirect stdout to
or pipe through/dev/null
as needed.tail
Steps
1. Install dependencies
yarn > /dev/null 2>&1
2. Generate webiny
package
webinyyarn webiny-scripts generate-webiny-package
3. Sync dependency versions
yarn webiny sync-dependencies
Verify
packages/cli/files/duplicates.json is an empty array ([]). If it contains entries, there are duplicate dependency versions that must be resolved before continuing.
4. Generate tsconfig files
node scripts/generateTsConfigsInPackages.js
5. Check package node_modules
node scripts/checkPackageNodeModules.js
6. Verify package.json dependencies match source imports
yarn adio
Must output "All dependencies in order!" to pass.
7. Format code
yarn format:fix > /dev/null 2>&1
This auto-fixes formatting issues. No manual intervention needed.
8. Lint
yarn eslint
This only checks — it does not auto-fix. If eslint reports errors, fix them manually, then restart from step 1.
9. Full clean build
yarn build --no-cache 2>&1 | tail -10
10. Check dist paths
node scripts/checkDistPaths.js
Verifies no
src/ paths remain in built output.
11. Run DDB tests
Run
yarn test for each package below, sequentially. Count active tests first and shard at 32.
Packages that need
:yarn test
apiapi-acoapi-audit-logsapi-coreapi-file-managerapi-file-manager-acoapi-headless-cmsapi-headless-cms-acoapi-headless-cms-bulk-actionsapi-headless-cms-ddbapi-headless-cms-import-exportapi-headless-cms-schedulerapi-headless-cms-tasksapi-headless-cms-workflowsapi-mailerapi-record-lockingapi-schedulerapi-sync-systemapi-website-builderapi-website-builder-schedulerapi-websocketsapi-workflowsapp-admincognitodb-dynamodbformhandlerhandler-awshandler-graphqllexical-converterpluginsreact-compositionreact-propertiesreact-rich-text-lexical-renderertasksutils
# 1. Count active tests count=$(rg "^\s*(it|test|it\.each|test\.each)\s*\(" packages/<name>/__tests__ -t ts --count-matches | awk -F: '{s+=$2} END {print s}') shards=$(( (count + 31) / 32 )) # 2a. If shards <= 1, run without sharding yarn test packages/<name> 2>&1 | grep "Test Files" # 2b. If shards > 1, run each shard sequentially yarn test packages/<name> --shard=1/$shards 2>&1 | grep "Test Files" yarn test packages/<name> --shard=2/$shards 2>&1 | grep "Test Files" # ... etc
12. Run OpenSearch tests
Run
yarn test:os for each package below, sequentially. Count active tests first and shard at 32.
Packages that need BOTH
(step 11) AND yarn test
:yarn test:os
api-acoapi-audit-logsapi-file-managerapi-file-manager-acoapi-headless-cmsapi-headless-cms-acoapi-headless-cms-bulk-actionsapi-headless-cms-import-exportapi-mailerapi-schedulerapi-workflowstasks
Packages that need ONLY
(not in step 11):yarn test:os
api-dynamodb-to-elasticsearchapi-elasticsearch-tasksapi-headless-cms-ddb-esapi-headless-cms-es-tasksapi-opensearch
yarn test:os packages/<name> 2>&1 | grep "Test Files"
13. Check for uncommitted changes
git status
Report any unexpected uncommitted changes from the steps above.
Keeping the package lists up to date
If the lists seem stale, re-derive them:
# All testable packages (have vitest.config.ts) find packages -maxdepth 2 -name "vitest.config.ts" | sed 's|packages/||;s|/vitest.config.ts||' | sort # Packages with ddb-os support grep -rl "ddb-os" --include="ci.config.json" packages/ | sed 's|packages/||;s|/ci.config.json||' | sort # Check if a package has standalone ddb tests too grep -o '"ddb"' packages/<name>/ci.config.json