1.0.0 • Published 1 year ago

@pv-frontend/pv-web-components v1.0.0

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

Bit workspace for Lit components

This workspace contains a set of independently versioned and published Lit components.

Setup workspace

  1. Install Bit on your system).
  2. Clone this repository.
  3. Run bit install.

Start the component dev server:

bit start

Add dependencies:

bit install my-dependency

Create a new component

bit create lit my-component

Component features

The following files can be added to each component to take advantage of further features Bit provides.

  • my-component.docs.md/x - Add documentation for your component.
  • my-component.specs.js - Add test to your component.
  • my-component.composition.js - Mount your component in a demo application, or multiple applications/contexts, to see it rendered.

Version and publish

To publish components run:

bit tag -a -m 'tag message here' && bit export

:::note It is recommended to publish components as part of your CI process. Learn more here. :::

Maintainer docs

There are two files to be aware of when working with Bit:

  • workspace.jsonc This is the main configuration file of your bit workspace. Here you can configure dependency rules for components, manage their scopes and configure custom aspects to be used in the workspace You can also control aesthetic aspects of the workspace such as name and icon as well as default directory and scope. It is where dependencies are found when you install anything.
  • .bitmap This is an auto-generated file and includes the directory mapping of your components.