mirror of
https://github.com/jlengrand/open-wc.git
synced 2026-03-10 08:31:19 +00:00
4c6333b828
- @open-wc/building-rollup@0.9.10 - @open-wc/building-utils@2.5.4 - @open-wc/building-webpack@2.4.4 - @open-wc/create@0.18.5 - es-dev-server@1.10.3 - @import-maps/generate@0.1.6 - @import-maps/resolve@0.1.3 - @open-wc/karma-esm@2.2.9 - rollup-plugin-index-html@1.4.10 - @open-wc/semantic-dom-diff@0.13.21 - @open-wc/testing-helpers@1.1.7 - @open-wc/testing-karma-bs@1.1.36 - @open-wc/testing-karma@3.1.11 - @open-wc/testing@2.2.7 - @open-wc/webpack-import-meta-loader@0.3.1 - @open-wc/webpack-index-html-plugin@1.2.13
Open Web Component Recommendations
Open Web Components provides a set of defaults, recommendations and tools to help facilitate your web component project. Our recommendations include: developing, linting, testing, building, tooling, demoing, publishing and automating.
Usage
# in a new or existing folder:
npm init @open-wc
# requires node 10 & npm 6 or higher
This will kickstart a menu guiding you through all available actions.
$ npm init @open-wc
npx: installed 14 in 4.074s
What would you like to do today?
> Scaffold a new project
Upgrade an existing project
Nah, I am fine thanks! => exit
Homepage
For more details please visit us at open-wc.org.
Packages
| Package | Version | Description |
|---|---|---|
| building-rollup |  |
Default configuration for working with rollup. |
| building-webpack |  |
Default configuration for working with webpack. |
| chai-dom-equals |  |
Chai Plugin to compare dom and shadow dom trees. Part of open-wc recommendations. |
| create |  |
Scaffold web components following open-wc recommendations. |
| demoing-storybook |  |
Storybook configuration following open-wc recommendations. |
| eslint-config |  |
Eslint configuration following open-wc recommendations. |
| es-dev-server |  |
Development server for modern web apps. |
| polyfills-loader |  |
Load web component polyfills using dynamic imports. |
| prettier-config |  |
Prettier configuration following open-wc recommendations. |
| semantic-dom-diff |  |
To compare dom and shadow dom trees. Part of open-wc recommendations. |
| testing |  |
Testing following open-wc recommendations. |
| testing-helpers |  |
Testing Helpers following open-wc recommendations. |
| testing-karma |  |
Testing with Karma following open-wc recommendations. |
| testing-karma-bs |  |
Testing with Karma using Browserstack following open-wc recommendations. |
| testing-wallaby |  |
Testing with wallaby following open-wc recommendations. |
| webpack-import-meta-loader |  |
Webpack loader plugin to support import.meta. |
Contact
Feel free to reach out to us on twitter or create a github issue for any feedback or questions you might have.
You can also find us on the Polymer slack in the #open-wc channel.
You can join the Polymer slack by visiting this link.
We Proudly Use
Guide
# bootstrap/setup
yarn install
# linting
npm run lint
# local testing
npm run test
# testing via browserstack
npm run test:es5:bs
# run commands only for a specific scope
lerna run <command> --scope @open-wc/<package-name> --stream