angular-library-starter

Build an Angular library compatible with AoT compilation & Tree shaking.

This starter allows you to create a library for Angular v5 apps written in TypeScript, ES6 or ES5. The project is based on the official Angular packages.

Get the Changelog.

Contents

• 1 Project structure
• 2 Customizing
• 3 Testing
• 4 Building
• 5 Publishing
• 6 Documentation
• 7 Using the library
• 8 What it is important to know

1 Project structure

• Library:
  • src folder for the classes
  • public_api.ts entry point for all public APIs of the package
  • package.json npm options
  • rollup.config.js Rollup configuration for building the umd bundles
  • rollup.es.config.js Rollup configuration for building the es2015 bundles
  • tsconfig-build.json ngc compiler options for AoT compilation
  • build.js building process using ShellJS
• Testing:
  • tests folder for unit & integration tests
  • karma.conf.js Karma configuration that uses webpack to build the tests
  • spec.bundle.js defines the files used by webpack
• Extra:
  • tslint.json TypeScript linter rules with Codelyzer
  • travis.yml Travis CI configuration

2 Customizing

1. Update Node & npm.

2. Rename angular-library-starter and angularLibraryStarter everywhere to my-library and myLibrary. Also update the license-banner.txt file.

3. Update in package.json file:

   • version: Semantic Versioning
   • description
   • urls
   • packages (optional)

   and run npm install.

4. Create your classes in src folder, and export public classes in my-library.ts.

5. You can create only one module for the whole library: I suggest you create different modules for different functions, so that the user can import only those he needs and optimize Tree shaking of his app.

6. Update in rollup.config.js file globals external dependencies with those that actually you use.

7. Create unit & integration tests in tests folder, or unit tests next to the things they test in src folder, always using .spec.ts extension. Karma is configured to use webpack only for *.ts files.

3 Testing

The following command run unit & integration tests that are in the tests folder (you can change the folder in spec.bundle.js file):

npm test 

It also reports coverage using Istanbul.

4 Building

The following command:

npm run build

• starts TSLint with Codelyzer
• starts AoT compilation using ngc compiler
• creates dist folder with all the files of distribution

To test locally the npm package:

npm run pack-lib

Then you can install it in an app to test it:

npm install [path]my-library-[version].tgz

5 Publishing

Before publishing the first time:

• you can register your library on Travis CI: you have already configured .travis.yml file
• you must have a user on the npm registry: Publishing npm packages

npm run publish-lib

6 Documentation

To generate the documentation, this starter uses compodoc:

npm run compodoc
npm run compodoc-serve 

7 Using the library

Installing

npm install my-library --save 

Loading

Using SystemJS configuration

System.config({
    map: {
        'my-library': 'node_modules/my-library/bundles/my-library.umd.js'
    }
});

Angular-CLI

No need to set up anything, just import it in your code.

Rollup or webpack

No need to set up anything, just import it in your code.

Plain JavaScript

Include the umd bundle in your index.html:

<script src="node_modules/my-library/bundles/my-library.umd.js"></script>

and use global ng.myLibrary namespace.

AoT compilation

The library is compatible with AoT compilation.

8 What it is important to know

1. package.json

   • "main": "./bundles/angular-library-starter.umd.js" legacy module format
   • "module": "./esm5/angular-library-starter.js" flat ES module, for using module bundlers such as Rollup or webpack: package module
   • "es2015": "./esm2015/angular-library-starter.js" ES2015 flat ESM format, experimental ES2015 build
   • "peerDependencies" the packages and their versions required by the library when it will be installed

2. tsconfig.json file used by TypeScript compiler

   • Compiler options:
     • "strict": true enables TypeScript strict master option

3. tsconfig-build.json file used by ngc compiler

   • Compiler options:

     • "declaration": true to emit TypeScript declaration files
     • "module": "es2015" & "target": "es2015" are used by Rollup to create the ES2015 bundle

   • Angular Compiler Options:

     • "skipTemplateCodegen": true, skips generating AoT files
     • "annotateForClosureCompiler": true for compatibility with Google Closure compiler
     • "strictMetadataEmit": true without emitting metadata files, the library will not be compatible with AoT compilation: to report syntax errors immediately rather than produce a .metadata.json file with errors

4. rollup.config.js file used by Rollup

   • format: 'umd' the Universal Module Definition pattern is used by Angular for its bundles
   • moduleName: 'ng.angularLibraryStarter' defines the global namespace used by JavaScript apps
   • external & globals declare the external packages

5. Server Side Rendering

   If you want the library will be compatible with Server Side Rendering:

   • window, document, navigator and other browser types do not exist on the server
   • don't manipulate the nativeElement directly

Built with this starter

• angular-l10n An Angular library to translate messages, dates and numbers
• angular-auth-oidc-client An OpenID Connect Implicit Flow client for Angular
• ngx-infinite-scroll An infinite scroll directive for Angular compatible with AoT compilation and Tree shaking
• ngx-typeahead A simple but yet powerful typeahead component for Angular
• ng2-youtube-player A Powerful Youtube Player Component for Angular

License

MIT