@hperchec/juisy NPM

🍊 juisy

author

license

Table of contents:

[TOC]

What is juisy?

🔧 Embedded CLI tool that uses yargs under the ground
📕 Generate your project documentation and README file with @hperchec/readme-generator
🕵️‍♂️ Automatic linting with lint-staged at pre-commit git hook
🦾 Respect Conventional commits with commitlint at commit-msg git hook

🚀 Get started

Install package:

npm install @hperchec/juisy

Squeeze!

npx juisy squeeze

You will get:

./
├─ bin/ # contains CLI
│  └─ cli/
│     ├─ cmds/ # commands dir
│     ├─ lib/ # libraries used by commands
│     └─ index.js # CLI entry file
├─ .docs/
│  └─ readme # contains configuration for @hperchec/readme-generator
└─ ...

...and some new scripts in your package.json file:

"docs", // generate documentation
"docs:api", // only api
"docs:readme", // only README file
"release", // make a release
"changelog" // generate CHANGELOG file
"postinstall" // for git hook

Just use --help option to show help:

node ./bin/cli --help

🧱 Dependencies

It will install the following packages as peer dependencies:

name	version
@commitlint/cli	^17.7.2
@commitlint/config-conventional	^17.7.0
@github/markdownlint-github	^0.6.0
@hperchec/jsdoc-plugin-define	^1.0.1
@hperchec/readme-generator	^3.0.0
chalk	^4.1.2
conventional-changelog-cli	^4.1.0
deepmerge	^4.3.1
eslint	^8.51.0
eslint-config-standard	^17.1.0
eslint-plugin-disable	^2.0.3
eslint-plugin-import	^2.29.1
eslint-plugin-jsdoc	^48.0.6
eslint-plugin-n	^16.1.0
eslint-plugin-promise	^6.1.1
execa	^5.1.1
fs-extra	^10.1.0
glob	^10.3.10
indent-string	^4.0.0
lint-staged	^14.0.1
markdown-table	^2.0.0
markdownlint-cli2	^0.12.1
markdownlint-cli2-formatter-pretty	^0.0.6
prompts	^2.4.2
semver	^7.3.7
simple-git-hooks	^2.9.0
strip-ansi	^6.0.0
yargs	^17.7.2