kwonkunkun-convenient-script
v1.1.5
Published
Kwonkunkun's convenient script
Downloads
5
Readme
my-convenient-shell-scripts
This script sets up several Git hooks and packages in order to enforce a standardized commit message format and streamline the release process.
Constraints
git init must be done before running this script
npm version 7 or higher (because of the 'npm pkg' command)
Installation
npm i kwonkunkun-convenient-script
Usage
set-kwon-env
Features
Husky
Husky is a tool that allows you to easily set up Git hooks. This script uses it to set up a prepare
script that installs Husky and an appropriate configuration file.
Commitlint
Commitlint is a tool that checks whether a commit message meets a specified format. This script uses it to enforce the Conventional Commits format.
Commitizen
Commitizen is a tool that provides a command-line interface for generating commit messages that meet a specified format. This script uses it to prompt the user for the necessary information to generate a commit message.
Release-it
Release-it is a tool that simplifies the process of creating a new release of your project. This script uses it to automatically generate a changelog, create a Git tag, and publish a new version of your package to NPM. It is configured to use the Conventional Commits format.
License
This script is licensed under the MIT License.