https://github.com/kcmr/create-lit-component

A minimal generator for LitElement Web Components –– npm init kcmr/lit-component
https://github.com/kcmr/create-lit-component

cli generator lit-component litelement oclif parceljs scaffold web-components

Last synced: 19 days ago
JSON representation

A minimal generator for LitElement Web Components –– npm init kcmr/lit-component

• Host: GitHub
• URL: https://github.com/kcmr/create-lit-component
• Owner: kcmr
• Created: 2019-12-02T00:05:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-04T22:48:27.000Z (almost 2 years ago)
• Last Synced: 2024-10-15T09:19:02.753Z (about 1 month ago)
• Topics: cli, generator, lit-component, litelement, oclif, parceljs, scaffold, web-components
• Language: JavaScript
• Homepage:
• Size: 1.07 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LitElement Web Component generator

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Parcel](https://img.shields.io/badge/bundler-Parcel-brightgreen.svg)](https://parceljs.org/)

A minimal scaffold generator for Web Components with LitElement.

```sh

$ npm init kcmr/lit-component

```

![CLI Screenshot](cli-screenshot.png)

Features:

- Uses [**Parcel** bundler](https://parceljs.org/) for the component's demo (dev server). **Super fast** build and reload!

- [@open-wc/testing](https://open-wc.org/testing/) for unit tests (TDD style)

- Allows to import the component class without element registration. Define the tag as you like

## Usage

Install it globally and run it:

```sh

$ npm i -g kcmr/lit-component

$ lit-component

```

Or run it directly without installation (get always the latest version from github):

```sh

$ npm init kcmr/lit-component

```

## Options

Component:

- `-n`, `--name` Component name

- `-d`, `--description` Component description (used in description field inside package.json)

- `-s`, `--scope` Optional package scope (`@my-company`)

- `-i`, `--[no-]install` Install dependencies (`true`). Use `--no-install` to skip dependency installation

- `--silent` Use silent dependency installation

CLI:

- `-h`, `--help` Shows the CLI help

- `-v`, `--version` Shows the CLI version

## Config files or key in `package.json`

The CLI will remember the choices of the last execution with your preferences about the package scope but you can also use configuration files or a specific property in a `package.json` file.

- `lit-component` property in a `package.json`

- `.lit-componentrc` (JSON or YAML format)

- `.lit-componentrc.json`

- `.lit-componentrc.yaml`, `.lit-componentrc.yml`

- `.lit-componentrc.js`

- `lit-component.config.js`

Example config:

```json

{

  "scope": "@my-company",

  "description": "An awesome component",

  "install": false

}

```