npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

systemjs-pluginbuilder

v0.1.1

Published

A systemJS build tool to create plugin based bundles

Downloads

1

Readme

systemjs-pluginbuilder

A systemJS build tool to create plugin based bundles.

Travis Status

This project allows builds of systemjs based modules. The key feature is separated build outputs. The main build, called base build, should contain all required modules and libraries. You then have the option to add smaller builds, called plugins, containing modules missing in the base build. This approach allows to ship builds on websites, where the base script is cached by the browser while plugins can be exchanged on each site and keep traffic low.

Tasks

If you're looking for a gruntjs to build your files, take a look at this one: grunt-systemjs-pluginbuilder

Installation

This package is available on npm as: systemjs-pluginbuilder

	npm install systemjs-pluginbuilder

Options

builder

This defines the builder which should be used. There are currently two possible values: systemjs and jspm. Each value refers to a specific builder:

The default value of this option is systemjs.

Attention: When using jspm as builder, the configPath option will be ignored. The builder uses the configured path to the config file inside the package.json. You also should not rewrite the baseURL property using the config option. This value can be defined in the package.json as well.

	builder: 'systemjs'

configPath

This sets the path to the systemjs config file. This is option is required when using the systemjs builder.

	configPath: 'js/src/config.js'

config

This option allows to add or overwrite settings from the loaded config file.

	config: {
		paths: {
			'app/*': 'js/src/*'
		}
	}

basePath

This is the path to the base file. The path should be defined as string. This option is required.

	basePath: 'js/src/Base.js'

pluginPaths

This is a list of all plugin files. The build of these files will have a substracted module tree of the base file. The paths will be defined as array of strings.

	pluginPaths: [
		'js/src/PluginA.js',
		'anywhere/else/src/PluginB.js'
	]

out

This defines the relative output path for built base and plugin files. The path is defined relative to each source file (defined by basePath and pluginPaths). The default value is '../build/'.

	out: '../build/'

Example: When using ../build/ as out option, with js/src/Base.js being the location of the base file, the build process will output to js/build/Base.js.

Functions

An instance of the PluginBuilder has the following methods

new PluginBuilder(options)

The constructor will create an instance of the pluginbuilder. You can pass the options as properties of an object into the constructor. The available options are documented here.

	var PluginBuilder = require('systemjs-pluginbuilder'),
	var builder = new PluginBuilder({
		basePath: 'jsr/src/Base.js',
		pluginPaths: [
			'js/src/PluginA.js',
			'js/src/PluginB.js'
		]
	});

build()

When calling this function, a build will be generated with the given options from the constructor. This function returns a promise to handle the async build process.

	builder
		.build()
		.then(function() {
			global.console.log('Your build is done');
		})
		.catch(function(error) {
			global.console.error('Your build failed: ', error);
		});

Examples

An example is located in the example directory. Simply clone this repository, call npm install and run node example/example.js. This example will create a build directory in example/build.

Contribution

Feel free to contribute. Please run all the tests and validation tasks before you offer a pull request.

Tests & validation

Run grunt validate test to run the tests and validation tasks.

Readme

The readme chapters are located in the docs directory as Markdown. All Markdown files will be concatenated through a grunt task 'docs'. Call grunt docs to only update the README.md. Run grunt to run validation, tests and update the ```README.md``.

Note: Do not edit the README.md directly, it will be overwritten!

License

LICENSE (MIT)