@klarlabs-studio/glossa

@klarlabs-studio/glossa

Glossa for JavaScript, in one package: the runtime, the web components, the Vue, React and Astro bindings, the usages bundler plugin, capture, the in-product editor and the MessageFormat kernel. Each part is a subpath of this package.

npm install @klarlabs-studio/glossa
npm install vue      # only for /vue (and /astro/vue); react and astro likewise

Registries

The package is published to two registries, with the same version and contents:

npm and pnpm send a whole scope to one registry, so a repo that sets @klarlabs-studio:registry=https://npm.pkg.github.com for @klarlabs-studio/ui gets @klarlabs-studio/glossa from there too. Per-repo .npmrc options:

# A. The scope already goes to GitHub Packages (the Klarlabs default): nothing to
#    change except authentication. Both packages install from one registry.
@klarlabs-studio:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}

# B. Everything from npmjs.org: drop the scope line (and publish
#    @klarlabs-studio/ui there too, or install it with option C).
#    No .npmrc entry is needed for @klarlabs-studio/glossa.

# C. Keep the scope on GitHub Packages and take this one package from npmjs.org:
#    one install with a flag, no .npmrc change (the lockfile then records npmjs).
#    npm install @klarlabs-studio/glossa --@klarlabs-studio:registry=https://registry.npmjs.org
#    This also redirects @klarlabs-studio/ui for that command, so install the two separately.

With option A a fresh npm install and npm ci both work. A 404 from npm.pkg.github.com means the token is missing or lacks read:packages.

import { createRuntime } from "@klarlabs-studio/glossa";
import { createGlossa, GlossaText } from "@klarlabs-studio/glossa/vue";
import "@klarlabs-studio/glossa/elements";
import glossa from "@klarlabs-studio/glossa/unplugin/vite";

Subpaths

Every subpath keeps the specifier it had as a separate package, under its prefix (@klarlabs-studio/glossa-astro/vue is @klarlabs-studio/glossa/astro/vue).

One runtime, one set of elements

Subpaths import each other through the package's own name, never by relative path, so a bundler resolves a single copy of the runtime (and of the custom elements and the Lit context) however many subpaths an application uses. Importing @klarlabs-studio/glossa alone pulls in no Lit, Vue, React or capture code.

Dependencies

lit, @lit/context, acorn, unplugin, @jridgewell/trace-mapping, @messageformat/icu-messageformat-1, messageformat and zod are dependencies, so one install pulls them all even for an app that uses only the runtime; bundles contain only what is imported. vue, react and astro are optional peer dependencies: install the one you use.

How it is built

The sources live in the nine private workspace packages under runtimes/js/ and messageformat/js/. pnpm build here copies their compiled output to dist/<subpath>/ and rewrites the references between them to the specifiers above; pnpm test checks the exports map against the sources', the files, the tree-shaking and every size budget (.size-limit.mjs); pnpm lint typechecks a consumer of every subpath. See RFC 0002, Amendment 1.