playcanvas / playcanvas/engine

Format our logs so they are more readable in the console logs

Open
#3,487 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
16.8k
Forks
2k
Avg merge
4h 32m
Merged PRs (30d)
222

Description

I sometimes have trouble seeing messages like this in the console due to the general noisiness.

https://forum.playcanvas.com/t/cannot-read-properties-of-undefined-reading-hasownproperty/21940/3

Having something like these tags could help with this and also help users see them easier without coming to the forums

image

We can do this via CSS styling https://dev.to/annlin/consolelog-with-css-style-1mmp but would likely need to use an existing package or create our own logging system.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the engine's current console logging entry points and the linked forum example. Compare the proposed CSS console styling with the existing output and determine whether an existing package or a new logging system is appropriate; done means console messages are consistently tagged and easier to read.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript
Domain
developer-experience, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.