Convert addon to v2, add typescript & glint

[mkszepp]

This PR follows the new ember addon format RFC.
After this PR, the addon is a ember addon v2.
Most of the ember addons were already moved to v2, otherwise they will not anymore work in next gen of ember.

The move to the v2 addon is braking, because the addon is now a real npm package and magically parts of ember were removed. Removing magically parts of ember addons brings the effect that users must configure more things inside there app (like it is with all non ember-addons).
Converting to an v2 addon makes the addon itself easier, costs less maintaince, because the dependencies were reduced to a minium see
In additional we are moving away from broccoli, which is one big goal in ember modern apps.

The move to v2 addon supports like before FA5 & FA6.

Changes

• Created a new ember addon by using Addon blueprint
• Move FaIcon component to addon folder and old test-filed into test-app (we don't need anymore the rest)
• Convert addon to TypeScript & glint
• Change icon import logic like it is in angular or vue package of FA
• Install fastboot package in test-app, so that we are save that it works also inside fastboot apps (this was never tested since now)
• Readd support for ember v3.28 (because there is no blocking part for non supporting that version and requested in add back support for ember 3.28 #238)

Braking changes

• change icon import
• move @fortawesome/fontawesome-svg-core to peerDependencies
• remove config option enableExperimentalBuildTimeTransform which was never documented
• Remove option warnIfNoIconsIncluded as it was used only in build time code (index.js) which doesn't exists in v2 addons

Since now the icons were added as string inside config/icons.js. While build time we have search and the specified icons in fontawesome package and imported.
Example:

module.exports = function () {
  return {
    'free-solid-svg-icons': [
      'coffee',
      'magic',
      'trash-alt',
    ],
    'free-regular-svg-icons': 'all',
    'free-brands-svg-icons': 'all',
  };
};

After moving to v2 addon you can import the icons in any point of app (we should document by default in app.js/ts and explain that you can do it in every point of app).

Example of app.ts

import Application from '@ember/application';
import Resolver from 'ember-resolver';
import loadInitializers from 'ember-load-initializers';
import config from 'test-app/config/environment';
import { library, config as faConfig } from '@fortawesome/fontawesome-svg-core';
import '@fortawesome/fontawesome-svg-core/styles.css';
import {
  faCoffee,
  faMagic,
  faTrashAlt,
} from '@fortawesome/free-solid-svg-icons';
import * as freeRegularSvgIcons from '@fortawesome/free-regular-svg-icons';
import * as freeBrandSvgIcons from '@fortawesome/free-brands-svg-icons';

faConfig.autoAddCss = false;

library.add(
  faCoffee,
  faMagic,
  faTrashAlt,
);

library.add(freeBrandSvgIcons['fab']); // option to import all icons of fab
library.add(freeRegularSvgIcons['far']); // option to import all icons of far

export default class App extends Application {
  modulePrefix = config.modulePrefix;
  podModulePrefix = config.podModulePrefix;
  Resolver = Resolver;
}

loadInitializers(App, config.modulePrefix);

The app must import also the styles directly from font awesome svg package... So we give user the possibility to import the css in any place of app (its possible to add inside a component or in scss file...)

For fastboot apps we must teach to use config.autoAddCss = false otherwise the app isnt working.
In general we should recommend to import styles directly instead of auto DOM add, because it solve the issue that icons have wrong sizes since the css is loaded (the example should be show best practice use) and the behaviour is equal like today.

An additional reason to move to v2 addon solves a very long issue. Since now there was always necessary to stop and restart ember s when you have added icon, because we have created the file on first build time. With v2 addon you can add it, save changes, app makes a reload and icon is displayed.

Open ToDo's

if you like this concept, we can process by updating documentation (btw... in current docs... we speak often only from FA v5 😊) and minimal changes of console.warnings texts inside component

We can add release it for easier deploying... if you want

[mkszepp]

it was missing in v2 branch so i did added because it was used in test-app... but in fa5 the icon doesn't exists so there was necessary to remove again

[mkszepp]

@jrjohnson @robmadole can we get a review?

[jrjohnson]

It looks great, but I'm not an every day user of the addon anymore. I'll defer review to @robmadole and the FA team.

[mkszepp]

@robmadole can we get a review?

[robmadole]

@mkszepp we'll put this on the todo list but it's probably going to be a bit.

[mkszepp]

@robmadole okay thanks for feedback... i will look to prepare the docs in next time and adding support for @glimmer/components v2 as it was landed some days ago, than this PR is completely ready for merge

[mkszepp]

@robmadole now all necessary changes / preparations were done

[mkszepp]

@robmadole i have now updated everything to latest version ember version and added the new ember component style (gts) which makes part of polaris edition.

Can you tell me any specific time when this PR is scheduled for reviewing?

Or is there any possibility to get access to mantain this addon?

[robmadole]

@mkszepp would you be interesting in taking over the management of this component?

My next thought for this would be to get it released as a 3.x major version. (We have older 1.x, slightly less older 2.x, and now your work.) I want to create as little disruption as possible for us and for the person managing the component. With a 3.x we can clearly mark the shift.

It looks like @jrjohnson is not actively using this any longer so I think there's an opportunity for someone else to move into the management role. There's of course no pressure.

[mkszepp]

@robmadole yes i'm interested to overtake / manage this project, because our team is using active this package in more projects.

I agree, that we need to make a new major (v3.x), because this changes are breaking

If you can grant me access on npm (user: mkszepp) & here as contributor it would be super

[robmadole]

@mkszepp invite to npm sent!

[robmadole]

I wanted to take a quick moment to thank @jrjohnson for all of his hard work over the years on this project. He was a volunteer and took on the ownership of this when the Font Awesome team didn't have the internal expertise.

Showing some appreciation to you, Jon. 🙏

[jrjohnson]

Thanks @robmadole, was happy to help and even happier that UCSF is willing to support my time to work on the open source we use! Thrilled to see this keep progressing!!