Skip to content

motss/generator-lit-element-next

Repository files navigation

generator-lit-element-next

Generator for developing your next custom element with latest LitElement in TypeScript


Buy Me A Coffee tippin.me Follow me

Version Node version MIT License Mentioned in Awesome

Downloads Total downloads Packagephobia

ci Dependency Status codecov Coverage Status

codebeat badge Codacy Badge Code of Conduct

Write your next custom element with latest lit-element in TypeScript.

Table of contents

Pre-requisites

Please make sure that you have the following dependencies installed and setup correctly:-

Installation

NPM

First, install generator-lit-element-next using NPM (we assume you have pre-installed Node.js).

# Install globally with NPM
$ npm install -g yo generator-lit-element-next

Then generate your new project:

# Create a new directory if you haven't already.
# Then change to that new directory.
$ mkdir my-app && cd my-app

# Init
$ yo lit-element-next

NPX

NPX comes in a package as of Node.js v8.9.0. This means that you can run any CLI written in Node.js without globally installing it.

# Create a new directory if you haven't already.
# Then change to that new directory.
$ mkdir my-app && cd my-app

# Install packages with NPX and execute the CLI with this one-liner
$ npx -p yo -p generator-lit-element-next -- yo lit-element-next

Testing

No option on which testing library/ framework to use to test Web Components and you are feel free to bring your own testing library or framework. But, here are a few to recommend if you haven't already had one:

  1. @open-wc/testing
  2. webdriverio
  3. playwright

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Contributing

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

MIT License © Rong Sen Ng