Develop and deploy

Repository layout

plugins/vale/          Shared Claude Code and Codex plugin
  .codex-plugin/      Codex package metadata
  .claude-plugin/     Claude Code package metadata
  hooks/              Lifecycle registrations
  scripts/            Python hook runtime
  skills/             Checking and writing skills
  prompts/            Legacy Codex prompt template
  styles/Google/      Pinned upstream rules and license
.agents/plugins/      Codex marketplace catalog
.claude-plugin/       Claude Code marketplace catalog
scripts/              Installation, verification, and site build tools
tests/                Runtime and installation tests
docs/                 Documentation source and static assets
.github/workflows/    Checks and GitHub Pages deployment

The runtime uses only the Python standard library and the installed Vale executable. The documentation build uses the pinned dependency in requirements-docs.txt.

Run the checks

python3 -m unittest discover -s tests -v
vale --no-global --config plugins/vale/.vale.ini README.md docs plugins/vale/skills
python3 scripts/codex_smoke.py --plugin
python3 scripts/claude_smoke.py
claude plugin validate plugins/vale --strict
claude plugin validate .claude-plugin/marketplace.json --strict

The unit and integration suite uses temporary directories and real Vale. It covers direct edits, shell and MCP changes, concurrent event ordering, ignored files, option-like filenames, source comments, Stop retries, and installer preservation.

The smoke tests install from the local marketplace into temporary client configuration and drive the real command-line tools with deterministic local HTTP model fixtures. They verify plugin hook discovery, post-tool feedback, and a correction after Stop feedback. The Claude Code test also verifies expansion of /vale:check-prose. No remote model account or key is required.

Run python3 scripts/codex_smoke.py without --plugin to test the manual project hook installer. These fixtures test client integration; their scripted replies do not evaluate a model's editorial judgment.

Only isolated smoke-test invocations bypass hook trust or tool permissions. Normal installations use the client's trust and permission controls.

Build the documentation

python3 -m venv .venv
.venv/bin/pip install -r requirements-docs.txt
.venv/bin/python scripts/build_docs.py
python3 -m http.server 8000 --directory site

Open http://localhost:8000. The build creates static HTML with local CSS, semantic navigation, and no tracking scripts or remote font dependency.

Deployment policy

GitHub Actions checks pull requests and pushes to main. The Pages deployment job runs only when the event is push and the ref is refs/heads/main. This includes pull request merges and direct pushes to main. Pull requests and other branches cannot deploy. There is no manual deployment trigger.

The deployment waits for tests and the documentation build. GitHub's Pages actions upload and deploy the static artifact with narrowly scoped job permissions. Action versions are pinned to commit hashes.

The Pages custom domain is vale.swacktech.com. The DNS record is a CNAME from vale to swack-tools.github.io, using DNS-only mode in Cloudflare. GitHub Pages provides the content and TLS certificate. Cloudflare hosts DNS; no Worker is required.

Maintain bundled rules

The Google rules come from the official Google v0.7.1 release. The archive SHA-256 is:

4b67fca1f2a88595b2a578ab98bbf3017a23af677b04f93e862843f3ea1a9a0b

Keep the upstream license with the rules. To update, review the release, replace the bundled package, update the recorded version and checksum, and run the full test suite and documentation lint before merging.