feat: Rework

SecJS · Sep 17, 2021 · 2f6eecb · 2f6eecb
1 parent 80b69bc
commit 2f6eecb
Show file tree

Hide file tree

Showing 39 changed files with 330 additions and 7,166 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,22 +1,13 @@
-# http://editorconfig.org
+# editorconfig.org
+root = true
 
 [*]
-indent_style = space
 indent_size = 2
+indent_style = space
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.json]
-insert_final_newline = ignore
-
-[**.min.js]
-indent_style = ignore
-insert_final_newline = ignore
-
-[MakeFile]
-indent_style = tab
-
 [*.md]
 trim_trailing_whitespace = false
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.json b/.eslintrc.json
diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/.github/exceptions.jpg b/.github/exceptions.jpg
diff --git a/.github/exceptions.png b/.github/exceptions.png
diff --git a/.github/workflows/publish.yml → .github/workflows/cd.yml b/.github/workflows/publish.yml → .github/workflows/cd.yml
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
diff --git a/.npmignore b/.npmignore
diff --git a/.nycrc b/.nycrc
diff --git a/.prettierrc b/.prettierrc
diff --git a/.yarnrc b/.yarnrc
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Exceptions 📦
+# Exceptions 🛑
 
-> Very simple Exceptions for NodeJS Application
+> Very simple Exceptions for NodeJS Applications and other SecJS packages
 
 <p>
   <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/secjs/exceptions?style=for-the-badge&logo=appveyor">
@@ -10,38 +10,51 @@
   <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?style=for-the-badge&logo=appveyor">
 </p>
 
-The intention behind this repository is to always maintain a viable and simple Exceptions handler to use in any type of `NodeJS Framework`
+The intention behind this repository is to always maintain a viable and simple exception creator to use in any type of `NodeJS Framework` and
+inside all `SecJS` packages.
 
-<img src=".github/exceptions.jpg" width="200px" align="right" hspace="30px" vspace="100px">
+<img src=".github/exceptions.png" width="200px" align="right" hspace="30px" vspace="100px">
 
 ## Installation
 
-To use Exceptions in your project, first you need to install `@SecJS/Responses`
-
 ```bash
-yarn add @SecJS/Responses
+npm install @secjs/exceptions
 ```
 
-Then you can install the Exceptions using;
+## Usage
 
-```bash
-yarn add @SecJS/Exceptions
+### BaseException 
+
+> Create your own custom exception extending BaseException methods
+
+```js
+class MyCustomException extends BaseException {
+  constructor(content: string | object = 'My default error', status = 400) {
+    super(MyCustomException.name, content, status);
+  }
+}
+
+throw new MyCustomException({ error: 'object', use: 'as you want!' })
 ```
 
-## Usage
+### SecJS Exceptions
 
-> You can call the any of Exceptions classes to create a new error
+> Or if you prefer, you can use the already built in exception from this package
 
 ```js
-import {
-  InternalErrorException,
-  InvalidArgsExceptions,
+import { 
+  BadRequestException, 
+  ForbiddenException, 
+  InternalServerException, 
+  InvalidMethodException, 
   NotFoundException,
-  UnauthorizedException
-} from '@SecJS/Exceptions'
+  NotImplementedException,
+  UnauthorizedException,
+  UnprocessableEntityException,
+  UnsupportedMediaException,
+} from '@secjs/exceptions'
+```
 
-if (1+1 = 3) {
-  throw new InternalErrorException('1+1 is not 3!!', 'INTERNAL_ERROR')
-}
+---
 
-```
+Made with 🖤 by [jlenon7](https://github.com/jlenon7) :wave:
diff --git a/config.json b/config.json