Skip to content

Latest commit

 

History

History
136 lines (106 loc) · 7.92 KB

README.md

File metadata and controls

136 lines (106 loc) · 7.92 KB
Raw

BrowserifyTuttie

Just another sample nimbler Browserify and Gulp task setup with examples. It can use npm scripts or gulp tasks to build a live reloading server with Beefy or Browsersync, image optimisation with Imagemin, scripts uglification, contacting with source maps and task sequencing.

Getting Started

This is an npm project. To play with it, git clone it to your desired directory and run npm install to install all the project dependencies. Note that:

  • This master branch has examples of browserify usage with both npm scripts in package.json and gulp tasks in gulpfile.js.
  • If you are only interested in using browserify with just npm scripts, check out the npm-scripts branch which is much smaller in size and has less dev dependecies
  • The gulp-tasks branch has examples that only showcase usage of gulp tasks with browserify

npm scripts

You can create your custom script to perform command line utils. Add a new entry within the script object of package.json and call them with npm run scriptname. They are placed in the scripts body of package.json.

Examples:

npm run setup

This script basically runs an npm install, to install the project and dev dependencies, and calls another script clean that deletes build directory if present and creates a new one, and another imagemin that minifies and optimizes images and copies them to the build directory.

clean calls the rm:build script that uses rimraf to perform a cross platform delete CLI operation on the build directory.

clean:js is a variation of clean that only deletes the js directory in the build with rm:js. This saves time in tasks using it, as the already minified images that take time to recreate with imagemin are not deleted.

The imagemin script uses imagemin-cli which is a CLI utility that wraps around imagemin and allows us to minify the images within the npm script as imagemin does with gulp tasks.

npm run bundle

Uses browserify to bundle the app.js file with all the required module dependencies into a single file. To extract source maps from the generated bundle.js, it uses the browserify mapstraction plugin

npm run build This build task is much similar to the bundle task. In fact it's identical to it, except that on finishing the bundling, it uses watchify to stay actively watching for changes in the background and rebuilding the bundle.

npm run build:min builds a minified bundle. It uses minifyify to uglify the bundle and extract out the source maps to a named output directory.

npm run clean:watch makes sure that the build and all the code watching starts on a clean slate.

npm run serve

This launches a the project from the index file using beefy. Options supplied instruct beefy to launch the server from the specified app.js scripts on port 8000, open in the default browser and stay live to continue watching and reloading on changes made.

npm start

This is equivalent to npm run start. Npm has some predefined run script pointers like start, stop and test which when defined within the scripts object in package.json, you dont need to provide the run command to execute the.

  • Note that this script just calls the bundle then the serve scripts
  • The test script is not implemented, but just a placeholder message.

gulp tasks

Npm scripts are very useful for automating development, tests, and production tasks but with the complexity of the build process the tasks can easily get out of hand. Enter Gulp tasks, much more like npm scripts on steroids. Within the gulpfile.js are tasks that accomplish fucntionlity that the above npm scripts addressed. Since this file is a javascript file, it allows room for more task manipulation login unlike the limiting JSON bottleneck with npm scripts. Gulp tasks are run by gulp taskname and if the task is not found within the gulpfile, gulp will throw an error.

  • Example 1 Task defined in the gulpfile.js by...
gulp.task("first-task", () => {
    return "Perfome this task..."
});

And executed in the CLI by...

gulp first-task
  • Example 2 Execute firsttask before another task
gulp.task("anothertask", ["first-task"], (done) => {
    return "Perfome some other logic here..."
});

And executed in the CLI by...

gulp anothertask
  • Example 3 These tasks run in sequence, one after the other. Check out the run-sequence utility
gulp.task('selfhost', (done) => {
    runSequence('clean', 'hosted', () => {
        console.log('Self hosting with a clean build');
        done();
    });
});

And executed in the CLI by...

gulp selfhost

List of the gulp tasks

NOTE

  • Since the gulpfile.js supports inline comments, the tasks have been briefly annotated to explain the simple logic.
  • The default task is the one that gets called when you run gulp without specifying any other args

Notes

The .npm-timeline is just a side notebook documentation npm commands that were used along to give you a general idea of the installation of the npm scripts along the way. Reference has been made to some good reads in the comment section of some tasks

Prerequisites

This project assumes you have installed nodejs on your machine and added node_modules to the system environments variables

ToDos

  • Add tests say with mocha
  • Test foe env viriables when building eg PROD or DEV eg remove source maps on production
  • Fix Uglify failure on app.js script

License

This project is licensed under the MIT License