<yooda-comp>

This webcomponent follows the open-wc recommendation.

Installation

npm i yooda-comp

Usage

<script type="module">
  import 'yooda-comp/dist/index.js';
</script>

<yooda-comp></yooda-comp>

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

yarn lint

You can lint with ESLint and Prettier individually as well

yarn lint:eslint

yarn lint:prettier

To automatically fix many linting errors, run

uarm format

You can format using ESLint and Prettier individually as well

yarn format:eslint

yarn format:prettier

Testing with Web Test Runner

To run the suite of Web Test Runner tests, run

yarn test

To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run

yarn test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

yarn storybook

To build a production version of Storybook, run

yarn 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

yarn start

To run a local development server that serves the basic demo located in demo/index.html