Skip to content
Starting point for developing Angular modules and publishing them on NPM.
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
package-dist.json
package.json
rollup.config.js
tsconfig.json

README.md

Angular NPM Module Seed

What's this?

This project intends to give an easy-to-use starter for developing and publishing an Angular NPM module, so that it then be installed through the regular npm install command by other users.

The whole project is heavily inspired by Cyrille Tuzi, through his How to build and publish an Angular module Medium post.

Getting ready

  • fork this repo and change its name to match your module's
  • clone your fork
  • review the package.json file contents and include your name, your module's name and any other information you find necessary. Also, make sure the listed dependencies and their version numbers are what you need them to be

Don't pay attention to the package-dist.json file by now, we will get there later on.

  • npm install to install all dependencies or yarn

Coding time!

You'll probably want to write some awesome code now.

The seed includes a sample module file (seed.module.ts), as well as a sample service (seed.service.ts) and a sample public component (seed.component.ts), to get you inspired.

So now it's the time to either rename those files and the classes inside them to your liking, or ditching them and writing your stuff from scratch.

Now compile it!

Once you have some nice amount of code put into your services, components, filters..., it's probably a good time to compile your module and taste the rewards for your hard work. These are the steps:

  • open the tsconfig.json file and include in the paths value all the modules your project depends on, as the final bundle won’t include them directly
  • open the rollup.config.js file and change the following values
export default {
	// (...)
	dest: 'dist/bundles/npm-module-seed.umd.js', // change this to your module's name
	// (...)
	moduleName: 'ng.npm-module-seed', // change this to your module's name
	globals: {
	// Your module use Angular things (at least the NgModule decorator), 
	// but your bundle should not include Angular.
	// So you need to set Angular as a global. And you need to know the UMD module 
	// name for each module. It follows this convention: ng.modulename 
	// Also, include the RXJS only if your module uses them.
		'@angular/core': 'ng.core',
		'@angular/common': 'ng.common',
		'rxjs/Observable': 'Rx',
		'rxjs/ReplaySubject': 'Rx',
		'rxjs/add/operator/map': 'Rx.Observable.prototype',
		'rxjs/add/operator/mergeMap': 'Rx.Observable.prototype',
		'rxjs/add/observable/fromEvent': 'Rx.Observable',
		'rxjs/add/observable/of': 'Rx.Observable'
	}
}
  • open the package-dist.json file (now is the right time to do it!) and change the details there. Keep in mind that these details will only apply to the package you will publish to NPM. Since we will only publish our generated dist folder, the building process will copy this file to the said folder and change its name. Make sure you include your module's dependencies (i.e. @angular/core and so on) as peerDependencies.
  • finally, npm run build will compile, tree-shake, uglify... your module's code into the dist folder.

Use your code locally

It would probably be a good idea to test your new module locally before publishing it to the NPM repository.

I suggest creating a separate Angular project and importing your module into it. To do that, you'll need to run npm link inside your module's dist folder; then navigate to your testing project root and run npm link {name-of-module}. This will symlink your original module to the node_modules folder of your testing project.

Just remember to run npm run build in your original module root folder so that its symlinked dist folder grabs the changes you make.

Publish your awesome module (finally!)

Once you're ready to publish your hard work so that the rest of us can take advantage of it, please follow this easy steps:

  • configure your NPM acount, if you haven't done it already, following these instructions
  • navigate to your module's dist folder and run npm publish

Anytime you need to update your module, just rebuild, change the version number and publish again.

Other stuff

To-do

  • Adding unit tests.
  • Explore using OpaqueTokens for referencing services.

Get in touch

Feel free to drop me a line if you have an issue, doubt, problem or suggestion, even just to tell me what you think. You can leave an issue here or give me a shout on Twitter.

License

MIT

You can’t perform that action at this time.