Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to use gulp to build JavaScript bundles?

I want to use gulp to build bundles of JavaScript files.

For example I have the following structure in my project:

  1. /vendor/vendor1/vendor1.js
  2. /vendor/vendor2/vendor2.js
  3. /js/includes/include1.js
  4. /js/includes/include2.js
  5. /js/bundle1.js
  6. /js/bundle2.js

There are vendor includes (1-2), local includes (3-4), and bundle files (5-6).

Vendor includes are just third-party JavaScript libraries installed with bower or composer. They can be CommonJS, AMD or just a plain-old jQuery plugins.

I want to specify dependencies inside of a bundle files like this:

/js/bundle1.js

(function() {

    // Vendor includes.
    include('vendor1');
    include('vendor2');

    // Local includes.
    include('includes/include1.js');
    include('includes/include2.js');

    // Some code here.

})();

I want gulp to process this source file and create a final distribution file (bundle) ensuring that all dependencies (includes) are merged together in a single file. So I can include foo.js from my HTML and all dependencies will be available to it.

I want to have a clear and robust system to manage all dependencies inside of a project and build distribution files.

  • How can I achieve this?
  • What format should I use for my own scripts (AMD, CommonJS, other)?
  • How do I specify dependencies in my source bundle files?
  • How do I build distribution?
like image 824
Slava Fomin II Avatar asked Apr 04 '14 23:04

Slava Fomin II


People also ask

Can Gulp concatenate JavaScript files?

Select the Source JavaScript Files Gulp source can take a list of filenames, a single filename, a glob pattern, or a list of glob patterns. Suppose the order of concatenation doesn't matter. In that case, you can use a glob pattern like “src/js/**/*.

How do I bundle JavaScript files?

You can bundle your JavaScript using the CLI command by providing an entry file and output path. Webpack will automatically resolve all dependencies from import and require and bundle them into a single output together with your app's script. But that's just the bare minimum it can do.

Is Webpack faster than Gulp?

The performance is not faster while comparing with other applications. But as this handles more applications within itself, it cannot keep the tasks in-memory. Gulp is used less, and the users do not prefer much the application. Webpack is preferred by the users and is older than Gulp.

How do I add a JS file to a gulp project?

Setup your file structure Now that the Gulp tasks are declared, you need to create a new folder named ‘ src ’, and within that folder, you need to create two additional folders: ‘ js ’ and ‘ css ’. In the ‘ js ’ folder you can add as many JS files as you want, with any name.

How do plugins work in Gulp?

They can change the filename, metadata, or contents of every file that passes through the stream. Plugins from npm - using the "gulpplugin" and "gulpfriendly" keywords - can be browsed and searched on the plugin search page. Each plugin should only do a small amount of work, so you can connect them like building blocks.

How to minify Node JS using gulp?

Once you have installed Node.js on your computer, you need to create a file called package.json and declare the npm packages that will be used for the minification process. Copy and paste the code below into your package.json file: 3. Create a ‘gulpfile.js’ file and add the required code Next, create a file called gulpfile.js.

How to minify HTML files with gulp?

the minfied HTML files are output to the declared destination. The below code first declares a new gulp task, ‘gulp clean’, which deletes everything in the output folder (this is to ensure that only the required files are in the output folder). The code then declares a task, ‘gulp default’, which runs the minification tasks in sequence: 4.


2 Answers

Your question is posed as if there's a single answer, but there isn't. The problem you're trying to solve is one that many people have solved in many different ways, and you've identified two of the major options: AMD and CommonJS. There are other ways, but given that you might be new to Javascript dependency management as well as gulp, I'd recommend going with something that's relatively straightforward (even though this subject is inherently not straightforward).

I think the easiest route for you might be:

  • use CommonJS to express the dependencies
  • use browserify to resolve them into bundles
  • in browserify, use the "UMD" method so that you get a single bundle that will work for apps that use either AMD or CommonJS or are not using either of these dependency management systems

The statement in gulp to run browserify as such might look something like:

var browserify = require('gulp-browserify');
gulp.src('bundles/bundle1.js', {read: false})
  .pipe(browserify({
    'standalone': true
  })
  .pipe(rename('bundle1Output.js'))
  .pipe(gulp.dest('dist'));

That should give you a dist/bundle1Output.js file.

like image 51
daphne-d Avatar answered Oct 19 '22 23:10

daphne-d


There is a gulp plugin for this:

https://www.npmjs.com/package/gulp-include

It should do what you want, except that in your bundle file instead of this:

    (function() {

        // Vendor includes.
        include('vendor1');
        include('vendor2');

        // Local includes.
        include('includes/include1.js');
        include('includes/include2.js');

        // Some code here.

    })();

You would have to write:

    //=require vendor1/**/*.js
    //=require vendor2/**/*.js

    //=require includes/include1.js
    //=require includes/include2.js

    // Some code here
like image 40
Karolis Avatar answered Oct 19 '22 23:10

Karolis