Welcome to Glimmer.js! Glimmer.js is actually a made up of lots of small packages, so this meta-repo exists to help you find what you're looking for.
Glimmer.js is the developer-facing API on top of the low-level Glimmer VM.
These packages are imported and used by Glimmer developers directly.
@glimmer/component- defines the Glimmer component base class and component lifecycle
@glimmer/tracking- defines the Glimmer property change tracking system
Any changes to their types, including changes caused by upgrading the Typescript compiler, are covered under SemVer for these packages (e.g. breaking changes to types will require a new major version).
In order to ensure we aren't making changes to types unintentionally, we have a
set of tests for their public APIs in
/test/types. These can be run with:
yarn build yarn test:types
In general, any new additions to the public types should be a new minor version, and removals of public APIs or changes to the versions of TS that are supported should be a major version. Corrections to existing types that are not breaking (e.g. strictly equal to or wider than the current type) can be released in patch versions.
To add a new API:
- Add it to any
hasExactKeysstatements that assert on the keys of a public value/type
- Add an
$ExpectTypetest for the new API to ensure it has the correct type.
To remove an API:
- Remove it from any
- Remove any
$ExpectTypetests related to it
Symbols are often used for internal state that is only accessible within a framework. We use a few symbols internally in these packages, and because of this they appear in the public type signatures, and assertions. However, unless the symbol itself is part of the public JS API of the package, these properties are inacessible to users, and thus they are not part of public API, and any changes can be made and released in a patch release.