DEV Community

loading...
Cover image for My own cli boilerplate tool

My own cli boilerplate tool

Lucas.T
Writing code with JavaScript πŸ’› Check my work on Github ➑️ https://github.com/luctst
・1 min read

A cli tool to generate node module project includes tools like avaJs for testing, eslint, prettier etc...


Install πŸš€:

Run

npm install -g luctst-cli
Enter fullscreen mode Exit fullscreen mode

Or if you have NPX:

npx luctst-cli [commands] <options>
Enter fullscreen mode Exit fullscreen mode

Usage πŸ–:

This package will create this folder structure by default:

β”œβ”€β”€ .github/
β”‚ β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚ β”‚ β”œβ”€β”€ bug_report.md
β”‚ β”‚ β”œβ”€β”€ feature_request.md
β”‚ β”œβ”€β”€ CODE_OF_CONDUCT.md
β”‚ β”œβ”€β”€ CONTRIBUTING.md
β”‚ β”œβ”€β”€ LICENSE
β”‚ β”œβ”€β”€ pull_request_template.md
β”œβ”€β”€ lib/
β”‚ β”œβ”€β”€ main.js
β”œβ”€β”€ test/
β”‚ β”œβ”€β”€ test.js
β”œβ”€β”€ .editorconfig
β”œβ”€β”€ .estlintrc.json
β”œβ”€β”€ .gitattributes
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .prettierignore
β”œβ”€β”€ .prettierrc.json
β”œβ”€β”€ .travis.yml
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
β”œβ”€β”€ README.md
Enter fullscreen mode Exit fullscreen mode

Run this command to start the process:

luctst-cli start
Enter fullscreen mode Exit fullscreen mode

Note - By default if path flag is not present folder will be created with process.cwd()

With the β€”path flag:

luctst-cli start -p=<folder-name>
Enter fullscreen mode Exit fullscreen mode

Note - Create the folder inside the folder.

More informations here - https://www.npmjs.com/package/luctst-cli

Happy coding βœ¨πŸ§‘β€πŸ’»

Discussion (0)