lit / lit/lit.dev

mention config requirements in tools → development → typescript

Open
#1,071 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

https://lit.dev/docs/tools/development/#typescript currently doesn't explain that you need to ensure useDefineForClassFields is off and it's pretty tricky to figure out that your problem is in tsconfig.json when this happens because there are no tsc errors and initial renders are fine (components just don't update)

#479 added the important bits but only to the middle of components → reactive properties

also, https://stackblitz.com/edit/lit-element-typescript-demo is broken in exactly this way! it targets esnext, which defaults useDefineForClassFields to true

possibly related: #583

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 with the tools → development → TypeScript section at lit.dev/docs/tools/development/#typescript and compare it with the guidance added in #479 under components → reactive properties. Check the StackBlitz lit-element-typescript-demo, especially its esnext target; done means the documentation explains the required tsconfig.json setting and the demo no longer exhibits components that fail to update.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.