@mediacologne/angular-utility-module

News

Installation

Install the NPM Module

$ npm install @mediacologne/angular-utility-module

Using the Library

Nach der Installation muss die Library durch das Importieren des UtilityModule verfügbar gemacht werden.

// Import your library
import { AuthModule } from '@mediacologne/angular-utility-module';

@NgModule({
  imports: [
    UtilityModule
  ]
})
export class AppModule { }

Documentation

Concepts

Es folgt eine kurze Erklärung über die Konzepte der einzelnen Komponenten dieser Library.

Developing the Library

Während der Entwicklung an der Library muss diese getestet werden, gebuilded werden sowie gepublished werden können. Hier steht wie's geht:

Testing

Um die Library zu testen muss im ./demo Ordner ein ng serve ausgeführt werden.

Aus irgendeinem Grund kommt nach dem Start von ng serve sofort ein Fehler

ERROR in Error: Error encountered resolving symbol values statically. Function calls are not supported. Consider replacing the function or lambda with a reference to an exported function

Dieser Fehler kann ignoriert werden, denn er verschwindet bei der nächsten Quellcode Änderung. Grund des Fehlers ist unklar => https://github.com/angular/angular-cli/issues/3707

Building

Um die Library zu builden wird im ./ Verzeichnis ein npm run build ausgeführt. Dadurch wird die kompilierte Version im ./dist Verzeichnis erzeugt. Der Buildprozess läuft über die Gulp Tasks innerhalb der ./gulpfile.js. Die Library wurde erstellt mittels yo a2lib libname von https://github.com/johannesjo/generator-angular2-lib

Publishing

Um eine neue Version der Library zu publishen wird im ./ Verzeichnis ein npm publish ausgeführt. Es ist zu beachten, dass vor dem publishen einer neuen Version unbedingt die Versionsnummer angehoben werden muss.

Generell empfiehlt es sich, zuerst die Versionsnummer anzuheben und anschließend ein build anzustoßen. Ist dies erfolgreich kann die Library gepublished und anschließend die Code Änderung commited werden.