README

Snipacks

A dead simple, fast and objective manager for packages, snippets and assets.

CLI
Packages/Snippets/Assets manager
Simple, fast, objective
Get only files you want from NPM packages
Fetch Gist and Gitlab snippets to save as code
Grab anything from the web
All automated by a simple JSON setup

Install

In your project:

npm i -S snipacks

Or...

yarn add snipacks

Then, include a new command in package.json into scripts section:

{
  "scripts": {
    "snipacks": "snipacks"
  }
}

Choose a name of your preference, but point it to snipacks.

Or, if you prefer, install it globaly:

npm i -g snipacks

Then you can run CLI snipacks anywhere.

Usage

Snipacks reads a section at your package.json file that register packages, snippets, gists or anything you want to fetch into your project.

Create a snipacks section like this:

{
  "snipacks": {
    "unpkg": {
      "worktopus.js": "worktopus",
      "moment.js": "moment/min/moment-with-locales.min.js"
    },
    "gist": {
      "kav.js": "steven89/f7aedca683deee6ee8211399e94cd583",
      "asq.js": "jyamashiro24/17ac171a73246744b09a47d6c9d77241"
    },
    "gitlab": {
      "dom.js": "34295",
      "dstrbg.styl": "1662645",
      "tplrender.js": "1663326"
    },
    "web": {
      "jquery.js": "https://code.jquery.com/jquery-3.2.1.slim.min.js",
      "animate.css":
        "https://raw.githubusercontent.com/daneden/animate.css/master/animate.min.css"
    },
    "bundle": {
      "lib.js": [
        "https://unpkg.com/core-js/client/core.min.js",
        "https://unpkg.com/vue/dist/vue.min.js",
        "https://unpkg.com/vuex/dist/vuex.min.js",
        "https://unpkg.com/vue-router/dist/vue-router.min.js"
      ]
    }
  }
}

Then, just run snipacks CLI command!

Key-value pairs within sections represent file-source, so key is the filename where the asset will be saved and value is the source to fetch.

Result

Snipacks saves downloaded files into a diretory structure corresponding to snipacks section at package.json:

./
| -${snipacks dir}
   | - bundle
   | - gist
   | - gitlab
   | - unpkg
   | - web

Snipacks directory (since 1.2.0)

By default, Snipacks save downloads inside a snipacks folder, but it is possible to set a custom path to save your snipakcs.

Just define dir on setup at package.json:

{
    "snipacks": {
        "dir": "path/to/your/custom/snipacks"
    }
}

How it works

NPM / Unpkg

Snipacks get the code for NPM packages from Unpkg CDN. So, NPM packages must to be at unpkg section.

Optionally, you can use SEMVER tags if you need to specify packages versions, like:

{
  "snipacks": {
    "unpkg": {
      "moment.js": "moment@2.18.1/min/moment-with-locales.min.js"
    }
  }
}

If no version was defined, latest version is default.

Gist and Gitlab Snippets

For these codes/snippets repositories, Snipacks simply fetch the raw files as is.

The codes must to be public available.

Gist needs user/hash to identify and get the code. Gitlab Snippets just need an id.

Web / Anything

Snipacks can fetch any public file online. Just map it into web section.

Bundle (since 1.3.0)

If you want to build a bundle of libs it is easy with Snipacks.

Map an Array with urls to save your libs to a file into bundle section.

All fetched content will be concatenated in the same order and saved to the file.

CLI commands

Snipacks CLI support some simple commands. If none is given, update is default.

update (default)

Update/fetch all of your assets with this simple command: snipacks update or simply snipacks.

Important: By default, this command rewrites snipacks section at package.json file to sort content. If you need to prevent this behavior for continous integration or any other production workflow, make sure to set NODE_ENV with any value that not contains dev (case not sensitive).

add

You can add new assets to your project by manually adding snipacks section at package.json and runing update command.

But snipacks add [type] [file] [source] command is a better way:

snipacks add unpkg moment.js moment/min/moment-with-locales.min.js

snipacks add gist kav.js steven89/f7aedca683deee6ee8211399e94cd583

snipacks add gitlab dom.js 34295

snipacks add web animate.css https://raw.githubusercontent.com/daneden/animate.css/master/animate.min.css

Arguments must follow this pattern:

type represents the Internet end point where asset is hosted, section within snipacks at package.json and folder into snipacks directory
file define the filename where to save content
source is an ID, PATH or URL to fetch content

Important: This command ever writes data to package.json file to update snipacks section.

del

To remove assets you can just delete files from directory and remove entry from snipacks section at package.json.

But you can simply run snipacks del [type] [file]:

snipacks del web jquery.js