npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@hia-doc/cli

v0.1.0

Published

Command line entry for the HIA documentation system.

Readme

@hia-doc/cli

Command line entry for the HIA documentation system.

Current scope:

  • hia --help
  • hia docs build [--config <file>] [--input <file>] [--jsdoc-integration <file>] [--project-manifest <file>] [--out <dir>] [--locale <locale>] [--manifest <file>]

The build command reads config through @hia-doc/config, then renders one of three input modes:

  • a normalized HIA document JSON file
  • a JSDoc HIA Integration JSON file produced by @mandolin/jsdoc-plugin-hia-sys
  • a project docs manifest that aggregates JS, CSS, HTML and doc-source-map artifacts into one project page

Single-document modes validate the converted core document through @hia-doc/core. Project mode keeps each source artifact explicit in the output manifest and renders a unified page with all/JS/CSS/HTML views. All modes report diagnostics, render through @hia-doc/renderer-html, write HTML/theme assets, and emit an output manifest. The default manifest path is hia-manifest.json.

Diagnostics use the shared HiaDiagnostic shape. The CLI still prints compact [severity:code] lines, while the in-process API keeps machine-readable data for callers.

--input, --jsdoc-integration and --project-manifest are mutually exclusive. Use --input for already-normalized core documents, --jsdoc-integration for JSON produced by @mandolin/jsdoc-plugin-hia-sys, and --project-manifest for a multi-artifact project aggregation manifest.

In the local workspace, run it through the root script after building:

pnpm run build
pnpm run hia -- --help
pnpm run hia -- docs build --input fixtures/basic.hia.json --out dist/docs
pnpm run hia -- docs build --input fixtures/basic.hia.json --out dist/docs-en --locale en
pnpm run hia -- docs build --input fixtures/basic.hia.json --out dist/docs-custom --manifest manifest.json
pnpm run hia -- docs build --jsdoc-integration fixtures/jsdoc-integration.real-basic.json --out dist/jsdoc-docs --locale zh-CN
pnpm run hia -- docs build --project-manifest fixtures/project-mixed.hia-project.json --out dist/project-docs
pnpm run hia -- docs build --config hia.config.example.json

CLI options override values from hia.config.json. Paths in config files are resolved relative to the config file directory.

Contract

The CLI consumes core documents and project config, then writes renderer output to disk. It may add build-output files such as hia-manifest.json, but it does not change the renderer manifest contract.

See docs/contract-index.md for the current CLI/config/renderer layering rule.