src="https://raw.githubusercontent.com/ODGodinho/Stanley-TheTemplate/main/public/images/Stanley.jpg"
alt="Stanley Imagem" width="500"
/>



Parse your log in JSON formatter

Using @ODG/Log parser logs message 📦!

!Repository size

Table of Contents

- 🎇 Benefits
- 📗 Libraries
- 📁 Dependencies
- ⏩ Get Started
- 🔘 Use Plugin
- 🎲 Implementation
- 💌 SendLog
- 💻 Prepare to develop
- 📍 Start Project
- 📨 Build and Run
- 🧪 Teste Code

---

🎇 Benefits

- 🚀 Speed start new project or package using typescript
- 🚨 Over 800 rules for pattern, possible errors and errors in Linter
- 🎇 Log Pattern default format

📗 Libraries

- Node.js 16
- Typescript
- Eslint
- ODG-Linter-JS
- EditorConfig
- ReviewDog

📁 Dependencies

- Node.js 16 or later
- Yarn Optional/Recommended
- ODG TsConfig Last Version
- error-stack-parser Last Version

⏩ Get Started

---

$3

install this plugin with

``powershell
yarn add @odg/json-log
`

$3

`typescript
const logger = new Logger(); // Or Other Class Logger
const consoleLogger = new ConsoleLogger(); // Or Other Class Logger
const processor = new JSONLoggerPlugin(
"appName",
);
logger.pushHandler(consoleLogger);
logger.pushProcessor(processor);

// If you need convert Request and response request headers body, params in string before log
logger.pushProcessor(RequestStringPlugin);

plugin.setIdentifier(randomUUID());
`

#### 💌 Send Log

`typescript
try {
throw new Exception("Example");
} catch (error) {
await logger.error(error);
}
`

LOG JSON Return

`jsonc
{
"type": "error",
"index": "appName",
"instance": "ContainerID",
"identifier": "00000000-0000-0000-0000-00000", // use setIdentifier in plugin to change log group
"gitRelease": "v1.0.0",
"gitBranch": "main",
"exception": {
"type": "string", // ExceptionClassName
"message": "string", // Example
"fileException": "string", // index.js
"functionName": null, // OPTIONAL:
"fileLine": "number", // 1
"fileColumn": "number", // 1
"stack": "stack",
},
"exceptionPrevious": null, // OPTIONAL: This is previous second property on new Exceptions("Example", error);
"request": {
"url": "string",
"baseURL": "string",
"method": "Methods | string",
"headers": {
"header-key": "header-value"
},
"params": "ParametersInterface",
"data": "RequestData",
"timeout": "number",
"responseType": "ResponseType",
"maxContentLength": "number",
"validateStatus": "((status: number) => boolean) | null",
"maxBodyLength": "number",
"maxRedirects": "number",
"socketPath": "string | null",
"proxy": "ProxyConfigInterface | false",
"response": { // OPTIONAL: This is response from axios
"data": "any",
"status": "number",
"headers": {
"string": "string"
},
}
},
"createdAt": "Date",
}
`

$3

Copy .env.example to .env and add the values according to your needs.

$3

First install dependencies with the following command

`bash
yarn install


or


npm install
`

📨 Build and Run

To build the project, you can use the following command

> if you change files, you need to run yarn build and yarn start again

`bash
yarn build && yarn start


or


yarn dev
`

🧪 Teste Code

To Test execute this command

`bash
yarn test


or


yarn test:watch
``