📜 List of Contest

• Install
• How to start
• Config
  • Custom file path
  • Init config
  • Formatter
  • Prompts

Install

NPM

npm install -D commitsmile

PNPM

pnpm add -D commitsmile

Yarn

yarn add -D commitsmile

How to start

👋Hello! Glad to see you! There is order task to setup:

Config

In Default execute app is looking for files names match /commitsmile.*\.(json|mjs|cjs|js|mts|cts|ts)/iu

• Name: commitsmile (letters can be uppercase or lowercase or mixed)
• pre ext (optional)
• Ext: json|mjs|cjs|js|mts|cts|ts

examples:

• commitsmile.discord.ts
• coMMitSmile.json

Custom file path

To set custom path to config we can use optional parameter -C,--config where <PATH> can be relative or absolute path:

npm run commitsmile -C <PATH>

If Path:

• do not include filename it will use standard process to find.
• include - will just check this file (faster way)

Init config

to init config we use init:

npm run commitsmile init

Formatter

You format your commit message at your rules!