mirror of
https://github.com/n8n-io/n8n.git
synced 2026-10-11 22:50:06 +00:00
docs: Keep routine pre-commit checks lightweight (#40790)
This commit is contained in:
@@ -69,10 +69,15 @@ are namespaced under `n8n:`. Use `n8n:` prefix when invoking them (e.g.
|
|||||||
|
|
||||||
## Essential Commands
|
## Essential Commands
|
||||||
|
|
||||||
For full-repo lint and typecheck, use `pnpm agent:lint` and
|
For routine pre-commit checks, follow [Verify changes](#verify-changes).
|
||||||
`pnpm agent:typecheck`. They save full logs and return compact results.
|
|
||||||
For focused tests, use `pnpm agent:test` or `pnpm agent:playwright`.
|
For focused tests, use `pnpm agent:test` or `pnpm agent:playwright`.
|
||||||
Run each command with `--help` for its package, script, and file options.
|
Pass test files and worker limits after `--`. Run each command with `--help`
|
||||||
|
for its options.
|
||||||
|
|
||||||
|
`pnpm agent:lint` and `pnpm agent:typecheck` run full-repo checks by default.
|
||||||
|
With `--filter <package>`, they still check the whole package. These wrappers
|
||||||
|
save logs and reduce console output. They do not reduce CPU or memory use.
|
||||||
|
Do not use them as routine pre-commit checks.
|
||||||
|
|
||||||
### Fresh checkout / agent setup
|
### Fresh checkout / agent setup
|
||||||
|
|
||||||
@@ -314,9 +319,20 @@ extends one of those layers):
|
|||||||
|
|
||||||
### Verify changes
|
### Verify changes
|
||||||
|
|
||||||
- Run focused tests from the owning package: `pnpm test <test-file>`.
|
- Before committing, run formatting and lint checks on changed files. Use
|
||||||
- Run that package's `pnpm lint` and `pnpm typecheck` before committing code.
|
the package's configured tools through `pnpm exec` with explicit file paths.
|
||||||
Build first when shared types or cross-package dependencies change.
|
Do not append file paths to `pnpm lint`; package scripts can still check
|
||||||
|
the whole package.
|
||||||
|
- Run tests that cover the changed behavior from the owning package:
|
||||||
|
`pnpm test <test-file> --maxWorkers=1`. Or use the root wrapper:
|
||||||
|
`pnpm agent:test --filter <package> -- <test-file> --maxWorkers=1`.
|
||||||
|
For Playwright, use `pnpm agent:playwright -- <spec-file> --workers=1`.
|
||||||
|
- For routine commits, run checks one at a time. Use one test worker by
|
||||||
|
default. Do not run full frontend typechecks locally. Use CI for
|
||||||
|
comprehensive lint, typechecks, and test suites.
|
||||||
|
- For documentation-only changes, review the diff and run `git diff --check`.
|
||||||
|
Skip code tests when no behavior changed.
|
||||||
|
- Report which checks ran and which checks were left to CI.
|
||||||
- Use Vitest for unit tests. Use
|
- Use Vitest for unit tests. Use
|
||||||
[Playwright](packages/quality/testing/playwright/AGENTS.md) when a test needs its
|
[Playwright](packages/quality/testing/playwright/AGENTS.md) when a test needs its
|
||||||
browser, fixtures, or managed containers.
|
browser, fixtures, or managed containers.
|
||||||
|
|||||||
Reference in New Issue
Block a user