Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashafirsov/light-dom-element-test
test and demo suite for light-dom-element
https://github.com/sashafirsov/light-dom-element-test
Last synced: 16 days ago
JSON representation
test and demo suite for light-dom-element
- Host: GitHub
- URL: https://github.com/sashafirsov/light-dom-element-test
- Owner: sashafirsov
- License: mit
- Created: 2022-04-13T05:46:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-13T03:47:59.000Z (about 2 years ago)
- Last Synced: 2024-04-17T10:18:01.659Z (8 months ago)
- Language: JavaScript
- Size: 720 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# \ & \ test
This project is a test and build suite for
[shadow-dom-element][shadow-url] & [light-dom-element][light-url]
web components which perform same task of html template rendering and expose identical API.
[![git][github-ico] GitHub][github-url]
| Demo: [shadow-dom-element][shadow-demo], [light-dom-element][light-demo]
[![NPM version][npm-image]][npm-url]
[](https://www.webcomponents.org/element/shadow-dom-element)
[![coverage][coverage-image]][coverage-url]
## Installation
```bash
npm i light-dom-element-test
```
## Usage
```bash
npm run build
npm run test
npm run test:watch
```
## Linting and formatting
To scan the project for linting and formatting errors, run
```bash
npm run lint
```
To automatically fix linting and formatting errors, run
```bash
npm run format
```
## Testing with Web Test Runner
To execute a single test run:
```bash
npm run test
```
To run the tests in interactive watch mode run:
```bash
npm run test:watch
```
## Demoing with Storybook
To run a local instance of Storybook for your component, run
```bash
npm run storybook
```
To build a production version of Storybook, run
```bash
npm run storybook:build
```
## Tooling configs
For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
## Local Demo with `web-dev-server`
```bash
npm start
```
To run a local development server that serves the basic demo located in `demo/index.html`
[github-ico]: https://cdnjs.cloudflare.com/ajax/libs/octicons/8.5.0/svg/mark-github.svg
[github-url]: https://github.com/sashafirsov/light-dom-element-test
[shadow-url]: https://github.com/sashafirsov/shadow-dom-element
[light-url]: https://github.com/sashafirsov/light-dom-element
[shadow-demo]: https://unpkg.com/[email protected]/demo/shadow-dom/index.html
[light-demo]: https://unpkg.com/[email protected]/demo/light-dom/index.html
[npm-image]: https://img.shields.io/npm/v/light-dom-element-test.svg
[npm-url]: https://npmjs.org/package/light-dom-element-test
[coverage-image]: https://unpkg.com/[email protected]/coverage/coverage.svg
[coverage-url]: https://unpkg.com/[email protected]/coverage/lcov-report/index.html