docs: add docs about raw method

[edimitchel]

🔗 Linked issue

Closes #268

❓ Type of change

• 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

Add a chapter about the raw function to bypass potential bad interpretation from reporter.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 10 lines in your changes missing coverage. Please review.

Project coverage is 28.11%. Comparing base (24c98ce) to head (5edf0ef).
Report is 8 commits behind head on main.

Files	Patch %	Lines
examples/raw.ts	0.00%	9 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #271       +/-   ##
===========================================
- Coverage   61.08%   28.11%   -32.97%     
===========================================
  Files          13       41       +28     
  Lines        1380     2998     +1618     
  Branches       58       86       +28     
===========================================
  Hits          843      843               
- Misses        537     2127     +1590     
- Partials        0       28       +28     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Barbapapazes]

Do you think you could add an example in ./examples?

[pi0]

Thanks for helping document this feature. BTW keep note that it is an advanced feature I introduced back then as an escape hatch. We probably should consider it.

[edimitchel]

@pi0 to be honest, by writing the docs I wasn't feeling comfortable with the strange behavior of reporters when we are passing an object containing an args key..

[edimitchel]

I'm not fully confident by doing this documentation as raw method looks like a rescue patch to a potential issue of consola.

I'm wondering why consola permits those conflicts by passing args key? Couldn't we just prefix with an underscore to make virtually private?

[pi0]

Thanks!