@mikermcneil/kit

    1.4.1 • Public • Published

    kit

    kit

    A simple command-line tool with a few handy tools, including:

    • generating ASCII art from text
    • verifying package.json dependencies (vs. rodestead)
    ∑ kit about
    •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •
      ___--¬___
     |~~ ``` ~~|
     |         |
     |_________|
     |_________|
     
    kit vXX.XX.XX
    (run kit for usage)
     
    kit is a light-hearted grab bag of command-line utilities.
    Feel free to fork, add whatever, and send PRs if you like.
    https://github.com/mikermcneil/kit
    •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •  •

    Installation

    ∑ npm install -g @mikermcneil/kit

    kit

    ∑ kit
     
      Usage: kit [options] <command>
     
     
      Commands:
     
        pkg         show the version of the package in the current directory
        deps        get the install footprint + versions of this package's dependencies
        exclaim     convert a message to ASCII art and copy it to your clipboard
        h1          exclaim a custom heading for your JavaScript code
        h2          exclaim a custom sub-heading for your JavaScript code
        about       what is kit?
        help [cmd]  display help for [cmd]
     
      Options:
     
        -h, --help     output usage information
        -V, --version  output the version number
     

    kit pkg

    ∑ cd /code/sails
    ∑ kit pkg
    -----------------------------------------------------------------
    sails
    API-driven framework for building realtime apps, using MVC conventions (based on Express and Socket.io)
    v0.12.4
    MIT License
     
    > http://npmjs.org/package/sails
    > http://github.com/balderdashy/sails/
    -----------------------------------------------------------------

    kit deps

    ∑ cd /code/machinepack-fs
    machinepack-fs: ∑ kit deps
    lodash.isobject@3.0.2                                            ~5.3 KB
    lodash.isfunction@3.0.8                                          ~5.96 KB
    rttc@9.3.4  (~9.3.0)                                             ~1.06 MB
    machine@13.0.0-11                                                ~577.34 KB
    walker@1.0.7                                                     ~17.09 KB
    machinepack-json@2.0.1  (~2.0.0)                                 ~1.51 MB
    machinepack-strings@5.0.0                                        ~2.26 MB
    machinepack-util@6.0.1  (~6.0.0)                                 ~2.51 MB
    fs-extra@0.30.0                                                  ~317.26 KB
     
    Altogether, dependencies weigh in at ~8.28 MB
    (that will take an average of ~4.14 seconds on coffee shop internet)
     
     (Note that `devDependencies` and `optionalDependencies` were NOT included above.)

    kit exclaim

    ∑ kit exclaim hello world!
    -----------------------------------------------------------------
    OK, I copied an ASCII-art-ified version of that message to your clipboard:
     
    //  ██╗  ██╗███████╗██╗     ██╗      ██████╗     ██╗    ██╗ ██████╗ ██████╗ ██╗     ██████╗ ██╗
    //  ██║  ██║██╔════╝██║     ██║     ██╔═══██╗    ██║    ██║██╔═══██╗██╔══██╗██║     ██╔══██╗██║
    //  ███████║█████╗  ██║     ██║     ██║   ██║    ██║ █╗ ██║██║   ██║██████╔╝██║     ██║  ██║██║
    //  ██╔══██║██╔══╝  ██║     ██║     ██║   ██║    ██║███╗██║██║   ██║██╔══██╗██║     ██║  ██║╚═╝
    //  ██║  ██║███████╗███████╗███████╗╚██████╔╝    ╚███╔███╔╝╚██████╔╝██║  ██║███████╗██████╔╝██╗
    //  ╚═╝  ╚═╝╚══════╝╚══════╝╚══════╝ ╚═════╝      ╚══╝╚══╝  ╚═════╝ ╚═╝  ╚═╝╚══════╝╚═════╝ ╚═╝
    //
    -----------------------------------------------------------------

    Options

    ∑ kit exclaim --help
     
      Usage: kit-exclaim [options]
     
      Options:
     
        -h, --help   output usage information
        -a, --args   the serial command-line arguments.
        -w, --width  the width before wrapping.
        -f, --font   the ASCII font to use.
     

    Headings

    ∑ kit exclaim 'find user & populate projects' --width=15
    -----------------------------------------------------------------
    OK, I copied an ASCII-art-ified version of that message to your clipboard:
     
    //  ███████╗██╗███╗   ██╗██████╗     ██╗   ██╗███████╗███████╗██████╗        ██╗
    //  ██╔════╝██║████╗  ██║██╔══██╗    ██║   ██║██╔════╝██╔════╝██╔══██╗       ██║
    //  █████╗  ██║██╔██╗ ██║██║  ██║    ██║   ██║███████╗█████╗  ██████╔╝    ████████╗
    //  ██╔══╝  ██║██║╚██╗██║██║  ██║    ██║   ██║╚════██║██╔══╝  ██╔══██╗    ██╔═██╔═╝
    //  ██║     ██║██║ ╚████║██████╔╝    ╚██████╔╝███████║███████╗██║  ██║    ██████║
    //  ╚═╝     ╚═╝╚═╝  ╚═══╝╚═════╝      ╚═════╝ ╚══════╝╚══════╝╚═╝  ╚═╝    ╚═════╝
    //
    //  ██████╗  ██████╗ ██████╗ ██╗   ██╗██╗      █████╗ ████████╗███████╗
    //  ██╔══██╗██╔═══██╗██╔══██╗██║   ██║██║     ██╔══██╗╚══██╔══╝██╔════╝
    //  ██████╔╝██║   ██║██████╔╝██║   ██║██║     ███████║   ██║   █████╗
    //  ██╔═══╝ ██║   ██║██╔═══╝ ██║   ██║██║     ██╔══██║   ██║   ██╔══╝
    //  ██║     ╚██████╔╝██║     ╚██████╔╝███████╗██║  ██║   ██║   ███████╗
    //  ╚═╝      ╚═════╝ ╚═╝      ╚═════╝ ╚══════╝╚═╝  ╚═╝   ╚═╝   ╚══════╝
    //
    //  ██████╗ ██████╗  ██████╗      ██╗███████╗ ██████╗████████╗███████╗
    //  ██╔══██╗██╔══██╗██╔═══██╗     ██║██╔════╝██╔════╝╚══██╔══╝██╔════╝
    //  ██████╔╝██████╔╝██║   ██║     ██║█████╗  ██║        ██║   ███████╗
    //  ██╔═══╝ ██╔══██╗██║   ██║██   ██║██╔══╝  ██║        ██║   ╚════██║
    //  ██║     ██║  ██║╚██████╔╝╚█████╔╝███████╗╚██████╗   ██║   ███████║
    //  ╚═╝     ╚═╝  ╚═╝ ╚═════╝  ╚════╝ ╚══════╝ ╚═════╝   ╚═╝   ╚══════╝
    //
    -----------------------------------------------------------------

    Sub-headings

    ∑ kit exclaim 'SEND EMAIL via mailgun' --width=25 --font='Calvin S'
    -----------------------------------------------------------------
    OK, I copied an ASCII-art-ified version of that message to your clipboard:
     
    //  ╔═╗╔═╗╔╗╔╔╦╗  ╔═╗╔╦╗╔═╗╦╦    ┬  ┬┬┌─┐  ┌┬┐┌─┐┬┬  ┌─┐┬ ┬┌┐┌
    //  ╚═╗║╣ ║║║ ║║  ║╣ ║║║╠═╣║║    └┐┌┘│├─┤  │││├─┤││  │ ┬│ ││││
    //  ╚═╝╚═╝╝╚╝═╩╝  ╚═╝╩ ╩╩ ╩╩╩═╝   └┘ ┴┴ ┴  ┴ ┴┴ ┴┴┴─┘└─┘└─┘┘└┘
    -----------------------------------------------------------------

    kit h1

    ∑ kit h1 hi
    -----------------------------------------------------------------
    OK, I copied an ASCII-art-ified version of that message to your clipboard:
     
    //  ██╗  ██╗██╗
    //  ██║  ██║██║
    //  ███████║██║
    //  ██╔══██║██║
    //  ██║  ██║██║
    //  ╚═╝  ╚═╝╚═╝
    //
    -----------------------------------------------------------------

    kit h2

     
    ∑ kit h2 hi
    -----------------------------------------------------------------
    OK, I copied an ASCII-art-ified version of that message to your clipboard:
     
    //  ┬ ┬┬
    //  ├─┤│
    //  ┴ ┴┴
    -----------------------------------------------------------------

    Credits

    This module wouldn't be possible without @patorjk's amazing work on figlet.

    See also:

    Links / Reminders

    License

    MIT

    Keywords

    none

    Install

    npm i @mikermcneil/kit

    DownloadsWeekly Downloads

    27

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    75.9 kB

    Total Files

    16

    Last publish

    Collaborators

    • mikermcneil