Console

📕 Console Library


🔷 Introduction

This script is an adaptation of the classic JavaScript console script. It provides a simple way to display data in a console-like table format for debugging purposes.

While there are many nice console/logger scripts out there, my personal goal was to achieve inline functionality and visual object (label, lines) logging.



🔷 How to Use

◼ 1. Import the Console library into your script:

import cryptolinx/Console/1

- or -

Instead of the library namespace, you can define a custom namespace as alias.

import cryptolinx/Console/1 as c

◼ 2. Create and init a new `<terminal>` object.

The `init()` method is used to initialize the console object with default settings. It can be used to customize it.

// When using the `var` keyword in a declaration, the logs will act as ever-forwarding.
// Without `var`, the `console` variable will be redeclared every time `bar` is called.

// var console = Console.terminal.new(log_position=position.bottom_left, prefix = '> ', show_no = true)

- or -

If you has set up an alias before.

var console = c.terminal.new().init()

◼ 3. Logging

// inline ✨
array <float> testArray = array.new<float>(3, .0).log(console)
// basic
console.log(testArray)

// inline ✨
var testLabel = label.new(bar_index, close, 'Label Text').log(console)
// basic
console.log(testLabel)

// It is also possible to use `().` for literals ✨.
int a = 100
testCalc = (5 * 100).log(console) + a.log(console) // SUM: 600

console.
.empty()
.log('SUM' + WS + testCalc.tostring())

◼ 4. Visibility

Finally, we need to call the `show()` method to display the logged messages in the console.

console.show(true) // True by default. Simply turn it on or off

Notas de Lançamento:

🔷 v2

- Included missing data types, enabling logging of any type except tables while including arrays/matrices.
The log() method now offers four different variants, each corresponding to a possible type.

console.log(testArray, [optional level])
console.log('Array Data:', testArray, [optional level], [optional delimiter])
testArray.log(console, [optional level])

- If you only require a string representation, you can utilize the .toString() function, which is available for all types except tables, including arrays/matrices.
Introduced new temporary options: opt_textColor, opt_bgColor, and opt_textSize.

console.log('Array Data:', testArray).opt_textColor(color.blue)
console.log(testFloat).opt_textSize(size.normal)
console.log(testLabel).opt_bgColor(color.blue)

Notas de Lançamento:

🔷 v3

✨ Enhanced Functionality
One of the key additions is the introduction of `_prefix`, `_delimiter`, `_lvl` options to all variants of the `log()` function. Now you have greater flexibility and control over how your logs are displayed.

📚 Updated Documentation
To make your experience even better, I've revamped my documentation. You'll find NEW BADGES that provide useful information and make it easier to navigate through the documentation.

🆕 Additional Methods
I listened to your feedback! In response, I have included the previously missing `.tostring()` method for ``, `array`, `linefill`, `array ` and matrix.
You can now convert them into `` representations effortlessly.

✅ Supported Types

With these updates, I've achieved comprehensive support for all types, excluding ``. You can now log and stringify allmost anything with ease.

Simply use:

console.log(data,[...options])
data.log(console, [...options])
or directly invoke `data.tostring()`.

Here's a quick recap of the supported types:

, , , , , , , , ,
array, array, array, array, array, array, array, array, array,
matrix, matrix, matrix, matrix, matrix, matrix, matrix, matrix, matrix.

⛔ Unsupported Types:

, array, matrix.

Your feedback and suggestions have been invaluable in shaping a big part of my scripts, so please keep them coming.

Thank you for your continued support!

Notas de Lançamento:

🔷 v4

Updated the function arguments to address a known override issue that occurs when logging an integer with a prefix in function calls. In result, I have separated the log level from the main `log()` function. You can now set the log level by using the `opt_lvl(int)` function.

Notas de Lançamento:

🔷 v5

🐛 Bug Fixes

• Column 0 is out of table bounds: A big thank you to @doqkhanh for reporting this issue. I've fixed the bug. Now, both initialization methods with and without var are working perfectly
  

✨ Enhancements

• Script Documentation Update: I've updated the script documentation to enhance your experience. Please note that currently, multiline function arguments break the custom documentation on hovering, so I've reformatted it to single lines.
  

📑I'm dedicated to offering the best possible experience with this library. Your feedback and reports are always welcome. 😊

Notas de Lançamento:

🔷 v6

🐛 Bug Fixes

• FIXED: Inline Color Function
  
• FIXED: Offset Error
  

🆕 New Stuff

• Formatted Tooltip Output for Arrays and Matrices
  
• Support for new built-in type: chart.point
  

Notas de Lançamento:

🔷 v7

🎉 Exciting New Features

🆕 Hybrid Logs: Added Support for the New Native Logging Feature

• Introducing a new way to log data with hybrid logs, enhancing the flexibility and control of your logging experience.
  
• Added a new string field to the terminal object called display, allowing you to specify where the logs should be displayed. Options include 'all', 'chart', 'logs'. Default is set to 'all'.
  
• This feature enables more targeted logging, allowing you to choose the appropriate display method for your specific use case.
  

🆕 New Log Variant: Direct Logging to the App Log Window

• Now you can log directly to the app's native log window, providing a streamlined and efficient logging process.
  
• This direct logging variant automatically converts all supported native types to strings, making it easier to log data without the need for manual conversion.
  
• Ideal for simple logging tasks where direct access to the native log window is preferred.
  

✨ As Short As Simple

// New direct logging to the app log window without a terminal object.
myVar.log()
myArray.log()
label.all.log(2)   // Log Level: 2 warning

📑 Continuous Improvement
As always, I'm committed to providing the best experience with this library. These new features are designed to enhance your logging capabilities and offer more flexibility in how you interact with logs. Your feedback and suggestions are highly valued, and I look forward to hearing how these updates enhance your development process. 😊

Notas de Lançamento:

🔷 v8

🐛 Bug Fix

• FIXED: Wrong data return