@kabeep/exception

📖 Introduction

> Inspired by the work of sindresorhus, I decided to open source the most repetitive
> encapsulation work I do in CLI development.

I do not like disorder. Often, unexpected situations arise due to our insufficient consideration. Therefore, I encourage
those around me to engage in more comprehensive error collection work.

The goal of Exception is to transform unexpected occurrences into anticipated outcomes as much as possible.

It allows Error objects to throw exception and stack information in a more aesthetically pleasing and intuitive manner,
and can also serve as Notify to output critical information in workflows.

⚙️ Installation

``bash
npm install @kabeep/exception --save
`

`bash
yarn add @kabeep/exception
`

`bash
pnpm add @kabeep/exception
`

🚀 Usage

$3

example

!Plain-text-or-Error-object

`javascript
import Exception from '@kabeep/exception';

// Plain text
throw new Exception('Argument example');

// or Error object
throw new Exception(new Error('Argument example'));
`

$3

example

!Using-in-Asynchronous-Contexts

`javascript
import Exception from '@kabeep/exception';

(
async () => {
throw new Exception('Promise example');
}
)().catch(console.log);
`

$3

example

!Custom-Styles

`javascript
import Exception from '@kabeep/exception';

// Use custom style with hex or rgb
const stylish = '(51,51,51).bg#f56c6c';

console.log(
new Exception('Stylish example', stylish)
);
`

$3

example

!Custom-Exceptions

`javascript
import Exception from '@kabeep/exception';

// > Warning
class Warning extends Exception {
constructor (message: string | Error) {
super(message, '( 51 ,51, 51 ).bg#e6a23c');
}
}

const warn = new Warning('Inherited example');
// Warning: Inherited example [Without style]
console.log(${warn});
console.log(warn);
`

$3

example

!Print-Key-Information

`javascript
import Exception from '@kabeep/exception';

// > Info
const infoStyle = '(51,51,51).bg#409eff';

class Info extends Exception {
constructor (message) {
super(message, infoStyle);
}

toString () {
return this.info(styles);
}
}

const tip = new Info('Inherited example');
// Without stack
console.log(${tip});

// > Success
const successStyle = '(51,51,51).bg#67c23a';

class Success extends Exception {
constructor (message) {
super(message, successStyle);
}

toString () {
return this.info(styles);
}
}

const pass = new Success('Inherited example');
// Without stack
console.log(pass.toString());
`

🎨 Supported styles

- Modifiers

`json
"dim.italic.underline"
`

- Colors

`json
"magenta.cyan"
`

- Background colors

`json
"bgMagenta.bgCyan"
`

- Hex triplet

`json
"#fff.bg#333333"
`

- RGB model

`json
"(51,51,51).bg(24,124,255)"
`

- CSS keywords

`json
"cyan.bgDarkblue"
``

🔗 Related

- chalk - Terminal string styling done right
- chalk-pipe - Create chalk style schemes with simpler style strings

🤝 Contribution

Contributions via Pull Requests or Issues are welcome.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.