logik-se-web-components
v0.1.12
Published
A simple web component
Downloads
99
Readme
Logik-Web-Component-library
Setup
Install dependencies:
yarn
Build
To build the JavaScript version of your component:
yarn build
To watch files and rebuild when the files are modified, run the following command in a separate shell:
yarn build:watch
Testing
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:
yarn test
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:
yarn test:watch
Alternatively the test:prod
and test:prod:watch
commands will run your tests in Lit's production mode.
Dev Server
yarn 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 yarn serve:prod
.
Editing
If you use VS Code, you should install the lit-plugin extension, which enables some extremely useful features for lit-html templates:
- Syntax highlighting
- Type-checking
- Code completion
- Hover-over docs
- Jump to definition
- Linting
- Quick Fixes
The project is setup to recommend lit-plugin to VS Code users if they don't already have it installed.
Linting
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 .eslintrc.json
and tsconfig.json
.
To lint the project run:
yarn lint
Formatting
Prettier is used for code formatting.
Static Site
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:
yarn docs
To serve the site locally, run:
yarn docs:serve
To watch the site files, and re-build automatically, run:
yarn docs:watch
The site will usually be served at http://localhost:8000.