Boilerplatenode NPM

boilerplatenode

This is a node cli package intended for generating the starter code for any node file, module or package.

General info
Screenshots
Technologies
Setup
Features
Status
Inspiration
Contact

General info

Instead of having to create .js files and having to import same utilities time and again, let boilerplatenode handle this work for you. Just run it as a regular command after linking it and pass the appropriate flags for importing these system modules. boilerplatenode automates this work. You can take this further and even write shell scripts calling this command and it would generate as many files as you want.

It doesn't have any dependencies and hence it'll work with a system that has node installed without requiring anything else.

Screenshots

To access help use --help flag.

print Help

Use the --out flag to see the content that will be written to the file.

print Help

Use the --file [NAME] option to enter a filename without the .js extension or the default created file would be named index.js.

print Help

Technologies

NodeJS - version 14.15.0
Windows Terminal
Bash shell and any other POSIX based environment.

Setup

Install Node from NodeJS.org
Clone the git repository and cd into the repository.
Use the command npm link boilerplatenode.
You can now use this as an executable command systemwide as boilerplatenode --file [NAME] [options] or bpn --file [NAME] [options].
print help using boilerplatenode --help.

Features

Use systemwide after linking.
0 dependencies; Only uses node core modules.
Automate the workflow by generating .js files on the file with this package.

To-do list:

ADD functionality for passing filename as option in the shell environment. ✅
Write unit tests for the functionality.
Make it more flexible by passing number of files to be generated.

Status

Project is: in progress

Inspiration

The sole inspiration for creating this package is to automate the daily task of creating files using touch and then importing the same boiler plate code everyday before starting to write some actual implementation of the new program.