Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lmammino/lumpy

A lumpy and dummy JavaScript module bundler for those who are stuck in the past
https://github.com/lmammino/lumpy

bundle concatenate dependencies frontend javascript minify module modules tool utility

Last synced: 3 months ago
JSON representation

A lumpy and dummy JavaScript module bundler for those who are stuck in the past

Host: GitHub
URL: https://github.com/lmammino/lumpy
Owner: lmammino
License: mit
Created: 2018-03-11T12:42:27.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2018-03-19T18:49:27.000Z (almost 7 years ago)
Last Synced: 2024-09-18T12:53:10.155Z (4 months ago)
Topics: bundle, concatenate, dependencies, frontend, javascript, minify, module, modules, tool, utility
Language: JavaScript
Size: 445 KB
Stars: 4
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 👾 lumpy

[![npm version](https://badge.fury.io/js/lumpy.svg)](http://badge.fury.io/js/lumpy)
[![CircleCI](https://circleci.com/gh/lmammino/lumpy.svg?style=shield)](https://circleci.com/gh/lmammino/lumpy)
[![codecov.io](https://codecov.io/gh/lmammino/lumpy/coverage.svg?branch=master)](https://codecov.io/gh/lmammino/lumpy)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

A lumpy and dummy JavaScript module bundler for those who are stuck in the past

![Lumpy logo](/resources/lumpy-logo.png)

## 💽 Install

As usual in 2018, most of the software is installed through `npm`, this one makes no difference:

```bash
npm install --global lumpy
```

Be sure to have `node >= 8.0.0`.

At this point you should be able to run the `lumpy` executable. Try it with:

```bash
lumpy --help
```

### 💾 Precompiled binaries

Alternatively, you can install lumpy by downloading one of the precompiled executables available for Windows, Linux or Mac in the [releases page](https://github.com/lmammino/lumpy/releases).

## 🦔 Usage

Lumpy helps you to build a JavaScript bundle file for your frontend applications dependencies starting from a lumpy file (`lumpy.txt`).

A lumpy file is a plain text file that contains a list of the URLS of all your dependencies. An example `lumpy.txt` looks as follows:

```plain
# lumpy.txt
https://unpkg.com/[email protected]/dist/zepto.min.js
https://unpkg.com/[email protected]/dist/uuid.core.js
https://unpkg.com/[email protected]/dist/store2.min.js
https://unpkg.com/[email protected]/dist/tippy.all.min.js
https://unpkg.com/[email protected]/dist/index.min.js
https://unpkg.com/[email protected]/lib/main.js
https://unpkg.com/[email protected]/favico-0.3.10.min.js
```

A lumpy file can contain only URLs and comments. A comments is a line starting with `#`. Separate URLs need to be in separate lines. You can have as many empty lines as you want.

Inside your project, once you create your `lumpy.txt` file, listing all the dependencies for your frontend application, you can create a single compiled file containing all of them with the following command:

```bash
lumpy build
```

This will output the built package in `vendor.js`. This file will contain the code contained in all the URLs specified in your `lumpy.txt` file (in the same order). By default the resulting JavaScript file will be minified using [babel-minify](http://npm.im/babel-minify).

## 😱 Advanced usage

The `lumpy` executable offers 3 main sub-commands:

- `build`: creates a build package from a `lumpy.txt` file
- `clear-cache`: clears the cache folder
- `--help`: display the help for the main executable or a subcommand (`lumpy [build | clear-cache] --help`)

### 📦 Build

The build command allows you to build a vendors package from a `lumpy.txt` file.

#### Usage:

```bash
lumpy build [destFile]
```

Where `destFile` is the path of the *compiled* bundle file (by default it will be `vendors.js` in the current working directory).

#### Options:

- `--lumpyFile, -l [file]`: (optional) the lumpy file to use. By default it will check for a `lumpy.txt` file in the current working directory
- `--cacheFolder, -c [path]`: (optional) the path to a folder where the cache files are stored. By default it will create a `.lumpy-cache` directory in your user home directory.
- `--noMinify, -M`: (optional) if set it won't minify the resulting vendors bundle file.
- `--noCache, -C`: (optional) if set it won't try to use the cache
- `--stdout, -o`: (optional) if set it will output the resulting bundle in the standard output instead of a doing that on a file. Useful if you want to pipe the resulting content to another command.

### 🛀🏿 Clear cache

Clear the cache folder deleting all the previously downloaded files.

#### Usage:

```bash
lumpy clear-cache
```

#### Options:

- `--cacheFolder, -c [path]`: (optional) the path to a folder where the cache files are stored. By default it will create a `.lumpy-cache` directory in your user home directory.

## 👯‍ Contributing

Everyone is very welcome to contribute to this project.
You can contribute just by submitting bugs or suggesting improvements by
[opening an issue on GitHub](https://github.com/lmammino/stream-accumulator/issues).

## 🤦‍ License