Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glimmerjs/glimmer.js
Central repository for the Glimmer.js project
https://github.com/glimmerjs/glimmer.js
glimmer glimmer-application glimmer-apps glimmer-component glimmer-testing glimmerjs typescript ui-components
Last synced: about 1 month ago
JSON representation
Central repository for the Glimmer.js project
- Host: GitHub
- URL: https://github.com/glimmerjs/glimmer.js
- Owner: glimmerjs
- License: mit
- Created: 2017-07-11T16:08:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T15:36:01.000Z (4 months ago)
- Last Synced: 2024-05-21T23:03:54.042Z (4 months ago)
- Topics: glimmer, glimmer-application, glimmer-apps, glimmer-component, glimmer-testing, glimmerjs, typescript, ui-components
- Language: TypeScript
- Homepage: https://glimmerjs.com
- Size: 6.02 MB
- Stars: 744
- Watchers: 44
- Forks: 75
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Glimmer.js
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.
## Resources
- [Guides](https://github.com/glimmerjs/glimmer-experimental/blob/master/README.md)
- [Glimmer Playground](https://glimmerjs.github.io/glimmer-experimental)
## Packages
Glimmer.js is the developer-facing API on top of the low-level [Glimmer VM](https://github.com/glimmerjs/glimmer-vm).
### User-Facing
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
[`@glimmer/component`]: https://github.com/glimmerjs/glimmer.js/tree/master/packages/%40glimmer/component
[`@glimmer/tracking`]: https://github.com/glimmerjs/glimmer.js/tree/master/packages/%40glimmer/tracking
## Tests
### Type Tests
The following packages are committed to maintaining stable Typescript types in
addition to their JavaScript API:
* `@glimmer/component`
* `@glimmer/tracking`
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:
```sh
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:
1. Add it to any `hasExactKeys` statements that assert on the keys of a public
value/type
2. Add an `$ExpectType` test for the new API to ensure it has the correct type.
To remove an API:
1. Remove it from any `hasExactKeys` statements
2. Remove any `$ExpectType` tests related to it
#### Symbols
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.