Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@blockquote/create-wc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Web Components with Lit - Scaffold
This scaffold generator extends and customizes @open-wc/create, providing a starting point for creating web components with Lit.
Example:
Development Tools
Scaffold
- Lint:
eslint - Format:
prettier
Vite & Vitest
Server: Vite Server
Preview: Vite Preview
Build: Vite Build
- TypeScript:
vitetranspile only - TypeScript:
tscemit declarations only
- TypeScript:
Test: Vitest browser mode and chai-a11y-axe
Sass
analyze
Installation
npm init @blockquote/wcStart
npm startLinting and Formatting
To scan the project for linting and formatting errors, run:
npm run lintTo automatically fix them, run:
npm run formatTesting
Run tests with:
// vitest --run --browser.headless
npm run test// vitest
npm run test:watchDevelopment Server
Start the development server:
npm run startHosting a Static Demo (Do Not Bundle)
For hosting a static demo without bundling:
npm run dev:vitePreview demo:
npm run preview:viteTypeScript
npm run buildSass
SCSS Watcher
Start the SCSS watcher:
npm run sass:watchCustom Elements Manifest
Generating README from custom-elements.json
Generate documentation:
npm run analyzeHusky
Husky is pre-installed.
After initializing Git with git init, run:
npm run prepareto set up Husky and its Git hooks.
Plugins: