/* global fail */
import docsifyInit from '../helpers/docsify-init.js';
import { test, expect } from './fixtures/docsify-init-fixture.js';
test.describe('Configuration options', () => {
test.describe('catchPluginErrors', () => {
test('true (handles uncaught errors)', async ({ page }) => {
let consoleMsg, errorMsg;
page.on('console', msg => (consoleMsg = msg.text()));
page.on('pageerror', err => (errorMsg = err.message));
await docsifyInit({
config: {
catchPluginErrors: true,
plugins: [
function (hook, vm) {
hook.init(function () {
fail();
});
hook.beforeEach(markdown => {
return `${markdown}\n\nbeforeEach`;
});
},
],
},
markdown: {
homepage: '# Hello World',
},
// _logHTML: true,
});
const mainElm = page.locator('#main');
expect(errorMsg).toBeUndefined();
expect(consoleMsg).toContain('Docsify plugin error');
await expect(mainElm).toContainText('Hello World');
await expect(mainElm).toContainText('beforeEach');
});
test('false (throws uncaught errors)', async ({ page }) => {
let consoleMsg, errorMsg;
page.on('console', msg => (consoleMsg = msg.text()));
page.on('pageerror', err => (errorMsg = err.message));
await docsifyInit({
config: {
catchPluginErrors: false,
plugins: [
function (hook, vm) {
hook.ready(function () {
fail();
});
},
],
},
markdown: {
homepage: '# Hello World',
},
// _logHTML: true,
});
expect(consoleMsg).toBeUndefined();
expect(errorMsg).toContain('fail');
});
});
test.describe('notFoundPage', () => {
test.describe('renders default error content', () => {
test.beforeEach(async ({ page }) => {
await page.route('README.md', async route => {
await route.fulfill({
status: 500,
});
});
});
test('false', async ({ page }) => {
await docsifyInit({
config: {
notFoundPage: false,
},
});
await expect(page.locator('#main')).toContainText('500');
});
test('true with non-404 error', async ({ page }) => {
await docsifyInit({
config: {
notFoundPage: true,
},
routes: {
'_404.md': '',
},
});
await expect(page.locator('#main')).toContainText('500');
});
test('string with non-404 error', async ({ page }) => {
await docsifyInit({
config: {
notFoundPage: '404.md',
},
routes: {
'404.md': '',
},
});
await expect(page.locator('#main')).toContainText('500');
});
});
test('true: renders _404.md page', async ({ page }) => {
const expectText = 'Pass';
await docsifyInit({
config: {
notFoundPage: true,
},
routes: {
'_404.md': expectText,
},
});
await page.evaluate(() => (window.location.hash = '#/fail'));
await expect(page.locator('#main')).toContainText(expectText);
});
test('string: renders specified 404 page', async ({ page }) => {
const expectText = 'Pass';
await docsifyInit({
config: {
notFoundPage: '404.md',
},
routes: {
'404.md': expectText,
},
});
await page.evaluate(() => (window.location.hash = '#/fail'));
await expect(page.locator('#main')).toContainText(expectText);
});
});
});
test.describe('keyBindings', () => {
test('handles toggleSidebar binding (default)', async ({ page }) => {
const docsifyInitConfig = {
markdown: {
homepage: `
# Heading 1
`,
},
};
await docsifyInit(docsifyInitConfig);
const sidebarElm = page.locator('.sidebar');
await expect(sidebarElm).toHaveClass(/show/);
await page.keyboard.press('\\');
await expect(sidebarElm).not.toHaveClass(/show/);
});
test('handles custom binding', async ({ page }) => {
const docsifyInitConfig = {
config: {
keyBindings: {
customBinding: {
bindings: 'z',
callback(e) {
const elm = document.querySelector('main input[type="text"]');
elm.value = 'foo';
},
},
},
},
markdown: {
homepage: `
`,
},
};
const inputElm = page.locator('main input[type="text"]');
await docsifyInit(docsifyInitConfig);
await expect(inputElm).toHaveValue('');
await page.keyboard.press('z');
await expect(inputElm).toHaveValue('foo');
});
test('ignores event when focused on text input elements', async ({
page,
}) => {
const docsifyInitConfig = {
config: {
keyBindings: {
customBinding: {
bindings: 'z',
callback(e) {
document.body.setAttribute('data-foo', '');
},
},
},
},
markdown: {
homepage: `
`,
},
};
const bodyElm = page.locator('body');
const inputElm = page.locator('input[type="text"]');
const selectElm = page.locator('select');
const textareaElm = page.locator('textarea');
await docsifyInit(docsifyInitConfig);
await inputElm.focus();
await expect(inputElm).toHaveValue('');
await page.keyboard.press('z');
await expect(inputElm).toHaveValue('z');
await inputElm.blur();
await textareaElm.focus();
await expect(textareaElm).toHaveValue('');
await page.keyboard.press('z');
await expect(textareaElm).toHaveValue('z');
await textareaElm.blur();
await selectElm.focus();
await page.keyboard.press('z');
await expect(selectElm).toHaveValue('z');
await selectElm.blur();
await expect(bodyElm).not.toHaveAttribute('data-foo');
await page.keyboard.press('z');
await expect(bodyElm).toHaveAttribute('data-foo');
});
});