@znvvqz/engineering-rules
v2.2.0
Published
Install shared engineering standards, frontend design rules, and agent orchestration instructions into a project.
Maintainers
Readme
@znvvqz/engineering-rules
Shared engineering standards and frontend design rules for coding agents, distributed as a dependency-free project initializer. Includes the canonical rules, orchestration SOP, guides, stable-ID registry, and agent entry points for Codex/generic agents, Claude, Gemini, and GitHub Copilot.
Install or update a project
Requires Node.js 18 or newer. Run from the project directory, or pass an existing target directory after the command:
npx --yes --prefer-online @znvvqz/engineering-rules@latest init --dry-run
npx --yes --prefer-online @znvvqz/engineering-rules@latest init
npx --yes --prefer-online @znvvqz/engineering-rules@latest check
npx --yes --prefer-online @znvvqz/engineering-rules@latest update --dry-run
npx --yes --prefer-online @znvvqz/engineering-rules@latest updateinit preserves differing existing files and reports them with exit code 1. check reports missing or changed managed files with exit code 1. update (or init --force) intentionally replaces differing managed files; review the dry run and save local customizations before updating. Unrelated files and the project's README are not managed. Linked destinations are rejected before writing. help and version are available; invalid options or targets return exit code 2.
Installed content
rules/: 442 stable rules, including 45 frontend/product design rules..ai/: orchestration SOP, rule pointer, adoption instructions, design/orchestration guides, and the active/retired rule registry. Local task records are excluded.AGENTS.md,.claude/CLAUDE.md,.gemini/GEMINI.md, and.github/copilot-instructions.md: shared agent instructions.scripts/validate_standards.py,tests/test_validate_standards.py, and.github/workflows/standards.yml: structural validation and regression checks. Running them requires Python 3.10+; installation does not.
Start with AGENTS.md and the canonical rule index. Follow the adoption and validation guide to configure ownership, project-specific gates, and exceptions. The initializer installs that guide without replacing the consuming project's README. Installing files alone does not configure hosted branch protection or prove application compliance.
The frontend standard uses restrained typography, purposeful labels, useful density, real interactions, and rendered verification. The design guide records selected skill concepts and lessons from seven interface references. See release notes for this update.
Development and publishing
The repository is the template; there is no separate generated copy of the standard. The package manifest declares the CLI's public entry point and the allowed publication paths. Ownership is the package maintainer listed by npm; support and review requests go through the repository issues.
npm run verify
npm pack --pack-destination <existing-release-directory>verify runs structural validation, all Python regression tests, JavaScript syntax checking, and the real CLI integration suite. Packing runs verification again through prepack. No runtime dependencies are installed. The release procedure describes artifact review, publication, registry verification, and recovery. Releases use semantic versioning: minor for additional rules, patch for wording fixes, major for restructures or incompatible contracts. Agents preserve stable IDs under GEN-27.
