miny

    7.0.7 • Public • Published

    💁🏻 miny

    The minimal module generator that generated itself

    This module is a very easy way of getting started in nodejs, npm modules, TDD and CI.

    Look at miny's awesome features

    Install

    npm install -g miny

    Usage

    Generate a new project

    $ miny my-awesome-project

    Screencast

    You can also use de option -y to skip all the questions and use the defaults:

    $ miny my-awesome-project -y
    Creating package in my-awesome-project
    warning The yes flag has been set. This will automatically answer yes to all questions which may have security implications.
    (...)

    Features

    Tests. optional

    miny provides ava or myass to test your code. By default you get a test.js with a test example. Running npm test will execute all your tests.

    CI

    It includes github actions that will automatically run tests on every push and pull request.

    Code style

    miny comes with prettier built-in to automatically format your code on every commit, so you can forget about code inconsistencies across your codebase.

    It's also useful to use an actual linter for catching some bugs or not used code, so it also includes eslint to lint all your code and help you fixing potential bugs.

    You can customize the rules it follows by modifying the section prettier in package.json. By default, it will use 2 spaces as tabs, remove unnecessary semicolons and convert double quoutes to single quoutes. You can add/remove all of these rules. You can also edit the eslint rules in .eslintrc.yml. Take a look at eslint docs. Runnning npm run lint will run both prettier and eslint in your project. There's also a lint-fix npm script that can help fixing trivial errors.

    Offline

    Also, miny works offline!

    Examples

    Related

    • lass: Nodejs boilerplate
    • nuup: npm publish with superpowers

    License

    MIT

    Author

    me
    Pablo Varela

    Install

    npm i miny

    DownloadsWeekly Downloads

    56

    Version

    7.0.7

    License

    MIT

    Unpacked Size

    13.9 kB

    Total Files

    20

    Last publish

    Collaborators

    • avatar