import docsifyInit from '../helpers/docsify-init.js'; import { test, expect } from './fixtures/docsify-init-fixture.js'; test.describe('Search Plugin Tests', () => { test('search readme', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World This is the homepage. `, sidebar: ` - [Test Page](test) `, }, routes: { '/test.md': ` # Test Page This is a custom route. `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('hello'); await expect(resultsHeadingElm).toHaveText('Hello World'); await page.click('.clear-button'); await searchFieldElm.fill('test'); await expect(resultsHeadingElm).toHaveText('Test Page'); }); test('search ignore title', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World This is the homepage. `, sidebar: ` - [Home page](/) - [GitHub Pages](github) `, }, routes: { '/github.md': ` # GitHub Pages This is the GitHub Pages. ## GitHub Pages ignore1 There're three places to populate your docs for your Github repository1. ## GitHub Pages ignore2 {docsify-ignore} There're three places to populate your docs for your Github repository2. `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('repository1'); await expect(resultsHeadingElm).toHaveText('GitHub Pages ignore1'); await page.click('.clear-button'); await searchFieldElm.fill('repository2'); await expect(resultsHeadingElm).toHaveText('GitHub Pages ignore2'); }); test('search only one homepage', async ({ page }) => { const docsifyInitConfig = { markdown: { sidebar: ` - [README](README) - [Test Page](test) `, }, routes: { '/README.md': ` # Hello World This is the homepage. `, '/test.md': ` # Test Page This is a custom route. `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); const resultElm = page.locator('.matching-post'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('hello'); await expect(resultElm).toHaveCount(1); await expect(resultsHeadingElm).toHaveText('Hello World'); await page.click('.clear-button'); await searchFieldElm.fill('test'); await expect(resultsHeadingElm).toHaveText('Test Page'); }); test('search ignore diacritical marks', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` # Qué es docsify genera su sitio web de documentación sobre la marcha. A diferencia de GitBook, no genera archivos estáticos html. En cambio, carga y analiza de forma inteligente sus archivos de Markdown y los muestra como sitio web. Todo lo que necesita hacer es crear un index.html para comenzar y desplegarlo en GitHub Pages. `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('documentacion'); await expect(resultsHeadingElm).toHaveText('Que es'); await page.click('.clear-button'); await searchFieldElm.fill('estáticos'); await expect(resultsHeadingElm).toHaveText('Que es'); }); test('search when there is no title', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` This is some description. We assume autoHeader added the # Title. A long paragraph. `, sidebar: ` - [Changelog](changelog) `, }, routes: { '/changelog.md': ` feat: Support search when there is no title ## Changelog Title hello, this is a changelog `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('paragraph'); await expect(resultsHeadingElm).toHaveText('Home Page'); await page.click('.clear-button'); await searchFieldElm.fill('Support'); await expect(resultsHeadingElm).toHaveText('changelog'); await page.click('.clear-button'); await searchFieldElm.fill('hello'); await expect(resultsHeadingElm).toHaveText('Changelog Title'); }); test('search when there is no body', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` # EmptyContent --- --- `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('empty'); await expect(resultsHeadingElm).toHaveText('EmptyContent'); }); test('handles default focusSearch binding', async ({ page }) => { const docsifyInitConfig = { scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type="search"]'); await docsifyInit(docsifyInitConfig); await expect(searchFieldElm).not.toBeFocused(); await page.keyboard.press('/'); await expect(searchFieldElm).toBeFocused(); }); test('handles custom focusSearch binding', async ({ page }) => { const docsifyInitConfig = { config: { search: { keyBindings: ['z'], }, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type="search"]'); await docsifyInit(docsifyInitConfig); await expect(searchFieldElm).not.toBeFocused(); await page.keyboard.press('/'); await expect(searchFieldElm).not.toBeFocused(); await page.keyboard.press('z'); await expect(searchFieldElm).toBeFocused(); }); test('search result should remove markdown code block', async ({ page }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World searchHere \`\`\`js console.log('Hello World'); \`\`\` `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .content'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('searchHere'); // there is a newline after searchHere and the markdown part ```js ``` it should be removed expect(await resultsHeadingElm.textContent()).toContain( "...searchHere\nconsole.log('Hello World');...", ); }); test('search result should remove file markdown and keep href attribution for files', async ({ page, }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World ![filename](_media/example.js ':include :type=code :fragment=demo') `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .content'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('filename'); expect(await resultsHeadingElm.textContent()).toContain( '...filename _media/example.js :include :type=code :fragment=demo...', ); }); test('search result should remove checkbox markdown and keep related values', async ({ page, }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World - [ ] Task 1 - [x] SearchHere - [ ] Task 3 `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .content'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('SearchHere'); // remove the checkbox markdown and keep the related values expect(await resultsHeadingElm.textContent()).toContain( '...Task 1 SearchHere Task 3...', ); }); test('search result should remove docsify self helper markdown and keep related values', async ({ page, }) => { const docsifyInitConfig = { markdown: { homepage: ` # Hello World !> SearchHere to check it! `, }, scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); const resultsHeadingElm = page.locator('.results-panel .content'); await docsifyInit(docsifyInitConfig); await searchFieldElm.fill('SearchHere'); // remove the helper markdown and keep the related values expect(await resultsHeadingElm.textContent()).toContain( '...SearchHere to check it!...', ); }); });