A command line tool to optimize the repetitive actions.
You can install the package globally and use it as command line tool:
# Using npmnpm install --global blah# Using yarnyarn global add blah
blah --help and see what the CLI tool can do.
$ blah --help Usage: blah <command> [options] A command line tool to optimize the repetitive actions. Commands: init Inits the .blah directory. Options: -b, --bump-version Bumps the package.json version. -r, --readme Creates the README.md file. -g, --gitignore Creates the .gitignore file. -l, --license <license> Generates a LICENSE file with copyright information. -d, --docs <path> Generates the markdown documentation (DOCUMENTATION.md) for input file. -c, --contributing Generates the CONTRIBUTING.md. -f, --force When running `blah` without any arguments, force overriding existing files. -v, --version Displays version information. -h, --help Displays this help. Examples: $ blah --readme # generates README.md $ blah --gitignore # generates .gitignore $ blah --license mit # writes the MIT license in the LICENSE file $ blah --docs index.js # generates DOCUMENTATION.md from index.js, parsing JSDoc comments $ blah --bump-version major # bumps the major field of version, in package.json file The templates directories that can contain templates based on which the files README.md, .gitignore, DOCUMENTATION.md and CONTRIBUTING.md are created, are searched in the following order: local .blah directory, ~/.blah-templates, library templates. The library templates are always available. Happy Blahing! Documentation can be found at https://github.com/IonicaBizau/blah.
Here is an example how to use this package as library. To install it locally, as library, you can do that using
# Using npmnpm install --save blah# Using yarnyarn add blah
// Dependenciesvar Blah = ;// Create a new Blah instancevar blh = "path/to/project";// Generate the .gitignore fileblh;// Create a copy of The KINDLY licenseblh;
❓ Get Help
There are few ways to get help:
Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. 🐛
For direct and quick help, you can use Codementor. 🚀
For full API reference, see the DOCUMENTATION.md file.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.
💖 Support my projects
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like 🚀
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
💫 Where is this library used?
If you are using this library in one of your projects, add it in this list. ✨
ship-release—Publish new versions on GitHub and npm with ease.