Release 0.6.0-alpha.0

CHANGELOG.md

@@ -5,6 +5,30 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ---
 
+## [0.6.0-alpha.0](https://github.com/FortAwesome/angular-fontawesome/releases/tag/0.6.0-alpha.0) - 2019-11-11
+
+Make sure to check [upgrade instructions](https://github.com/FortAwesome/angular-fontawesome/blob/master/UPGRADING.md).
+
+### Added
+
+* Support for Angular 9 and Ivy.
+* [`FontAwesomeTestingModule`](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/guide/testing.md#use-fontawesometestingmodule-to-mock-icon-library) to simplify testing components using icon library.
+* `FaConfig.fallbackIcon` which allows to specify a fallback icon to use when `FaIconComponent.icon` is not set or specified icon definition is missing from the icon library.
+* `ng-add` schematic to simplify initial library setup.
+* [Documentation](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/guide/testing.md) on how to test components using Font Awesome icons.
+* `LICENSE` file into the published package.
+
+### Changed
+
+* `FaConfig.globalLibrary` default value has been changed to `false`. `fa-icon`/`fa-duotone-icon` won't look for icon definitions in the global icon library by default. See [upgrade instructions](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/upgrading/0.4.0-0.5.0.md#migrate-from-global-icon-library-to-faiconlibrary) for the previous release for more details about this change.
+* Warning when `FaIconComponent.icon` is not set or specified icon definition is missing in the icon library was changed into a hard error to make it more clear and visible (in particular in the unit tests).
+
+### Removed
+
+* `FaIconComponent.iconProp` was removed. Use `FaIconComponent.icon` instead.
+* `FaIconComponent.listItem` was removed. Use `FaIconComponent.fixedWidth` + custom CSS to render icons as list markers.
+* `FaIconService` was removed. Use `FaConfig` instead.
+
 ## [0.5.0](https://github.com/FortAwesome/angular-fontawesome/releases/tag/0.5.0) - 2019-08-12
 
 Make sure to check [upgrade instructions](https://github.com/FortAwesome/angular-fontawesome/blob/master/UPGRADING.md).

DEVELOPER.md

@@ -31,6 +31,8 @@ Command     | Purpose
 `yarn lint`        | Verify code style
 `yarn test`        | Execute unit tests
 `yarn test:schematics`        | Execute unit tests for schematics
+`yarn test:demo`        | Execute unit tests of the demo project
+`yarn test:integration`        | Execute integration tests
 `yarn start`       | Run development server for the demo application
 `yarn build`       | Build library
 `yarn build:schematics`       | Build schematics (should be run after the library build)
@@ -43,7 +45,7 @@ Command     | Purpose
 1. Update Compatibility table in `README.md`
 1. Update the `CHANGELOG.md`
 1. Update the `UPGRADING.md` if necessary
-1. `yarn build`
+1. `yarn build && yarn build:schematics`
 1. `cd dist/angular-fontawesome`
 1. `npm publish`
 1. `git commit -a -m 'Release VERSION'`

README.md

@@ -10,14 +10,12 @@ Official Angular component for Font Awesome 5
 
 ## Installation
 
-<!-- TODO: uncomment for the next release and mention in Compatibility table
 Using `ng add`:
 
 ```
 # See Compatibility table below to choose a correct version
 $ ng add @fortawesome/angular-fontawesome@<version>
 ```
--->
 
 Using [Yarn](https://yarnpkg.com)
 ```
@@ -37,12 +35,13 @@ $ npm install @fortawesome/angular-fontawesome@<version>
 
 ### Compatiblity table
 
-|@fortawesome/angular-fontawesome|Angular|
-|-|-|
-|0.1.x|5.x|
-|0.2.x|6.x|
-|0.3.x|6.x && 7.x|
-|0.4.x, 0.5.x|8.x|
+|@fortawesome/angular-fontawesome|Angular|ng-add|
+|-|-|-|
+|0.1.x|5.x|not supported|
+|0.2.x|6.x|not supported|
+|0.3.x|6.x && 7.x|not supported|
+|0.4.x, 0.5.x|8.x|not supported|
+|0.6.x|8.x,9.x|supported|
 
 ## Usage
 To get up and running using Font Awesome with Angular follow below steps:
@@ -131,6 +130,8 @@ being awesome contributors to this project. **We'd like to take a moment to reco
 [<img src="https://github.com/damienwebdev.png?size=72" alt="damienwebdev" width="72">](https://github.com/damienwebdev)
 [<img src="https://github.com/ronniebarker.png?size=72" alt="ronniebarker" width="72">](https://github.com/ronniebarker)
 [<img src="https://github.com/bhanuhiteshi.png?size=72" alt="bhanuhiteshi" width="72">](https://github.com/bhanuhiteshi)
+[<img src="https://github.com/plinkpaste.png?size=72" alt="plinkpaste" width="72">](https://github.com/plinkpaste)
+[<img src="https://github.com/ej2.png?size=72" alt="ej2" width="72">](https://github.com/ej2)
 
 If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
 

UPGRADING.md

@@ -13,3 +13,4 @@ You might also be interested in the larger umbrella project [upgrade guide](http
 * [Font Awesome 4 or older](docs/upgrading/v4.md)
 * [0.1.0 to 0.1.0-6](docs/upgrading/0.1.0-0.1.0-6.md)
 * [0.4.0 to 0.5.0](docs/upgrading/0.4.0-0.5.0.md)
+* [0.5.0 to 0.6.0](docs/upgrading/0.5.0-0.6.0.md)

docs/upgrading/0.5.0-0.6.0.md

@@ -0,0 +1,42 @@
+# Upgrading 0.5.0 to 0.6.0
+
+## Migrate from global icon library to FaIconLibrary
+
+See [upgrade instructions](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/upgrading/0.4.0-0.5.0.md#migrate-from-global-icon-library-to-faiconlibrary) for the previous release.
+
+## `FaIcon.icon` and `FaDuotoneIcon.icon` inputs are now required
+
+`icon` input of these components is now required and will throw an error if it is missing or set to `null` or `underfined`. Review your application for unexpected errors and ensure that `fa-icon` component always has a meaningful `icon` input.
+
+When using `AsyncPipe` with `icon` input you have 3 options:
+
+- Do not render `fa-icon` component until icon is loaded
+
+    ```html
+    <fa-icon *ngIf="icon$ | async as icon" [icon]="icon"></fa-icon>
+    ```
+
+- Render a placeholder icon while icon is loaded
+
+    ```typescript
+    this.icon$ = this.loadIcon().pipe(startsWith(defaultIcon));
+    ```
+
+- Provide a fallback icon to be used instead of any missing icon in the application
+
+    ```typescript
+    import { FaConfig } from '@fortawesome/angular-fontawesome';
+    import { faBan } from '@fortawesome/free-solid-svg-icons';
+
+    export class AppModule {
+      constructor(config: FaConfig) {
+        config.fallbackIcon = faBan;
+      }
+    } 
+    ``` 
+
+## Icon definition missing from the icon library is now hard error
+
+Previously attempt to render an icon, which is missing from the icon library was logging a soft warning. In this release the warning was changed to a hard error to improve discoverability of such bugs. Review your application for unexpected errors and ensure that all used icons are added to the icon library.
+
+Also refer to the [testing documentation](https://github.com/FortAwesome/angular-fontawesome/blob/master/docs/guide/testing.md#test-components-using-icon-library) to learn how to test components using icon library without getting missing icon errors.

package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "./node_modules/ng-packagr/package.schema.json",
   "name": "@fortawesome/angular-fontawesome",
-  "version": "0.5.0",
+  "version": "0.6.0-alpha.0",
   "description": "Angular Fontawesome, an Angular library",
   "scripts": {
     "test": "ng test angular-fontawesome --watch=false --browsers=ChromeCI",
@@ -40,7 +40,8 @@
     "Damien Retzinger <[email protected]>",
     "Ronnie Barker <[email protected]>",
     "bhanuhiteshi <[email protected]>",
-    "James Hyde <[email protected]>"
+    "James Hyde <[email protected]>",
+    "ej2 <[email protected]>"
   ],
   "license": "MIT",
   "bugs": {

projects/schematics/src/ng-add/versions.ts

@@ -1,3 +1,3 @@
 export const svgCoreVersion = '^1.2.21';
-export const angularFontawesomeVersion = '~0.5.0';
+export const angularFontawesomeVersion = '~0.6.0-alpha.0';
 export const iconPackVersion = '^5.10.2';