JSPM

  • Created
  • Published
  • Downloads 191
  • Score
    100M100P100Q68212F
  • License MIT

One tooling, No setup.

Package Exports

  • tooling

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tooling) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

version npm Travis branch

Join the chat at https://gitter.im/egoist/tooling extra David

Purpose

You always need to configure webpack for each of your projects, drop webpack.config.dev.js webpack.config.prod.js for development and production envs. Install tons of common modules like loaders and frameworks. Tooling is just an apporach to skip that verbose procedure.

Technologies

What tooling supports (which means you don't have to install these dependencies yourself):

  • Webpack
  • Babel 6 + Stage-0 + Runtime + Polyfill
  • React with JSX
  • Vue/Vue-loader
  • PostCSS/css-modules/cssnext
  • Autoprefixer
  • Hot reloading
  • BrowserSync
  • Custom HTML template
  • Build or Watch
  • Long-term caching
  • Custom format, iife/umd/commonjs

Real world example, run npm start in this repo or try it out 👉

Usage

Installing tooling via NPM is easy (WARN: only work for Node.js >= 4 and NPM@3):

npm install tooling -g

Build a project in production mode:

# default entry is ./src/index
# in this case we use Vue in our app
tooling build --entry [entry]

# multi entry support
# configure this is `package.json`
{
    "tooling": {
        "entry": whatever...
    }
}

Run dev server with hot reloading:

# default entry is ./src/index
# in this case we use React in our app
tooling watch --entry [entry] --use react

Run tooling -h tooling watch -h tooling build -h to see more usages.

Set up custom index.html in package.json. see usage at html-webpack-plugin

{
    "name": "My tooling app",
    "tooling": {
        "index": {
          "title": "tooling index",
          "template": "src/index.jade"
        }
    }
}

If it's complex to configure via CLI arguments (like multi entry), feel free to set in package.json.

For advanced usage: Wiki

API

WIP.

npm install tooling --save
import tooling from 'tooling'

/**
 * Tooling
 *
 * @param {string} type - 'watch' or 'build'
 * @param {object} options - options for webpack,
 * 					    - override the default settings.
 *				 options.port - available in 'watch' mode
 *							  - to set the port devServer should run at
 */
tooling(type, options)

License

MIT © EGOIST