search

nie-ine / npm-package

npm package for the NIE-INE component collection
MIT License
2 stars 0 forks source link

readme

nie ine component collection

initial project from: https://github.com/robisim74/angular-library-starter

angular-library-starter

Build Status

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

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

  1. Update Node & npm.

  2. Rename angular-library-starter and angularLibraryStarter everywhere to my-library and myLibrary.

  3. Customize the license-banner.txt file with your library license.

  4. Update in package.json file:

    • version: Semantic Versioning
    • description
    • urls
    • packages (optional): make sure you use a version of TypeScript compatible with Angular Compiler (@angular/compiler-cli@5.0.0 requires a peer of typescript@>=2.4.2 <2.5)

    and run npm install.

  5. Create your classes in src folder, and export public classes in my-library.ts: if you have components, note that this starter supports only inline templates & styles as the official Angular building process.

  6. You can create only one module for the whole library: I suggest you create different modules for different functions, so that the host app can only import the modules it uses, and optimize its Tree shaking.

  7. Update in rollup.config.js file globals external dependencies with those that actually you use to build the umd bundle.

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

3 Testing

The following command runs 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

5 Publishing

Before publishing the first time:

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="https://github.com/nie-ine/npm-package/raw/devel/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: it is intended 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

9 Inlining of templates and stylesheets

From Angular Package Format v5.0:

Component libraries are typically implemented using stylesheets and html templates stored in separate files. While it's not required, we suggest that component authors inline the templates and stylesheets into their FESM files as well as *.metadata.json files by replacing the stylesheetUrls and templateUrl with stylesheets and template metadata properties respectively. This simplifies consumption of the components by application developers.

ngc compiler still does not support inlining of templates & styles. But if you want, you can follow this suggestion: Inlining of templates and stylesheets.

Built with this starter

Previous versions

License

MIT