💁🏻 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

``bash
npm install -g miny
`

Usage

$3

`bash
$ miny my-awesome-project
`

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

`bash
$ 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

$3

_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.

$3

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

$3

_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.

$3

Also, _miny_ works offline!

Examples

- _miny_ itself was created with miny. Yes.
- nuup
- npm-name-exists
- prepend-url
- microfetch
- microsoccer
- myass
- _Add yours here_... 😊

Related

- lass: Nodejs boilerplate
- nuup: npm publish` with superpowers

License

MIT

Author

| !me |
| ---------------------------------------------------------------------------- |
| Pablo Varela |