@nickwelsh/refquill
v0.1.0
Published
One CLI for PHP, TypeScript, and Rust API references
Readme
@nickwelsh/refquill
Generate JSON API references from PHP, TypeScript, and Rust with one CLI. TypeScript inputs also support React, SolidJS, Vue, and Svelte components. PHP analysis needs no PHP runtime or Composer dependency.
Install
Requires Node 22.18 or newer. Prebuilt binaries support macOS on Apple Silicon, Linux arm64/x64, and Windows x64.
npm install --save-dev @nickwelsh/refquill
npx refquill init --language php
# Edit refquill.json to select your sources.
npx refquill generate
npx refquill validate docs/api.generated.jsonUse --language typescript or --language rust for other projects, or combine languages in one configuration.
Rust analysis accepts rustdoc JSON format 61. Cargo generation requires a compatible nightly and runs project build scripts and procedural macros. You can also import existing rustdoc JSON.
Generation preserves the previous output if analysis fails. Replacing an edited output requires --force.
Documentation
Read the configuration guide and language guides. The package also includes a terminal manual:
man ./node_modules/@nickwelsh/refquill/man/refquill.1Use @nickwelsh/refquill-schema to validate documents in JavaScript and @nickwelsh/refquill-fumadocs to render them.
Report an issue. MIT licensed.
