rucksack.js v1.0.1

$ rucksack.js

Bundle js files by replacing the require calls in-place.

Note: The current version is not really production ready.

It does work for my use-cases, but it should be improved by

parsing the real tree. Check out the falafel branch.

Contributions in this direction are really welcome! :sparkling_heart:

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global rucksack.js

# Using yarn
yarn global add rucksack.js

Then, run rucksack --help and see what the CLI tool can do.

$ rucksack --help
Usage: rucksack.js [options]

Options:
  -p, --path <path>               Sets the input js file path.
  -g, --global <global-variable>  Global variable name (it will be created when the
                                  commonjs environment will not be available)
  -o, --output <path>             Specify an output file where to write the bundle
                                  code.
  -h, --help                      Displays this help.
  -v, --version                   Displays version information.

Examples:
  rucksack -p input.js
  rucksack -p input.js -o bundle.js
  rucksack -p input.js -o bundle.js -g LibraryName

Documentation can be found at https://github.com/IonicaBizau/rucksack#readme

:clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install rucksack.js (or yarn add rucksack.js):

const rucksack = require("rucksack.js");

// math.js:
// const sum = require("./sum.js");
// const square = require("./square.js");
//
// module.exports = {
//     sum: sum
//   , square: square
// };

// sum.js:
// module.exports = (a, b) => a + b;

// square.js:
// module.exports = x => x * x;

console.log(rucksack(`${__dirname}/math.js`, "Math"));
// =>
// "use strict";
// (function() {
//     var _rucksackModule = typeof module !== "undefined" ? module : {};
//     const sum = (a, b) => a + b;
//     const square = x => x * x;
//
//     _rucksackModule.exports = {
//         sum: sum,
//         square: square
//     };
//     if (typeof module !== "object")
//         window.Math = _rucksackModule.exports
// })();

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:
• —I love books! I will remember you after years if you buy me one. :grin: :book:
• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău