@operato/help 10.29.33 → 10.29.36

package/test/ox-doc.test.ts

@@ -2,7 +2,10 @@ import { expect, fixture, html, waitUntil } from '@open-wc/testing'
 
 import '../src/components/ox-doc.js'
 import '../src/components/ox-help-spot.js'
+import '../src/viewparts/ox-help-panel.js'
 import type { OxDoc } from '../src/components/ox-doc.js'
+import { appendViewpart, VIEWPART_POSITION } from '@operato/layout'
+import { store } from '@operato/shell'
 
 /**
  * ox-doc reads /helps/{topic}.html and renders it; the products that used to keep their own copy rely on
@@ -79,54 +82,27 @@ describe('ox-doc', () => {
 })
 
 describe('ox-help-spot', () => {
-  /* Its two links are words of the reader's language, not English left in a Korean screen. */
-  it('names its links in the reader\'s language', async () => {
-    const { i18next } = await import('@operato/i18n')
-    i18next.addResourceBundle(i18next.language || 'en', 'translations', { 'button.close': '닫기', 'text.help-open-full': '전체 보기' }, true, true)
-    const el = await fixture<HTMLElement>(html`<ox-help-spot topic="a/one" section="part"></ox-help-spot>`)
-    await waitUntil(() => el.shadowRoot!.querySelector('button.q'))
-    ;(el.shadowRoot!.querySelector('button.q') as HTMLButtonElement).click()
-    await waitUntil(() => el.shadowRoot!.querySelector('.bar'))
-
-    const bar = el.shadowRoot!.querySelector('.bar')!.textContent!.replace(/\s+/g, ' ')
-    expect(bar).to.contain('전체 보기')
-    expect(bar).to.contain('닫기')
-    expect(bar).not.to.contain('close')
-  })
-
-  it('opens the section in place and closes on Escape', async () => {
-    const el = await fixture<HTMLElement>(html`<ox-help-spot topic="a/one" section="part"></ox-help-spot>`)
-    await waitUntil(() => el.shadowRoot!.querySelector('button.q'))
-    ;(el.shadowRoot!.querySelector('button.q') as HTMLButtonElement).click()
-    await waitUntil(() => el.shadowRoot!.querySelector('ox-doc'))
-
-    /* The dialog says what opened and can take focus (operato-twin's overlay guard asks both). */
-    const panel = el.shadowRoot!.querySelector('.panel')!
-    expect(panel.getAttribute('aria-label')).to.equal('help')
-    expect(panel.getAttribute('tabindex')).to.equal('-1')
-
-    const doc = el.shadowRoot!.querySelector('ox-doc') as OxDoc
-    expect(doc.getAttribute('section')).to.equal('part')
-    expect(doc.hasAttribute('compact')).to.equal(true)
-
-    el.shadowRoot!.querySelector('.panel')!.dispatchEvent(new KeyboardEvent('keydown', { key: 'Escape', bubbles: true, composed: true }))
-    await waitUntil(() => !el.shadowRoot!.querySelector('.panel'))
-  })
-
-  /* A `?` in a grid header sits in nowrap, bold, right-aligned text; its panel is a document and must not take those. */
-  it('opens a panel that wraps and reads from the start, whatever the text around the ?', async () => {
+  /*
+   * The `?` opens the app's help overlay at its section and draws no panel of its own: one drawn inside it sat in
+   * whatever held the `?` (a card button, a grid header), took that parent's pointer and text settings, and handed
+   * its scrolling and presses back to it. The press of the `?` itself is not a press of its parent either.
+   */
+  it('opens the help overlay at its section, and its press does not reach what holds it', async () => {
+    appendViewpart({ name: 'help', viewpart: { show: false, hovering: 'edge', template: html`<ox-help-panel></ox-help-panel>` }, position: VIEWPART_POSITION.ASIDEBAR })
+    let parentPresses = 0
     const host = await fixture<HTMLElement>(
-      html`<div style="white-space: nowrap; text-align: right; font-weight: 700; width: 120px"><ox-help-spot topic="a/one" section="part"></ox-help-spot></div>`
+      html`<button style="cursor: pointer" @click=${() => parentPresses++} @pointerdown=${() => parentPresses++}><ox-help-spot topic="a/one" section="part"></ox-help-spot></button>`
     )
     const el = host.querySelector('ox-help-spot') as HTMLElement
     await waitUntil(() => el.shadowRoot!.querySelector('button.q'))
-    ;(el.shadowRoot!.querySelector('button.q') as HTMLButtonElement).click()
-    await waitUntil(() => el.shadowRoot!.querySelector('.panel'))
-
-    const panel = getComputedStyle(el.shadowRoot!.querySelector('.panel')!)
-    expect(panel.whiteSpace).to.equal('normal')
-    expect(panel.textAlign).to.equal('start')
-    expect(panel.fontWeight).to.equal('400')
+    const q = el.shadowRoot!.querySelector('button.q') as HTMLButtonElement
+    q.dispatchEvent(new PointerEvent('pointerdown', { bubbles: true, composed: true }))
+    q.click()
+
+    expect(parentPresses).to.equal(0)
+    expect(el.shadowRoot!.querySelector('.panel, ox-doc')).to.equal(null)
+    expect(history.state?.overlay?.name).to.equal('help')
+    expect((store.getState() as any).layout.viewparts.help.templateProperties).to.deep.equal({ topic: 'a/one', section: 'part' })
   })
 
   /* A `?` is placed before its help is written; it must not open 「Content not found」 or the whole document. */
@@ -150,3 +126,25 @@ describe('ox-help-spot', () => {
     expect(missing.hasAttribute('hidden')).to.equal(true)
   })
 })
+
+describe('ox-help-panel', () => {
+  /* The overlay shows what a `?` asked about - an html document's section - and the older markdown topics as before. */
+  it('shows an html topic through ox-doc at the section, and a markdown topic as markdown', async () => {
+    const html1 = await fixture<HTMLElement>(html`<ox-help-panel topic="a/one" section="part"></ox-help-panel>`)
+    await waitUntil(() => html1.shadowRoot!.querySelector('ox-doc'))
+    const doc = html1.shadowRoot!.querySelector('ox-doc') as OxDoc
+    expect([doc.getAttribute('topic'), doc.getAttribute('section'), doc.hasAttribute('compact')]).to.deep.equal(['a/one', 'part', true])
+
+    const md = await fixture<HTMLElement>(html`<ox-help-panel topic="b/md"></ox-help-panel>`)
+    await waitUntil(() => md.shadowRoot!.querySelector('ox-markdown'))
+    expect(md.shadowRoot!.querySelector('ox-doc')).to.equal(null)
+  })
+})
+
+describe('ox-doc anchor', () => {
+  /* The help page opens the whole document at the part the overlay showed. */
+  it('scrolls its scrolling parent to the anchor once the document is drawn', async () => {
+    const box = await fixture<HTMLElement>(html`<div style="height: 40px; overflow: auto"><ox-doc topic="a/one" anchor="next"></ox-doc></div>`)
+    await waitUntil(() => box.scrollTop > 0, 'the box scrolls to #next')
+  })
+})

package/coverage/lcov-report/base.css

@@ -1,224 +0,0 @@
-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;
-}

package/coverage/lcov-report/block-navigation.js

@@ -1,87 +0,0 @@
-/* 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) > `
-
-    // Selector 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);