Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twyr/embroider-template
Monorepo for an example Ember v4.0+ addon implementation using the Embroider Build System
https://github.com/twyr/embroider-template
Last synced: 6 days ago
JSON representation
Monorepo for an example Ember v4.0+ addon implementation using the Embroider Build System
- Host: GitHub
- URL: https://github.com/twyr/embroider-template
- Owner: twyr
- License: other
- Created: 2022-05-05T05:16:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T03:15:39.000Z (about 2 years ago)
- Last Synced: 2024-12-06T00:16:46.580Z (24 days ago)
- Language: CSS
- Size: 3.9 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Embroider Template
#### TABLE OF CONTENTS
- [About](#about)
- [Status](#status)
- [Why](#why)
- [Goals](#goals)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Developing](#developing)
- [Contributors](#contributors)
- [License](#license)
#### ABOUT
This is a monorepo used as a template for creating [Ember](https://emberjs.com) addons using [Embroider](https://github.com/embroider-build/embroider) in the V2 format.
It consists of two packages - the Basic Addon itself, and an Ember App for testing, debugging, documenting, and showcasing the addon.
#### STATUS
| Category | Status |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Conventions | [](https://conventionalcommits.org) [](http://commitizen.github.io/cz-cli/) [](https://github.com/prettier/prettier) [](CODE_OF_CONDUCT.md) |
| Code Stats | [](https://lgtm.com/projects/g/twyr/embroider-template)  [](https://lgtm.com/projects/g/twyr/embroider-template) [](https://lgtm.com/projects/g/twyr/embroider-template/context:javascript) [](https://coveralls.io/github/twyr/embroider-template?branch=main) |
| Security | [](https://snyk.io/test/github/twyr/embroider-template?targetFile=package.json) [](https://lgtm.com/projects/g/twyr/embroider-template/alerts/)  |
| | |
| Development |   |
| Issues & PRs |     |
| | |
| Release Status |    |
| Publish Status |    |
#### WHY
The Embroider build system gets default configurations for addons from _two_ different places:
1. The _options_ from the "main" / "build" file specified in the addon's [Ember Package Metadata](https://github.com/embroider-build/embroider/blob/main/SPEC.md#definitions)
1. The _config()_ function from the same "main" / "build" file
At App build time,these addon configurations are processed as:
1. The _options_ object - merged with the _@embroider/macros_ key specified in the "ember-cli-build.js" file of the app
1. The _config()_ return value - merged with the _config/environment.js_ file of the app
The merged configs are accessible / usable in diffferent places:
1. The merged _options_ object is available in the @embroider/macros artifacts - getConfig, getOwnConfig, etc.
1. The merged _config()_ return value is available in the "contentFor" hooks
This monorepo provides an _extremely trivial_ implementation of an addon / test-app pair that reads / uses a common configuration file
called [dual-build-config.js](./addons/embroider-app/config/dual-build-config.js).
#### GOALS
Ember-related goals:
1. Build for [Ember 4.0+](https://emberjs.com) - with no expectation of backward compatibility
1. Build using [Embroider](https://github.com/embroider-build/embroider) - aim for "Native Support"
Addon goals::Showcase how to effectively integrate with / consume the Embroider build system artifacts:
1. Use the [contentFor](https://github.com/embroider-build/embroider/blob/main/SPEC.md#contentfor) hooks to conditionally inject HTML at build time - based on config defined in [{{app}}/config/environment.js](./addons/embroider-app/config/environment.js)
1. Use the [@embroider/macros](https://github.com/embroider-build/embroider/tree/main/addons/macros#readme) capabilities to conditionally include/exclude artifacts - based on config defined in [{{app}}/ember-cli-build.js](./addons/embroider-app/ember-cli-build.js)
Developer Experience Goals::Provide a monorepo to be used as a template / jump-off point:
1. Should be trivial to clone / install / build / run and see how the classical / embroider build systems interact
1. Should be trivial to remove the artifacts exported by the example addon and add new ones
1. Should be trivial to use the new artifacts in the example app
#### CONTRIBUTING
##### Code of Conduct
All contributors to this project are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) specified.
##### Developing
Details on getting the code, setting up the development environment, and instructions on how to extend/build/test the code are detailed in the
[Contribution Guide](CONTRIBUTING.md)
##### Contributors
[](#contributors)
This project owes its existence to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
#### LICENSE
This project is licensed under the [MIT +no-false-attribs](https://spdx.org/licenses/MITNFA.html) license.
You may get a copy of the license by following the link, or at [LICENSE.md](LICENSE.md)
