diff --git a/.gitignore b/.gitignore index 3fd8b75..020ce87 100644 --- a/.gitignore +++ b/.gitignore @@ -9,15 +9,12 @@ /node_modules/ /npm-debug.log -## testing -/coverage/ ## temp folders /.tmp/ # build /_site/ -/dist/ /out-tsc/ storybook-static @@ -42,9 +39,6 @@ pids # Directory for instrumented libs generated by jscoverage/JSCover lib-cov -# Coverage directory used by tools like istanbul -coverage -*.lcov # nyc test coverage .nyc_output @@ -104,7 +98,6 @@ typings/ # Nuxt.js build / generate output .nuxt -dist # Gatsby files .cache/ diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..63298ca --- /dev/null +++ b/BUILD.md @@ -0,0 +1,17 @@ +# slotted-element development +The sources are used directly from [node_modules/slotted-element](node_modules/slotted-element) + +`npm link slotted-element` would make it linked to locally installed repo which has to be registered by +`npm link` + +The TDD via `npm run test:watch` would allow tests and sources modification and debug in browser. + +[dist/](dist) is holding generated binaries and demo referenced via CDN within main [README.md](README.md) + +# npm run build +Would invoke [build.sh](build.sh) which +* execute `test.sh` to generate [coverage/](coverage) folder with results and [coverage.svg](coverage/coverage.svg) +* cleanup [dist/](dist) folder +* execute compilation by [esbuild](https://esbuild.github.io/) + +Upon release in github and npmjs.org the code with working demo would be populated into CDN. diff --git a/README.md b/README.md index 8f5fa67..b45c1ac 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ test suite for `slotted-element` and `fetch-element` [![git][github-image] slotted-element](https://github.com/sashafirsov/slotted-element) -| [demo](https://unpkg.com/slotted-element@1.1.0/demo/index.html) +| [demo](https://unpkg.com/slotted-element-test@1.1.1/dist/bundle/demo/index.html) + +[![NPM version][npm-image]][npm-url] +[![coverage][coverage-image]][coverage-url] # Test @@ -13,3 +16,7 @@ test suite for `slotted-element` and `fetch-element` After test run is located in [coverage/lcov-report/index.html](coverage/lcov-report/index.html) [github-image]: https://cdnjs.cloudflare.com/ajax/libs/octicons/8.5.0/svg/mark-github.svg +[npm-image]: https://img.shields.io/npm/v/slotted-element-test.svg +[npm-url]: https://npmjs.org/package/slotted-element-test +[coverage-image]: https://unpkg.com/slotted-element-test@1.1.1/coverage/coverage.svg +[coverage-url]: https://unpkg.com/slotted-element-test@1.1.1/coverage/lcov-report/index.html diff --git a/ToDo.md b/ToDo.md index cbe0c67..9b01e76 100644 --- a/ToDo.md +++ b/ToDo.md @@ -1,2 +1,8 @@ +* demo in `dist` * update `html-demo-element` version * integrate code coverage as in css-chain +* .d.ts +npx -p typescript tsc **/*.js --declaration --allowJs --emitDeclarationOnly +--outDir types + +* xml diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..d35d247 --- /dev/null +++ b/build.sh @@ -0,0 +1,31 @@ +#node types/generate-mixin.js +bash ./test.sh + +PACKAGE_VERSION=$(node -pe "require('slotted-element/package.json').version") +echo $PACKAGE_VERSION + +BUILD_DIR=dist/esm +SRC_DIR=node_modules/slotted-element +rm -rf dist/* +mkdir dist +#mkdir $BUILD_DIR +#mkdir $BUILD_DIR/demo +#cp $SRC_DIR/demo/* $BUILD_DIR/demo +#cp $SRC_DIR/*.d.ts $BUILD_DIR +#sed "s/..\/src\/css-chain-element.js/css-chain-element.js/" src/demo.html >$BUILD_DIR/demo.html + +TARGET_PARAM=--target=chrome97,firefox95,safari15,edge96 +# https://kangax.github.io/compat-table/es2016plus/ +#esbuild $SRC_DIR/*.js --minify --sourcemap $TARGET_PARAM --outdir=$BUILD_DIR +#esbuild $SRC_DIR/../css-chain/*.js --minify --sourcemap $TARGET_PARAM --outdir=$BUILD_DIR + +# bundle +BUILD_DIR=dist/bundle +mkdir $BUILD_DIR +mkdir $BUILD_DIR/demo +mkdir $BUILD_DIR/render + +cp $SRC_DIR/demo/* $BUILD_DIR/demo +cp $SRC_DIR/*.d.ts $BUILD_DIR +esbuild $SRC_DIR/slotted-element.js --minify --bundle --sourcemap --format=esm $TARGET_PARAM --outdir=$BUILD_DIR +esbuild $SRC_DIR/render/*.js --minify --bundle --sourcemap --format=esm $TARGET_PARAM --outdir=$BUILD_DIR/render diff --git a/ci/compile.mjs b/ci/compile.mjs new file mode 100644 index 0000000..8b27f6b --- /dev/null +++ b/ci/compile.mjs @@ -0,0 +1,15 @@ +import esbuild from 'esbuild'; +import htmlPlugin from '@chialab/esbuild-plugin-html'; + +await esbuild.build({ + entryPoints: ['dist/esm/demo/index.html'], + outdir: 'dist/esm/bundle', + assetNames: 'assets/[name]-[hash]', + chunkNames: '[ext]/[name]-[hash]', + plugins: [ + htmlPlugin({ + // scriptsTarget: 'es6', + // modulesTarget: 'es2020', + }), + ], +}); diff --git a/coverage/coverage.svg b/coverage/coverage.svg new file mode 100644 index 0000000..9d500f8 --- /dev/null +++ b/coverage/coverage.svg @@ -0,0 +1,10 @@ + diff --git a/coverage/lcov-report/base.css b/coverage/lcov-report/base.css new file mode 100644 index 0000000..f418035 --- /dev/null +++ b/coverage/lcov-report/base.css @@ -0,0 +1,224 @@ +body, html { + margin:0; padding: 0; + height: 100%; +} +body { + font-family: Helvetica Neue, Helvetica, Arial; + font-size: 14px; + color:#333; +} +.small { font-size: 12px; } +*, *:after, *:before { + -webkit-box-sizing:border-box; + -moz-box-sizing:border-box; + box-sizing:border-box; + } +h1 { font-size: 20px; margin: 0;} +h2 { font-size: 14px; } +pre { + font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace; + margin: 0; + padding: 0; + -moz-tab-size: 2; + -o-tab-size: 2; + tab-size: 2; +} +a { color:#0074D9; text-decoration:none; } +a:hover { text-decoration:underline; } +.strong { font-weight: bold; } +.space-top1 { padding: 10px 0 0 0; } +.pad2y { padding: 20px 0; } +.pad1y { padding: 10px 0; } +.pad2x { padding: 0 20px; } +.pad2 { padding: 20px; } +.pad1 { padding: 10px; } +.space-left2 { padding-left:55px; } +.space-right2 { padding-right:20px; } +.center { text-align:center; } +.clearfix { display:block; } +.clearfix:after { + content:''; + display:block; + height:0; + clear:both; + visibility:hidden; + } +.fl { float: left; } +@media only screen and (max-width:640px) { + .col3 { width:100%; max-width:100%; } + .hide-mobile { display:none!important; } +} + +.quiet { + color: #7f7f7f; + color: rgba(0,0,0,0.5); +} +.quiet a { opacity: 0.7; } + +.fraction { + font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace; + font-size: 10px; + color: #555; + background: #E8E8E8; + padding: 4px 5px; + border-radius: 3px; + vertical-align: middle; +} + +div.path a:link, div.path a:visited { color: #333; } +table.coverage { + border-collapse: collapse; + margin: 10px 0 0 0; + padding: 0; +} + +table.coverage td { + margin: 0; + padding: 0; + vertical-align: top; +} +table.coverage td.line-count { + text-align: right; + padding: 0 5px 0 20px; +} +table.coverage td.line-coverage { + text-align: right; + padding-right: 10px; + min-width:20px; +} + +table.coverage td span.cline-any { + display: inline-block; + padding: 0 5px; + width: 100%; +} +.missing-if-branch { + display: inline-block; + margin-right: 5px; + border-radius: 3px; + position: relative; + padding: 0 4px; + background: #333; + color: yellow; +} + +.skip-if-branch { + display: none; + margin-right: 10px; + position: relative; + padding: 0 4px; + background: #ccc; + color: white; +} +.missing-if-branch .typ, .skip-if-branch .typ { + color: inherit !important; +} +.coverage-summary { + border-collapse: collapse; + width: 100%; +} +.coverage-summary tr { border-bottom: 1px solid #bbb; } +.keyline-all { border: 1px solid #ddd; } +.coverage-summary td, .coverage-summary th { padding: 10px; } +.coverage-summary tbody { border: 1px solid #bbb; } +.coverage-summary td { border-right: 1px solid #bbb; } +.coverage-summary td:last-child { border-right: none; } +.coverage-summary th { + text-align: left; + font-weight: normal; + white-space: nowrap; +} +.coverage-summary th.file { border-right: none !important; } +.coverage-summary th.pct { } +.coverage-summary th.pic, +.coverage-summary th.abs, +.coverage-summary td.pct, +.coverage-summary td.abs { text-align: right; } +.coverage-summary td.file { white-space: nowrap; } +.coverage-summary td.pic { min-width: 120px !important; } +.coverage-summary tfoot td { } + +.coverage-summary .sorter { + height: 10px; + width: 7px; + display: inline-block; + margin-left: 0.5em; + background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent; +} +.coverage-summary .sorted .sorter { + background-position: 0 -20px; +} +.coverage-summary .sorted-desc .sorter { + background-position: 0 -10px; +} +.status-line { height: 10px; } +/* yellow */ +.cbranch-no { background: yellow !important; color: #111; } +/* dark red */ +.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 } +.low .chart { border:1px solid #C21F39 } +.highlighted, +.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{ + background: #C21F39 !important; +} +/* medium red */ +.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE } +/* light red */ +.low, .cline-no { background:#FCE1E5 } +/* light green */ +.high, .cline-yes { background:rgb(230,245,208) } +/* medium green */ +.cstat-yes { background:rgb(161,215,106) } +/* dark green */ +.status-line.high, .high .cover-fill { background:rgb(77,146,33) } +.high .chart { border:1px solid rgb(77,146,33) } +/* dark yellow (gold) */ +.status-line.medium, .medium .cover-fill { background: #f9cd0b; } +.medium .chart { border:1px solid #f9cd0b; } +/* light yellow */ +.medium { background: #fff4c2; } + +.cstat-skip { background: #ddd; color: #111; } +.fstat-skip { background: #ddd; color: #111 !important; } +.cbranch-skip { background: #ddd !important; color: #111; } + +span.cline-neutral { background: #eaeaea; } + +.coverage-summary td.empty { + opacity: .5; + padding-top: 4px; + padding-bottom: 4px; + line-height: 1; + color: #888; +} + +.cover-fill, .cover-empty { + display:inline-block; + height: 12px; +} +.chart { + line-height: 0; +} +.cover-empty { + background: white; +} +.cover-full { + border-right: none !important; +} +pre.prettyprint { + border: none !important; + padding: 0 !important; + margin: 0 !important; +} +.com { color: #999 !important; } +.ignore-none { color: #999; font-weight: normal; } + +.wrapper { + min-height: 100%; + height: auto !important; + height: 100%; + margin: 0 auto -48px; +} +.footer, .push { + height: 48px; +} diff --git a/coverage/lcov-report/block-navigation.js b/coverage/lcov-report/block-navigation.js new file mode 100644 index 0000000..cc12130 --- /dev/null +++ b/coverage/lcov-report/block-navigation.js @@ -0,0 +1,87 @@ +/* eslint-disable */ +var jumpToCode = (function init() { + // Classes of code we would like to highlight in the file view + var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no']; + + // Elements to highlight in the file listing view + var fileListingElements = ['td.pct.low']; + + // We don't want to select elements that are direct descendants of another match + var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > ` + + // Selecter that finds elements on the page to which we can jump + var selector = + fileListingElements.join(', ') + + ', ' + + notSelector + + missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b` + + // The NodeList of matching elements + var missingCoverageElements = document.querySelectorAll(selector); + + var currentIndex; + + function toggleClass(index) { + missingCoverageElements + .item(currentIndex) + .classList.remove('highlighted'); + missingCoverageElements.item(index).classList.add('highlighted'); + } + + function makeCurrent(index) { + toggleClass(index); + currentIndex = index; + missingCoverageElements.item(index).scrollIntoView({ + behavior: 'smooth', + block: 'center', + inline: 'center' + }); + } + + function goToPrevious() { + var nextIndex = 0; + if (typeof currentIndex !== 'number' || currentIndex === 0) { + nextIndex = missingCoverageElements.length - 1; + } else if (missingCoverageElements.length > 1) { + nextIndex = currentIndex - 1; + } + + makeCurrent(nextIndex); + } + + function goToNext() { + var nextIndex = 0; + + if ( + typeof currentIndex === 'number' && + currentIndex < missingCoverageElements.length - 1 + ) { + nextIndex = currentIndex + 1; + } + + makeCurrent(nextIndex); + } + + return function jump(event) { + if ( + document.getElementById('fileSearch') === document.activeElement && + document.activeElement != null + ) { + // if we're currently focused on the search input, we don't want to navigate + return; + } + + switch (event.which) { + case 78: // n + case 74: // j + goToNext(); + break; + case 66: // b + case 75: // k + case 80: // p + goToPrevious(); + break; + } + }; +})(); +window.addEventListener('keydown', jumpToCode); diff --git a/coverage/lcov-report/favicon.png b/coverage/lcov-report/favicon.png new file mode 100644 index 0000000..6691817 Binary files /dev/null and b/coverage/lcov-report/favicon.png differ diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html new file mode 100644 index 0000000..d63979f --- /dev/null +++ b/coverage/lcov-report/index.html @@ -0,0 +1,131 @@ + + + + +
++ Press n or j to go to the next uncovered block, b, p or k for the previous block. +
+ +File | ++ | Statements | ++ | Branches | ++ | Functions | ++ | Lines | ++ |
---|---|---|---|---|---|---|---|---|---|
slotted-element | +
+
+ |
+ 91.76% | +234/255 | +89.47% | +51/57 | +82.5% | +33/40 | +91.76% | +234/255 | +
slotted-element/render | +
+
+ |
+ 100% | +44/44 | +87.5% | +7/8 | +100% | +2/2 | +100% | +44/44 | +