Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buschtoens/ember-cli-resolve-asset
Resolves asset paths to their fingerprinted counterpart. Useful for interpolated paths.
https://github.com/buschtoens/ember-cli-resolve-asset
ember-addon ember-cli ember-cli-addon emberjs
Last synced: 24 days ago
JSON representation
Resolves asset paths to their fingerprinted counterpart. Useful for interpolated paths.
- Host: GitHub
- URL: https://github.com/buschtoens/ember-cli-resolve-asset
- Owner: buschtoens
- License: mit
- Created: 2019-02-07T17:49:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:34:41.000Z (11 months ago)
- Last Synced: 2024-10-09T12:42:04.655Z (about 1 month ago)
- Topics: ember-addon, ember-cli, ember-cli-addon, emberjs
- Language: JavaScript
- Size: 623 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-resolve-asset
[](https://travis-ci.org/buschtoens/ember-cli-resolve-asset)
[](http://badge.fury.io/js/ember-cli-resolve-asset)
[](http://badge.fury.io/js/ember-cli-resolve-asset)
[](https://emberobserver.com/addons/ember-cli-resolve-asset)
[](https://github.com/prettier/prettier)
[](https://david-dm.org/buschtoens/ember-cli-resolve-asset)
[](https://david-dm.org/buschtoens/ember-cli-resolve-asset)
Imperatively resolves assets fingerprinted by
[**`broccoli-asset-rev`**][broccoli-asset-rev], which allows you to even resolve
_interpolated_ paths.
## Installation
```
ember install ember-cli-resolve-asset
```
If you want to use this in one of your addons, the consuming host application
will also need to install `ember-cli-resolve-asset`. If this not a case, a
helpful build error will be shown.
### Setup
The following configuration in your `ember-cli-build.js` is required for this
addon to work correctly.
```js
const app = new EmberAddon(defaults, {
fingerprint: {
enabled: true, // If false, this addon is disabled also.
generateAssetMap: true, // Required.
fingerprintAssetMap: true // Recommended to prevent caching issues.
},
'ember-fetch': {
preferNative: true // Recommended to enable faster preloading for browsers that support it.
}
});
```
- [`broccoli-asset-rev` options](https://github.com/rickharrison/broccoli-asset-rev#options)
- [`ember-fetch` options](https://github.com/ember-cli/ember-fetch#allow-native-fetch)
## Usage
### Utils
#### `resolveAsset`
**`async resolveAsset(path: string, withoutPrepend = false): Promise`**
Asynchronously resolves the given `path` from the asset map.
If the asset map is not loaded yet, this function will wait for it.
If loading the asset map fails, the returned `Promise` will reject.
If the path is not listed in the asset map, the returned `Promise` will reject.
```ts
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';
import fetch from 'fetch';
import resolveAsset from 'ember-cli-resolve-asset';
export default class ApplicationRoute extends Route {
@service intl;
@service language;
async beforeModel() {
const preferredLanguage = this.language.getPreferredLanguage();
const translationsPath = await resolveAsset(
`translations/${preferredLanguage}.json`
);
const translations = await fetch(translationsPath);
this.intl.addTranslations(preferredLanguage, await translations.json());
this.intl.setLocale(preferredLanguage);
}
}
```
#### `resolveAssetSync`
**`resolveAssetSync(path: string, withoutPrepend = false): string`**
Synchronous version of [`resolveAsset`](#resolveAsset).
Synchronously resolves the given `path` from the asset map.
If the asset map is not loaded yet, this function will throw.
If the path is not listed in the asset map, this function will throw.
Usage of this function is discouraged in favor of `resolveAsset`. Only use this
function, if using the async version is not feasible and if you can guarantee,
that [`load`](#load) ran to completion beforehand.
```ts
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';
import fetch from 'fetch';
import {
resolveAssetSync,
load as loadAssetMap
} from 'ember-cli-resolve-asset';
export default class ApplicationRoute extends Route {
@service intl;
@service language;
async beforeModel() {
await loadAssetMap();
const preferredLanguage = this.language.getPreferredLanguage();
const translationsPath = resolveAssetSync(
`translations/${preferredLanguage}.json`
);
const translations = await fetch(translationsPath);
this.intl.addTranslations(preferredLanguage, await translations.json());
this.intl.setLocale(preferredLanguage);
}
}
```
#### `load`
**`async load(): Promise`**
This function returns a `Promise` that resolves once the asset map was loaded
successfully. Repeatedly calling this function returns the same `Promise`. After
this `Promise` has resolved, you can use
[`resolveAssetSync`](#resolveAssetSync).
This function is called automatically by an initializer, to start the loading of
the asset map as soon as possible. This means there is no direct need for you to
call this function yourself, unless you want to await the asset map explicitly.
## Related Projects
- [**`broccoli-asset-rev`**][broccoli-asset-rev]: The ember-cli addon that
performs the fingerprinting and generates the asset map.
- [**`ember-fetch`**][ember-fetch]: Used by this addon to asynchronously load
the asset map.
- [**`ember-cli-ifa`**][ember-cli-ifa]: The original inspiration for this addon.
I was dissatisfied with the technical implementation, the bugs it caused and
current state of maintenance, which is why I created this addon instead.
[broccoli-asset-rev]: https://github.com/rickharrison/broccoli-asset-rev
[ember-fetch]: https://github.com/ember-cli/ember-fetch
[ember-cli-ifa]: https://github.com/RuslanZavacky/ember-cli-ifa