⚙️ Configuration Options — GitHub Action for Pull Requests

This page lists all configuration inputs and behavior for the Early-Catch GitHub Action on pull requests.

For shared concepts like tokens, memory, linting, concurrency, and SCM setup, see:

• NPM Authentication
• Token Permissions
• SCM Support
• Memory Tuning
• Linting & Formatting
• Concurrency

---

🔑 Required Inputs

Name	Description	Required	Default
api-key	Early AI API key for backend access.	✅ Yes	–
token	GitHub token for repo access and commits. See token docs.	✅ Yes	GITHUB_TOKEN

---

⚙️ Optional Inputs

Name	Description	Default
test-structure	Where to place tests: siblingFolder or rootFolder	siblingFolder
test-framework	Target test framework (jest only for now)	jest
test-file-suffix	Suffix like test or spec	test
test-file-naming	camelCase, kebabCase, etc.	camelCase
max-concurrency	1–4 workers. See concurrency guide.	4
auto-commit	true/false — whether to push files automatically	true
coverage-command	Custom coverage command — must keep Early flags	See Agent Jest Commands →
test-command	Custom validation command — must keep Early flags	See Agent Jest Commands →
continue-on-test-errors	continue the operation if current tests fail.	See Agent Jest Commands - tests fail →
lint-command	ESLint command before commit (see lint guide)	npx --no eslint $early_filename --fix
prettier-command	Prettier command before commit (see format guide)	npx --no prettier $early_filename --write

---

📤 Outputs

Output Name	Description
pre-coverage	Coverage before test generation
post-coverage	Coverage after test generation

---

🧠 Memory Recommendation

Set this in the env: section of your job:

NODE_OPTIONS: "--max-old-space-size=5120"

Required when using default concurrency (4). See Memory Tuning for limits per runner.

---

📂 Placement: test-structure

• siblingFolder → test files placed next to source
• rootFolder → test files placed under a root /tests folder

---

🧪 Framework: test-framework

Currently only jest is supported.
Support for mocha and vitest is planned.

---

🧹 Lint & Format Commands

If your repository enforces code style, prettier formatting, or pre-commit linting,
you may need to configure test generation agents to run those tools automatically.

Early CLI agents have built-in defaults for linting and formatting:

lint-command: npx --no eslint $early_filename --fix  
prettier-command: npx --no prettier $early_filename --write  

These are the same commands described below. If your repository uses different commands (e.g., via hooks or custom scripts), you should override these defaults accordingly.

---

🧠 Advanced Commands

If customizing test or coverage commands, you must keep all required Early flags.

TBD

---

🔔 Recommended Triggers

We recommend:

• opened — when PR is first created
• ready_for_review — when draft is finalized

Avoid push or synchronize unless you want re-generation on every commit.

---

🧩 Example Configuration Block

with:
  api-key: ${{ secrets.EARLY_SECRET_TOKEN }}
  token: ${{ secrets.GITHUB_TOKEN }}
  test-framework: jest
  test-structure: rootFolder
  test-file-suffix: spec
  test-file-naming: kebabCase
  auto-commit: true
  lint-command: npx --no eslint $early_filename --fix
  prettier-command: npx --no prettier $early_filename --write

---

✅ Best Practices

• Keep auto-commit enabled — only valid files are pushed
• Always define NODE_OPTIONS
• Use lint-command and prettier-command to prevent CI/pre-commit errors
• Tune max-concurrency if hitting memory limits

---

👉 Next: Troubleshooting