Browser package management with modular dependency and version management. https://jspm.io
Read the current release notes here including upgrade information.
- Installs version-managed modular packages along with their dependencies from any jspm endpoint, currently supporting GitHub, npm and the jspm Registry.
- Carefully resolves version ranges within semver compatibility clearly verifying any version forks.
- Creates the SystemJS version configuration file for the package.
Build into a bundle or inject a flat dependency tree for flat multiplexing in production.
Use jspm --help to see the full up-to-date list of commands.
jspm install npm:voxel-demo
Would you like jspm to prefix the jspm package.json properties under jspm? [yes]:
Enter a name for the project (optional):
Enter baseURL path [.]:
Enter project source folder [./lib]:
Enter project built folder (optional):
Enter packages folder [./jspm_packages]:
Enter config file path [./config.js]:
Configuration file config.js doesn't exist, create it? [yes]:
Looking up npm:voxel-demo
Updating registry cache...
Looking up npm:gl-now
Looking up npm:gl-tile-map
Looking up npm:gl-vao
Looking up npm:gl-buffer
Looking up npm:gl-matrix
Looking up npm:ndarray
Looking up npm:ndarray-fill
Looking up npm:ndarray-ops
Looking up npm:ao-mesher
Looking up npm:ao-shader
Looking up npm:gl-shader
Looking up npm:game-shell
...
The above populates a jspm_packages folder in the current directory, and generates a config.js file containing the SystemJS loader configuration.
We can load this demo with:
<!doctype html>
<script src="jspm_packages/system.js"></script>
<script src="config.js"></script>
<script>
System.import('voxel-demo');
</script>- Install jspm CLI:
npm install jspm -g
- Create a project:
cd my-project
jspm init
Would you like jspm to prefix the jspm package.json properties under jspm? [yes]:
Enter a name for the project (optional):
Enter baseURL path [.]:
Enter project source folder [./lib]:
Enter project built folder (optional):
Enter packages folder [./jspm_packages]:
Enter config file path [./config.js]:
Configuration file config.js doesn't exist, create it? [yes]:
ok Verified package.json at package.json
Verified config file at config.js
Sets up the package.json and configuration file.
- Create the local application folder:
mkdir lib
jspm setmode dev
ok Local package URL set to lib.
This tells jspm that if we try to load app, or any custom name you set for your app, it will look in this folder.
If you set a custom source folder or application name, these will be used instead.
- Install any packages from the jspm Registry, GitHub or npm:
jspm install npm:lodash-node
jspm install github:components/jquery
jspm install jquery
jspm install myname=npm:underscore
Multiple installs can also be combined into a single line separated by spaces.
Any npm or Github package can be installed in this way.
Most npm packages will install without any configuration necessary. Github packages may need to be configured for jspm first. Read the guide here on configuring packages for jspm.
All installs are saved into the package.json, so that the jspm_packages folder and configuration file can be entirely recreated with a single jspm install call with no arguments. This is ideal for version-controlled projects where third party packages aren't saved in the repo itself.
The config.js file is updated with the version information and the version is locked down.
- Write application code using the packages, in any module format you feel like (including ES6):
lib/app.js
var _ = require('lodash-node/modern/objects/isEqual');
var $ = require('jquery');
var underscore = require('myname');
module.exports = 'app';- In an HTML page include the downloaded SystemJS loader along with the automatically generated configuration file (
config.js), then load the modules:
<!doctype html>
<script src="jspm_packages/system.js"></script>
<script src="config.js"></script>
<script>
System.import('lib/app')
.then(console.log.bind(console));
</script>The above should display app in the browser console
- Most npm modules should install without any additional configuration.
- Most Github modules that are not already in the registry, will need some package configuration in order to work correctly with
jspm install github:my/module.
Read about the production workflows to build a single bundle for production
Read the guide on configuring packages for jspm here.
If you are having any trouble configuring a package for jspm, please just post an issue and we'll help get it configured.
jspm install jquery
Automatically downloads and sets the configuration map for the loader.
This is equivalent to writing:
jspm install github:components/jquery
The jspm registry just provides a mapping from a name into an endpoint package name.
The npm and Github endpoints are both served by CDN, which is automatically configured in jspm.
We can switch the CDN version with a single command:
jspm setmode remote
This updates the configuration to now load all the packages from the CDN directly instead of the jspm_packages folder. The app will still behave identically, but we retain the version-lock configuration.
Revert back to the local files with:
jspm setmode local
If using the CDN version, use jspm inject instead of jspm install. This will inject the configuration into config.js without
downloading the repo to jspm_packages, making it a quicker install.
jspm inject jquery
Updating registry cache...
Looking up github:components/jquery
ok Injected jquery as github:components/jquery@^2.1.1 (2.1.1)
ok Install complete
Inject locks down exact versions allowing for a stable development environment.
jspm update
All packages will be checked, and versions upgraded where necessary.
Use -y or --yes with any command to use the defaults for all prompts.
Use -f or --force with the install command to overwrite and redownload all dependencies.
Use -o or --override to force-set the package override for a package that needs extra configuration. See https://github.com/jspm/registry#testing-package-overrides.
Local linking allows linking local folders to be installed instead of using the remote versions of packages.
Linked packages still need to be linked into a full endpoint, package and version.
cd my-local-package
jspm link npm:[email protected]
ok Package linked.
cd ../my-jspm-app
jspm install --link npm:[email protected]
my-jspm-app gets a symlink to a globally linked version of my-local-package. But changes to my-local-package do require
running jspm link npm:[email protected] again to update the link cache, as jspm runs build operations on the package when adding npm compatibility.
To reinstall from origin a linked package, use jspm install --unlink.
You may wish to create your own custom endpoints, such as a private npm repo.
This can be done with:
jspm endpoint create myendpoint jspm-npm
npm registry to use [https://registry.npmjs.org]:
Would you like to configure authentication? [no]: y
Enter your npm username: mynpmusername
Enter your npm password:
We now have an npm endpoint based on a custom registry and authentication which can be used as expected:
jspm install myendpoint:package
You can also configure these same options for the existing npm endpoint if using a local npm mirror:
jspm endpoint config npm
You may wish to run your own registry instead of using the publicly maintained default. Running your own registry is particularly useful if you are also running other custom endpoints such as a private npm registry as you can use custom endpoint references and include private modules.
A private registry can be created simply by forking the public registry. This is for convenience only - so long as the same folder and file structure is used the registry should work.
If you want to make changes and have them take effect without the need to push to your github account each time, clone the forked repo to your local machine (or clone the registry repo directly if you aren't sharing the private registry).
git clone [email protected]:jspm/registry jspm-registry
jspm endpoint config jspm
Enter the registry repo path [[email protected]:jspm/registry]: path/to/jspm-registry/.git
Now when you install or update a module your private registry will be used instead of the public registry.
There are two main workflows for production:
- Compile into a bundle.
- Cache the dependency tree for flat multiplexing via SPDY / HTTP2.
- Create a self-executing bundle
jspm bundle app/main build.js
Creates a file build.js containing app/main and all its dependencies referenced in config.js.
We can then load this with a script tag in the page:
<!doctype html>
<script src="jspm_packages/system.js"></script>
<script src="config.js"></script>
<script src="build.js"></script>
<script>
System.import('app/main');
</script>Note that bundles also support compiling ES6 code. To try out a demonstration of this, clone the ES6 demo repo here.
jspm bundle app/main - react + moment build.js
Creates a file build.js containing app/main and moment and all their dependencies, excluding react and all its dependencies.
Bundle commonality is currently in development here - jspm#133.
If you don't want to include the bundle with a script tag, but rather load it only when it is needed, we can do:
jspm bundle app/main main-bundle.js --inject
The above will create the bundle, then inject configuration into config.js to tell the SystemJS loader what modules should be loaded from the main-bundle.js file.
bundles section in modified config.js
...
"bundles": {
"main-bundle": [
"app/my-class",
"app/main"
]
}
...As soon as one of these modules is requested, the bundle is loaded dynamically.
You can also use arithmetic bundle:
jspm bundle app/main - app/core main-bundle.js --inject
This command will make main-bundle.js file with app/main and app/core module excluded.
The jspm CDN uses SPDY, optimal cache headers, and minified files, making this workflow suitable for production use.
The remaining performance issue is the round trip latency required to load deep dependencies, as we only find out the dependencies of a module once we have fetched that module, before fetching its dependencies in turn.
We can get around this by injecting the full dependency tree upfront into a dependency cache, so that all dependencies can be fetched in parallel.
jspm depcache app/main
The above will trace the full tree for app/main and inject it into the config.js depCache.
Now any imports will load the full tree in parallel, reducing the latency delay to one round trip.
To create an output distributable script file that can be used entirely on its own independent of SystemJS and jspm, we can use bundle-sfx.
jspm bundle-sfx app/main app.js
app.js contains a micro-loader implementation (1.4KB gzipped), converts all module formats into ES5 (including compiling ES6), and
maintaining bindings and circular references as with normal bundles.
- Type
jspm --helpfor command list. - Read the SystemJS documentation here.
- Add new items to the jspm registry repo by providing a pull request.
- Read more on configuring packages for jspm.
Apache 2.0