readthedocs / readthedocs/ext-theme

Add optional Lit debug mode configuration option

Open
#685 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Improvement
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

Mostly just archiving this for later, I found this helpful in pinpointing what exactly was happening with Lit internals while working with FUI code that was conflicting:

window.emitLitDebugLogEvents = true;
window.addEventListener("lit-debug", (event) => {
  console.debug("Lit event:", event.detail);
});

In my case, when one of my LitElement properties was being updated, Lit was throwing an exception because the element changed outside control of Lit. I had to use debug output to figure out which property that was, and after that it was very easy to understand the conflict.

Be warned that this is a firehose of information though. I didn't want to add this under the existing debug flag because of how noisy it is.

Contributor guide

No contributing guide indexed for this repository

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

No file or test is named. Start by locating the existing debug flag and the Lit integration, then review the issue's window.emitLitDebugLogEvents and lit-debug event example. Done means an optional configuration enables Lit debug logging without enabling the noisy output by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.