LitElement TypeScript starter
This project includes a sample component using LitElement with TypeScript.
This template is generated from the
lit-starter-ts package in the main Lit
repo. Issues and PRs for this template should be
filed in that repo.
npm run build
To watch files and rebuild when the files are modified, run the following command in a separate shell:
npm run build:watch
Both the TypeScript compiler and lit-analyzer are configured to be very strict. You may want to change
tsconfig.json to make them less strict.
This sample uses modern-web.dev's @web/test-runner for testing. See the modern-web.dev testing documentation for more information.
Tests can be run with the
test script, which will run your tests against Lit's development mode (with more verbose errors) as well as against Lit's production mode:
For local testing during development, the
test:dev:watch command will run your tests in Lit's development mode (with verbose errors) on every change to your source files:
test:prod:watch commands will run your tests in Lit's production mode.
To run the dev server and open the project in a new browser tab:
npm run serve
There is a development HTML file located at
/dev/index.html that you can view at http://localhost:8000/dev/index.html. Note that this command will serve your code using Lit's development mode (with more verbose errors). To serve your code against Lit's production mode, use
npm run serve:prod.
If you use VS Code, we highly recommend the lit-plugin extension, which enables some extremely useful features for lit-html templates:
- Syntax highlighting
- Code completion
- Hover-over docs
- Jump to definition
- Quick Fixes
The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.
Linting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.
The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing
To lint the project run:
npm run lint
Prettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in
Prettier has not been configured to run when committing files, but this can be added with Husky and and
pretty-quick. See the prettier.io site for instructions.
This project includes a simple website generated with the eleventy static site generator and the templates and pages in
/docs-src. The site is generated to
/docs and intended to be checked in so that GitHub pages can serve the site from
/docs on the master branch.
To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".
To build the site, run:
npm run docs
To serve the site locally, run:
npm run docs:serve
To watch the site files, and re-build automatically, run:
npm run docs:watch
The site will usually be served at http://localhost:8000.
Bundling and minification
For information on building application projects that include LitElement components, see Build for production on the Lit site.
See Get started on the Lit site for more information.