bring-me v0.1.0

bring-me

NPM CLI tool for delivering common front-end libraries, frameworks, stylesheets, etc. for lightweight and easy development without needing them stored in node_modules or when internet connection could be a problem in the future.

Install

install globally with NPM: npm install -g bring-me

Introduction

Bring-me is a CLI tool used to download popular frameworks from there CDNs so that you can use them offline when needed in mostly Front-End Development scenerios

Summary:

Bring-me scans a bmconfig.json file to get the most popular frameworks and libraries (bootstrap,bulma,jquery,lodash,phaser at the moment).

bmconfig.json example

[
  {
    "url": "https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.js",
    "file-name": "jquery.js",
    "lib-name": "jquery",
    "format": "js",
    "version": "3.6.0"
  },
  ...
]

bmconfig.json fields:

url: (contains the url of the library from cdn) file-name: (the name of the library with extension) lib-name: (library name with out extension) format: (in which format is the file (js,css,html,etc.)) version (version of the file that has been added)

From this config file you can run the following V0.0.1 bring-me commands:

Bring-me Commands

bring-me lib -d,--dir

Running:

$ bring-me lib <lib-name>

Will download the library into your project root directory.

Running:

$ bring-me lib <lib-name> [-d, --dir <directory>]

Will download the library into your project with the directory you specified.

bring-me add

Running:

$ bring-me add <url> <file-name> <lib-name> <format> <version>

Will add the specified library to the bmconfig file, but will not be downloaded yet.

Running:

$ bring-me add <url> <file-name> <lib-name> <format> <version> [-i, --include]

Will add the specified library to the bmconfig filt and will download the file to the current working directory.

bring-me list

Running:

$ bring-me list

Will list all the libraries that are available in the config file, but that haven't been downloaded

Conclusion

The purpose of this app is to not be dependent of node_modules when you need some simple application since node_modules can become really heavy and complex during your projects, which means that if you only want to include your files to a simple .html, you can safely add them by only running the "bring-me" command.

Contribute

You are free to contribute and add functionalities to the librrary if you want, and I will consider them in later releases

Much Obliged (4tydev)