Skip to main content

Support and stability

Supported runtimes, public compatibility commitments, pre-1.0 changes, provider support, and issue reporting.

Ginko targets Nuxt 4 on Node.js 22.18–22.x, 24.11–24.x, or 26+. The package is ESM-only; CommonJS require() is not supported.

Supported setup

The maintained application path uses:

  • current Nuxt 4;
  • a supported Node.js runtime;
  • collection handles exported from content.config.ts;
  • the unified query API;
  • useContentPage() and useContentSearch();
  • the filesystem provider or a conforming external provider;
  • supported Nuxt I18n and Nuxt Sitemap versions when those integrations are enabled.

Exact dependency ranges live in package metadata and are exercised by minimum-runtime and dependency-canary CI jobs.

Public contract

Documented behavior and the import paths listed under Package exports are compatibility commitments. Imports from src/, undocumented generated modules, and internal runtime paths are unsupported.

The document envelope, query grammar, provider wire contract, configuration, and package exports receive semver treatment, changelog notes, tests, and migration guidance when they change.

Pre-1.0 changes

Before 1.0, Ginko may replace a public contract when keeping it would make the foundation worse. Removed APIs are not kept as indefinite aliases; version-specific changes are documented under Ginko version upgrades.

Pin intentional versions and test prereleases against a production build before adopting them.

Provider support

External providers own their source SDK, credentials, indexing, and operational behavior. Providers should run Ginko's contract suite against every advertised capability and supported Ginko version.

Security reports

Report suspected vulnerabilities privately to info@lupinum.com. Do not publish exploitable details in an issue. The repository's security policy lists the supported reporting paths and maintained versions.

Issue reports

Include:

  • a minimal reproduction;
  • exact dependency and runtime versions;
  • deployment target and provider;
  • collection and module configuration;
  • expected and actual behavior;
  • complete logs;
  • whether the problem reproduces in development, a production build, or both.