generator-lit-element-next

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
generator-lit-element-next
17192.15.14 years ago5 years agoMinified + gzip package size for generator-lit-element-next in KB

Readme

generator-lit-element-next

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




Buy Me A Coffee !tippin.metippin-me-badgetippin-me-url !Follow mefollow-me-badgefollow-me-url
!Versionversion-badgeversion-url !Node versionnode-version-badgenode-version-url !MIT Licensemit-license-badgemit-license-url !Mentioned in Awesomeawesome-badgeawesome-url
!Downloadsdownloads-badgedownloads-url !Total downloadstotal-downloads-badgedownloads-url !Packagephobiapackagephobia-badgepackagephobia-url
!ciga-badgega-url !Dependency Statusdaviddm-badgedaviddm-url !codecovcodecov-badgecodecov-url !Coverage Statuscoveralls-badgecoveralls-url
!codebeat badgecodebeat-badgecodebeat-url !Codacy Badgecodacy-badgecodacy-url !Code of Conductcoc-badgecoc-url
Write your next custom element with latest lit-elementlit-element-url in TypeScripttypescript-url.

Table of contents

- NPM - NPX - Code of Conduct

Pre-requisites

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

Installation

NPM

First, install generator-lit-element-next using NPMnpm-url (we assume you have pre-installed Node.jsnodejs-url).
# 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

NPXnpx-url comes in a package as of Node.jsnodejs-url v8.9.0. This means that you can run any CLI written in Node.jsnodejs-url 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 Yeomanyeoman-url.

Contributing

Code of Conduct

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

License

MIT License © Rong Sen Ng