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

mrbuilder

v3.3.1

Published

Tools for developing with mrbuilder and webpack

Downloads

39

Readme

These tools help develop mrbuilder, they could be used in other multimodule, monorepos. This is meant to hold all common dev dependencies. This dependency has all of the mrbuilder tools. You can use the plugins for more specific tools.

Autoinstall

Adding plugins to your project or running these commands, may cause them to added as dep dependencies to your project. This is a good thing, as now you only have to add them in one place. If you add the deps themselves then it will not auto install.

Upgrade from 1.2.x->2.0.0

This should be a seamless upgrade, for the supported plugins. Webpack4 is significantly different and third party plugins may need to be changed to support webpack 4. For now 2.0.0 and 1.x will be supported until Webpack5 is released. Then Mrbuilder 3.x and 2.x will be supported. I only have so much bandwidth to support old versions; while at the same time not everyone has the bandwith to upgrade all the time. Sound like a reasonable compromise?

Upgrade from 0.x->1.2

The 'mrbuilder' package no longer ships with the dependencies. Dependencies will be added as you run commands. That is calling mrbuilder will cause the plugin to be installed. You can add the plugins manually to your package.json if you prefer; as it may be faster.

Configuration

The tools are designed to run with smart defaults. Edit your package.json like this

"scripts":{
 "karma": "mrbuilder",
 //if you want plain moch use mrbuilder-mocha instead.
    "test": "mrbuilder",
    "demo": "mrbuilder",
    "app":"mrbuilder",
    "server": "mrbuilder",
    //use "babel":"mrbuilder", to only run babel instead of webpack
    "prepublish": "mrbuilder",
},
"devDependencies":{
 "mrbuilder-plugin-support":"^2.2.3"
}

With this configuration you can run

  • Tests:
$ yarn run test
  • Karma:
$ yarn run karma
  • Demo:
$ yarn run demo
  • Server:
$ yarn run server

Babel

Mrbuilder uses babel to compile source code. This command is for when you don't need webpack to do the compiling. The arguments are the same as babel-cli but are defaulted to

$ mrbuilder-babel -s true &&\
 --out-dir lib &&\
 --copy-files &&\

Webpack

This tool is designed to compile your code with webpack. It respects all the webpack cli but has been extended to be easier in multimodule projects. Part of what this does is creates alias to make debugging and changing multiple modules easier in dev mode and compile and biuld modes.

Custom Webpack Configuration

Sometimes you need to change webpacks configuration. mrbuilder-webpack extends normal webpack behaviour to look into the dependencies and the current project for a babel-config.js if this file exists it attempts to load it. this file differs from traditional webpack as that it is expected to be a function

module.export = function(options,webpack, optionsManager){
  // options - are just for passing meta data to other loaders and from other loaders.
  // webpack is the actual configuration.  You can do whatever.
  // The optionsManager currently running.
  return webpack.
}

If you want or don't want different modules loaded by webpack, it looks in package.json for include/exclude array of globs

package.json

{
  "mrbuilder":{
     "plugins":["your_plugins"],
  }
}

Mocha

For non browser testing we use plain mocha. Its faster and easier to run than Karma but can not do browsery things. It uses the same babel configuration as mrbuilder-babel. It uses a combination of environmental variables and arguments for configuration, though typically it takes neither.

Karma

Karma testing is useful for testing in browser. This configuration uses the aformentioned webpack with the following additional settings.