The minimal module generator that generated itself
This module is a very easy way of getting started in nodejs, npm modules, TDD and CI.
npm install -g miny
Generate a new project
$ miny my-awesome-project
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. (...)
It includes github actions that will automatically run tests on every push and pull request.
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
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.
Also, miny works offline!
- miny itself was created with miny. Yes.
Add yours here...