+ 
Example HTML Page
+
-
### Backers
Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#backer)]
-
### Sponsors
Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
diff --git a/HISTORY.md b/HISTORY.md
index fb720fddd..b5abee65d 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -1,3 +1,4 @@
+
## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
diff --git a/README.md b/README.md
index 1f488dc11..31d759d34 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,6 @@
- 
@@ -23,18 +22,11 @@
-## Links
-
-- [`develop` branch preview](https://docsify-preview.vercel.app/)
-- [Documentation](https://docsify.js.org)
-- [CLI](https://github.com/docsifyjs/docsify-cli)
-- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
-- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
-- [Community chat](https://discord.gg/3NwKFyR)
+Docsify turns one or more Markdown files into a Website, with no build process required.
## Features
@@ -43,85 +35,49 @@
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
-- Compatible with IE11
-- Experimental SSR support ([example](https://github.com/docsifyjs/docsify-ssr-demo))
-- Support embedded files
+- Emoji support
-## Quick start
+## Quick Start
-Look at [this tutorial](https://docsify.js.org/#/quickstart)
+Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.
[](https://codesandbox.io/s/307qqv236)
## Showcase
-These projects are using docsify to generate their sites. Pull requests welcome :blush:
-
-Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
+A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).
-## Similar projects
+## Links
-| Project | Description |
-| ------------------------------------------------ | ---------------------------------------- |
-| [docute](https://github.com/egoist/docute) | ๐ Effortlessly documentation done right |
-| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
+- [Documentation](https://docsify.js.org)
+- [Docsify CLI (Command Line Interface)](https://github.com/docsifyjs/docsify-cli)
+- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
+- [`develop` branch preview](https://docsify-preview.vercel.app/)
+- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
+- [Community chat](https://discord.gg/3NwKFyR)
## Contributing
-### Online one-click setup for Contributing
-
-You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
-
-- clone the docsify repo.
-- install the dependencies.
-- start `npm run dev`.
-
-So that you can start straight away.
-
-[](https://gitpod.io/#https://github.com/docsifyjs/docsify)
-
-- Fork it!
-- Create your feature branch: `git checkout -b my-new-feature`
-- Commit your changes: `git add . && git commit -m 'Add some feature'`
-- Push to the branch: `git push origin my-new-feature`
-- Submit a pull request
-
-## Development
-
-```bash
-npm run bootstrap && npm run dev
-```
+See [CONTRIBUTING.md](CONTRIBUTING.md).
## Backers
-Thank you to all our backers! ๐ [[Become a backer](https://opencollective.com/docsify#backers)]
+Thank you to all our backers! ๐ [[Become a backer](https://opencollective.com/docsify/contribute)]
## Sponsors
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)]
+Thank you for supporting this project! โค๏ธ [[Become a sponsor](https://opencollective.com/docsify/contribute)]
-
-
-
-
-
-
-
-
-
-
+
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+
## License
[MIT](LICENSE)
-
-## Special Thanks
-
-A preview of Docsify's PR and develop branch is Powered by 
diff --git a/SECURITY.md b/SECURITY.md
index 1b9f6f908..f57d273a0 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -6,7 +6,7 @@ If you believe you have found a security vulnerability in docsify, please report
**Please do not report security vulnerabilities through our public GitHub issues.**
-Send email via :email: maintainers@docsifyjs.org to us.
+Send email to us via :email: maintainers@docsifyjs.org.
Please include as much of the following information as possible to help us better understand the possible issue:
diff --git a/babel.config.js b/babel.config.js
deleted file mode 100644
index f037a1a2a..000000000
--- a/babel.config.js
+++ /dev/null
@@ -1,12 +0,0 @@
-module.exports = {
- presets: [
- [
- '@babel/preset-env',
- {
- targets: {
- node: 'current',
- },
- },
- ],
- ],
-};
diff --git a/babel.config.json b/babel.config.json
new file mode 100644
index 000000000..889d31997
--- /dev/null
+++ b/babel.config.json
@@ -0,0 +1,10 @@
+{
+ "presets": [
+ [
+ "@babel/preset-env",
+ {
+ "targets": "defaults"
+ }
+ ]
+ ]
+}
diff --git a/build/build.js b/build/build.js
deleted file mode 100644
index 0de786828..000000000
--- a/build/build.js
+++ /dev/null
@@ -1,156 +0,0 @@
-const rollup = require('rollup')
-const buble = require('rollup-plugin-buble')
-const commonjs = require('rollup-plugin-commonjs')
-const nodeResolve = require('rollup-plugin-node-resolve')
-const { uglify } = require('rollup-plugin-uglify')
-const replace = require('rollup-plugin-replace')
-const isProd = process.env.NODE_ENV === 'production'
-const version = process.env.VERSION || require('../package.json').version
-const chokidar = require('chokidar')
-const path = require('path')
-
-/**
- * @param {{
- * input: string,
- * output?: string,
- * globalName?: string,
- * plugins?: ArrayExample HTML Page
+
-Platform-native characters when `true`:
+Native characters when `true`:
-### Methods
+## Methods
```js
{
@@ -148,7 +155,7 @@ Good {{ timeOfDay }}!
-### Lifecycle Hooks
+## Lifecycle Hooks
```js
{
@@ -193,7 +200,7 @@ Good {{ timeOfDay }}!
## Global options
-Use `vueGlobalOptions` to specify [Vue options](https://vuejs.org/v2/api/#Options-Data) for use with Vue content not explicitly mounted with [vueMounts](#mounts), [vueComponents](#components), or a [markdown script](#markdown-script). Changes to global `data` will persist and be reflected anywhere global references are used.
+Use `vueGlobalOptions` to specify global Vue options for use with Vue content not explicitly mounted with [vueMounts](#mounts), [vueComponents](#components), or a [markdown script](#markdown-script). Changes to global `data` will persist and be reflected anywhere global references are used.
```js
window.$docsify = {
@@ -209,17 +216,17 @@ window.$docsify = {
```markdown
- - {{ count }} + {{ count }} +
``` @@ -227,9 +234,9 @@ Notice the behavior when multiple global counters are rendered: @@ -237,7 +244,7 @@ Changes made to one counter affect the both counters. This is because both insta ## Mounts -Use `vueMounts` to specify DOM elements to mount as [Vue instances](https://vuejs.org/v2/guide/instance.html) and their associated options. Mount elements are specified using a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) as the key with an object containing Vue options as their value. Docsify will mount the first matching element in the main content area each time a new page is loaded. Mount element `data` is unique for each instance and will not persist as users navigate the site. +Use `vueMounts` to specify DOM elements to mount as Vue instances and their associated options. Mount elements are specified using a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) as the key with an object containing Vue options as their value. Docsify will mount the first matching element in the main content area each time a new page is loaded. Mount element `data` is unique for each instance and will not persist as users navigate the site. ```js window.$docsify = { @@ -255,21 +262,21 @@ window.$docsify = { ```markdown${text}${code}${text}
`; + result = /* html */ `${text}
`; } return result; diff --git a/src/core/render/compiler/taskList.js b/src/core/render/compiler/taskList.js index 17897974b..f4bcdaf8d 100644 --- a/src/core/render/compiler/taskList.js +++ b/src/core/render/compiler/taskList.js @@ -1,7 +1,16 @@ export const taskListCompiler = ({ renderer }) => - (renderer.list = (body, ordered, start) => { + (renderer.list = function (token) { + const ordered = token.ordered; + const start = token.start; + + let body = ''; + for (let j = 0; j < token.items.length; j++) { + const item = token.items[j]; + body += this.listitem?.(item); + } + const isTaskList = /
`;
+ result = /* html */ ``;
}
}
@@ -31,17 +31,17 @@ export function emojify(text, useNativeEmoji) {
// Mark colons in tags
.replace(
/<(code|pre|script|template)[^>]*?>[\s\S]+?<\/(code|pre|script|template)>/g,
- m => m.replace(/:/g, '__colon__')
+ m => m.replace(/:/g, '__colon__'),
)
// Mark colons in comments
.replace(//g, m => m.replace(/:/g, '__colon__'))
// Mark colons in URIs
.replace(/([a-z]{2,}:)?\/\/[^\s'">)]+/gi, m =>
- m.replace(/:/g, '__colon__')
+ m.replace(/:/g, '__colon__'),
)
// Replace emoji shorthand codes
.replace(/:([a-z0-9_\-+]+?):/g, (m, $1) =>
- replaceEmojiShorthand(m, $1, useNativeEmoji)
+ replaceEmojiShorthand(m, $1, useNativeEmoji),
)
// Restore colons in tags and comments
.replace(/__colon__/g, ':')
diff --git a/src/core/render/gen-tree.js b/src/core/render/gen-tree.js
index cfe49282c..94030ae2f 100644
--- a/src/core/render/gen-tree.js
+++ b/src/core/render/gen-tree.js
@@ -10,7 +10,7 @@ export function genTree(toc, maxLevel) {
const last = {};
toc.forEach(headline => {
- const level = headline.level || 1;
+ const level = headline.depth || 1;
const len = level - 1;
if (level > maxLevel) {
@@ -18,7 +18,7 @@ export function genTree(toc, maxLevel) {
}
if (last[len]) {
- last[len].children = (last[len].children || []).concat(headline);
+ last[len].children = [...(last[len].children || []), headline];
} else {
headlines.push(headline);
}
diff --git a/src/core/render/index.js b/src/core/render/index.js
index 9b40939ed..3ee35513b 100644
--- a/src/core/render/index.js
+++ b/src/core/render/index.js
@@ -1,293 +1,344 @@
-/* eslint-disable no-unused-vars */
import tinydate from 'tinydate';
-import * as dom from '../util/dom';
-import cssVars from '../util/polyfill/css-vars';
-import { getAndActive, sticky } from '../event/sidebar';
-import { getPath, isAbsolutePath } from '../router/util';
-import { isMobile, inBrowser } from '../util/env';
-import { isPrimitive, merge } from '../util/core';
-import { scrollActiveSidebar } from '../event/scroll';
-import { Compiler } from './compiler';
-import * as tpl from './tpl';
-import { prerenderEmbed } from './embed';
-
-let vueGlobalData;
-
-function executeScript() {
- const script = dom
- .findAll('.markdown-section>script')
- .filter(s => !/template/.test(s.type))[0];
- if (!script) {
- return false;
- }
-
- const code = script.innerText.trim();
- if (!code) {
- return false;
- }
-
- new Function(code)();
-}
-
-function formatUpdated(html, updated, fn) {
- updated =
- typeof fn === 'function'
- ? fn(updated)
- : typeof fn === 'string'
- ? tinydate(fn)(new Date(updated))
- : updated;
+import * as dom from '../util/dom.js';
+import { getPath, isAbsolutePath } from '../router/util.js';
+import { isMobile } from '../util/env.js';
+import { isPrimitive } from '../util/core.js';
+import { Compiler } from './compiler.js';
+import * as tpl from './tpl.js';
+import { prerenderEmbed } from './embed.js';
- return html.replace(/{docsify-updated}/g, updated);
-}
+/** @typedef {import('../Docsify.js').Constructor} Constructor */
-function renderMain(html) {
- const docsifyConfig = this.config;
- const markdownElm = dom.find('.markdown-section');
- const vueVersion =
- 'Vue' in window &&
- window.Vue.version &&
- Number(window.Vue.version.charAt(0));
+/**
+ * @template {!Constructor} T
+ * @param {T} Base - The class to extend
+ */
+export function Render(Base) {
+ return class Render extends Base {
+ #vueGlobalData;
- const isMountedVue = elm => {
- const isVue2 = Boolean(elm.__vue__ && elm.__vue__._isVue);
- const isVue3 = Boolean(elm._vnode && elm._vnode.__v_skip);
+ #addTextAsTitleAttribute(cssSelector) {
+ dom.findAll(cssSelector).forEach(elm => {
+ if (!elm.title && elm.innerText) {
+ elm.title = elm.innerText;
+ }
+ });
+ }
- return isVue2 || isVue3;
- };
+ #executeScript() {
+ const script = dom
+ .findAll('.markdown-section>script')
+ .filter(s => !/template/.test(s.type))[0];
+ if (!script) {
+ return false;
+ }
- if (!html) {
- html = '${testText}
`; - - // Inject HTML - await page.setContent(testHTML); - - // Get reference to page element - const bodyElm = page.locator('body'); - const pElm = page.locator('body > p'); - - // Add class to element and test - await bodyElm.evaluate(elm => elm.classList.add('foo')); - - // Tests - await expect(bodyElm).toHaveClass('foo'); - await expect(bodyElm).toContainText('Test'); - await expect(pElm).toHaveCount(1); - await expect(pElm).toHaveText(testText); - await expect(pElm).not.toHaveText('NOPE'); - }); - - test('javascript in browser context', async ({ page }) => { - // Get native DOM values - const clientDimensions = await page.evaluate(() => { - return { - width: document.documentElement.clientWidth, - height: document.documentElement.clientHeight, - }; - }); - - expect(clientDimensions).toHaveProperty('width'); - expect(typeof clientDimensions.width).toBe('number'); - expect(clientDimensions).toHaveProperty('height'); - expect(typeof clientDimensions.height).toBe('number'); - - // Get result of script executed in browser context - const scriptResult = await page.evaluate( - numbers => { - const result = numbers.reduce( - (accumulator, currentValue) => accumulator + currentValue - ); - - return Promise.resolve(result); - }, - [1, 2, 3] - ); - - expect(scriptResult).toBe(6); - - // Get result of local function executed in browser context - function add(...addends) { - return addends.reduce( - (accumulator, currentValue) => accumulator + currentValue - ); - } - - const functionResult = await page.evaluate(` - const add = ${add.toString()}; - - const result = add(1, 2, 3); - - Promise.resolve(result); - `); - - expect(functionResult).toBe(6); - }); +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; +test.describe('Creating a Docsify site (e2e tests in Playwright)', () => { test('manual docsify site using playwright methods', async ({ page }) => { // Add docsify target element await page.setContent(''); @@ -84,19 +10,18 @@ test.describe('Example Tests', () => { await page.evaluate(() => { window.$docsify = { el: '#app', - basePath: '/docs/', themeColor: 'red', }; }); - // Inject docsify theme (vue.css) - await page.addStyleTag({ url: '/lib/themes/vue.css' }); + // Inject docsify theme + await page.addStyleTag({ url: '/dist/themes/core.css' }); // Inject docsify.js - await page.addScriptTag({ url: '/lib/docsify.js' }); + await page.addScriptTag({ url: '/dist/docsify.js' }); // Wait for docsify to initialize - await page.waitForSelector('#main'); + await page.locator('#main').waitFor(); // Create handle for JavaScript object in browser const $docsify = await page.evaluate(() => window.$docsify); @@ -110,9 +35,6 @@ test.describe('Example Tests', () => { // Load custom docsify // (See ./helpers/docsifyInit.js for details) await docsifyInit({ - config: { - basePath: '/docs/', - }, // _logHTML: true, }); @@ -120,7 +42,7 @@ test.describe('Example Tests', () => { const mainElm = page.locator('#main'); await expect(mainElm).toHaveCount(1); await expect(mainElm).toContainText( - 'A magical documentation site generator' + 'A magical documentation site generator', ); }); @@ -167,14 +89,14 @@ test.describe('Example Tests', () => { // docsifyInit() route 'data-test-scripturls.js', // Server route - '/lib/plugins/search.min.js', + '/dist/plugins/search.js', ], style: ` body { background: red !important; } `, - styleURLs: ['/lib/themes/vue.css'], + styleURLs: ['/dist/themes/core.css'], }; await docsifyInit({ @@ -206,11 +128,14 @@ test.describe('Example Tests', () => { // Verify docsifyInitConfig.script was added to the DOM expect( - await page.evaluate(scriptText => { - return [...document.querySelectorAll('script')].some( - elm => elm.textContent.replace(/\s+/g, '') === scriptText - ); - }, docsifyInitConfig.script.replace(/\s+/g, '')) + await page.evaluate( + scriptText => { + return [...document.querySelectorAll('script')].some( + elm => elm.textContent.replace(/\s+/g, '') === scriptText, + ); + }, + docsifyInitConfig.script.replace(/\s+/g, ''), + ), ).toBe(true); // Verify docsifyInitConfig.script was executed @@ -219,17 +144,20 @@ test.describe('Example Tests', () => { // Verify docsifyInitConfig.styleURLs were added to the DOM for (const styleURL of docsifyInitConfig.styleURLs) { await expect( - page.locator(`link[rel*="stylesheet"][href$="${styleURL}"]`) + page.locator(`link[rel*="stylesheet"][href$="${styleURL}"]`), ).toHaveCount(1); } // Verify docsifyInitConfig.style was added to the DOM expect( - await page.evaluate(styleText => { - return [...document.querySelectorAll('style')].some( - elm => elm.textContent.replace(/\s+/g, '') === styleText - ); - }, docsifyInitConfig.style.replace(/\s+/g, '')) + await page.evaluate( + styleText => { + return [...document.querySelectorAll('style')].some( + elm => elm.textContent.replace(/\s+/g, '') === styleText, + ); + }, + docsifyInitConfig.style.replace(/\s+/g, ''), + ), ).toBe(true); // Verify docsify navigation and docsifyInitConfig.routes @@ -286,7 +214,7 @@ test.describe('Example Tests', () => { // upon billions upon billions upon billions upon billions. // `, // }, - // styleURLs: [`/lib/themes/vue.css`], + // styleURLs: [`/dist/themes/core.css`], // // _logHTML: true, // }); diff --git a/test/e2e/fixtures/docsify-init-fixture.js b/test/e2e/fixtures/docsify-init-fixture.js index e0d273ed7..1c4260b20 100644 --- a/test/e2e/fixtures/docsify-init-fixture.js +++ b/test/e2e/fixtures/docsify-init-fixture.js @@ -1,6 +1,6 @@ -const base = require('@playwright/test'); +import { test as _test, expect as _expect } from '@playwright/test'; -exports.test = base.test.extend({ +export const test = _test.extend({ page: async ({ page }, use) => { global.page = page; @@ -13,4 +13,5 @@ exports.test = base.test.extend({ await use(page); }, }); -exports.expect = base.expect; + +export const expect = _expect; diff --git a/test/e2e/gtag.test.js b/test/e2e/gtag.test.js new file mode 100644 index 000000000..5c2f747e3 --- /dev/null +++ b/test/e2e/gtag.test.js @@ -0,0 +1,84 @@ +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; + +const gtagList = [ + 'AW-YYYYYY', // Google Ads + 'DC-ZZZZZZ', // Floodlight + 'G-XXXXXX', // Google Analytics 4 (GA4) + 'UA-XXXXXX', // Google Universal Analytics (GA3) +]; + +test.describe('Gtag Plugin Tests', () => { + // page request listened, print collect url + function pageRequestListened(page) { + page.on('request', request => { + if (request.url().indexOf('www.google-analytics.com') !== -1) { + // console.log(request.url()); + } + }); + + page.on('response', response => { + const request = response.request(); + // googleads.g.doubleclick.net + // www.google-analytics.com + // www.googletagmanager.com + const reg = + /googleads\.g\.doubleclick\.net|www\.google-analytics\.com|www\.googletagmanager\.com/g; + if (request.url().match(reg)) { + // console.log(request.url(), response.status()); + } + }); + } + + test('single gtag', async ({ page }) => { + pageRequestListened(page); + + const docsifyInitConfig = { + config: { + gtag: gtagList[0], + }, + scriptURLs: ['/dist/plugins/gtag.js'], + styleURLs: ['/dist/themes/core.css'], + }; + + await docsifyInit({ + ...docsifyInitConfig, + }); + + const $docsify = await page.evaluate(() => window.$docsify); + + // Verify config options + expect(typeof $docsify).toEqual('object'); + + // console.log($docsify.gtag, $docsify.gtag === ''); + + // Tests + expect($docsify.gtag).not.toEqual(''); + }); + + test('multi gtag', async ({ page }) => { + pageRequestListened(page); + + const docsifyInitConfig = { + config: { + gtag: gtagList, + }, + scriptURLs: ['/dist/plugins/gtag.js'], + styleURLs: ['/dist/themes/core.css'], + }; + + await docsifyInit({ + ...docsifyInitConfig, + }); + + const $docsify = await page.evaluate(() => window.$docsify); + + // Verify config options + expect(typeof $docsify).toEqual('object'); + + // console.log($docsify.gtag, $docsify.gtag === ''); + + // Tests + expect($docsify.gtag).not.toEqual(''); + }); +}); diff --git a/test/e2e/index-file.test.js b/test/e2e/index-file.test.js index ec8fe7000..79a4f04cd 100644 --- a/test/e2e/index-file.test.js +++ b/test/e2e/index-file.test.js @@ -1,18 +1,18 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; test.describe('Index file hosting', () => { const sharedOptions = { config: { - basePath: '/docs/index.html#/', + basePath: '/index.html#/', }, - testURL: '/docs/index.html#/', + testURL: '/index.html#/', }; test('should serve from index file', async ({ page }) => { await docsifyInit(sharedOptions); await expect(page.locator('#main')).toContainText( - 'A magical documentation site generator' + 'A magical documentation site generator', ); expect(page.url()).toMatch(/index\.html#\/$/); }); diff --git a/test/e2e/plugins.test.js b/test/e2e/plugins.test.js index 2f3ff4b7e..68534830d 100644 --- a/test/e2e/plugins.test.js +++ b/test/e2e/plugins.test.js @@ -1,5 +1,6 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import docsifyInit from '../helpers/docsify-init.js'; +import { waitForFunction } from '../helpers/wait-for.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; test.describe('Plugins', () => { test('Hook order', async ({ page }) => { @@ -21,43 +22,43 @@ test.describe('Plugins', () => { config: { plugins: [ function (hook, vm) { - hook.init(function () { + hook.init(() => { console.log('init'); }); - hook.mounted(function () { + hook.mounted(() => { console.log('mounted'); }); - hook.beforeEach(function (markdown, next) { - setTimeout(function () { + hook.beforeEach((markdown, next) => { + setTimeout(() => { console.log('beforeEach-async'); next(markdown); }, 100); }); - hook.beforeEach(function (markdown) { + hook.beforeEach(markdown => { console.log('beforeEach'); return markdown; }); - hook.afterEach(function (html, next) { - setTimeout(function () { + hook.afterEach((html, next) => { + setTimeout(() => { console.log('afterEach-async'); next(html); }, 100); }); - hook.afterEach(function (html) { + hook.afterEach(html => { console.log('afterEach'); return html; }); - hook.doneEach(function () { + hook.doneEach(() => { console.log('doneEach'); }); - hook.ready(function () { + hook.ready(() => { console.log('ready'); }); }, @@ -72,84 +73,155 @@ test.describe('Plugins', () => { expect(consoleMsgs).toEqual(expectedMsgs); }); - test('beforeEach() return value', async ({ page }) => { - await docsifyInit({ - config: { - plugins: [ - function (hook, vm) { - hook.beforeEach(function (markdown) { - return 'beforeEach'; - }); - }, - ], - }, - // _logHTML: true, + test.describe('beforeEach()', () => { + test('return value', async ({ page }) => { + await docsifyInit({ + config: { + plugins: [ + function (hook, vm) { + hook.beforeEach(markdown => { + return 'beforeEach'; + }); + }, + ], + }, + // _logHTML: true, + }); + + await expect(page.locator('#main')).toContainText('beforeEach'); }); - await expect(page.locator('#main')).toContainText('beforeEach'); + test('async return value', async ({ page }) => { + await docsifyInit({ + config: { + plugins: [ + function (hook, vm) { + hook.beforeEach((markdown, next) => { + setTimeout(() => { + next('beforeEach'); + }, 100); + }); + }, + ], + }, + markdown: { + homepage: '# Hello World', + }, + // _logHTML: true, + }); + + await expect(page.locator('#main')).toContainText('beforeEach'); + }); }); - test('beforeEach() async return value', async ({ page }) => { - await docsifyInit({ - config: { - plugins: [ - function (hook, vm) { - hook.beforeEach(function (markdown, next) { - setTimeout(function () { - next('beforeEach'); - }, 100); - }); - }, - ], - }, - markdown: { - homepage: '# Hello World', - }, - // _logHTML: true, + test.describe('afterEach()', () => { + test('return value', async ({ page }) => { + await docsifyInit({ + config: { + plugins: [ + function (hook, vm) { + hook.afterEach(html => { + return 'afterEach
'; + }); + }, + ], + }, + markdown: { + homepage: '# Hello World', + }, + // _logHTML: true, + }); + + await expect(page.locator('#main')).toContainText('afterEach'); }); - await expect(page.locator('#main')).toContainText('beforeEach'); + test('async return value', async ({ page }) => { + await docsifyInit({ + config: { + plugins: [ + function (hook, vm) { + hook.afterEach((html, next) => { + setTimeout(() => { + next('afterEach
'); + }, 100); + }); + }, + ], + }, + markdown: { + homepage: '# Hello World', + }, + // _logHTML: true, + }); + + await expect(page.locator('#main')).toContainText('afterEach'); + }); }); - test('afterEach() return value', async ({ page }) => { - await docsifyInit({ - config: { - plugins: [ - function (hook, vm) { - hook.afterEach(function (html) { - return 'afterEach
'; - }); - }, - ], - }, - markdown: { - homepage: '# Hello World', - }, - // _logHTML: true, + test.describe('route data accessible to plugins', () => { + let routeData = null; + + test.beforeEach(async ({ page }) => { + // Store route data set via plugin hook (below) + page.on('console', async msg => { + for (const arg of msg.args()) { + const val = await arg.jsonValue(); + const obj = JSON.parse(val); + obj.response && (routeData = obj); + } + }); }); - await expect(page.locator('#main')).toContainText('afterEach'); - }); + test.afterEach(async ({ page }) => { + routeData = null; + }); - test('afterEach() async return value', async ({ page }) => { - await docsifyInit({ - config: { - plugins: [ - function (hook, vm) { - hook.afterEach(function (html, next) { - setTimeout(function () { - next('afterEach
'); - }, 100); - }); - }, - ], - }, - markdown: { - homepage: '# Hello World', - }, - // _logHTML: true, + test('success (200)', async ({ page }) => { + await docsifyInit({ + config: { + plugins: [ + function (hook, vm) { + hook.doneEach(html => { + console.log(JSON.stringify(vm.route)); + }); + }, + ], + }, + }); + + expect(routeData).toHaveProperty('response'); + expect(routeData.response).toHaveProperty('ok', true); + expect(routeData.response).toHaveProperty('status', 200); + expect(routeData.response).toHaveProperty('statusText', 'OK'); }); - await expect(page.locator('#main')).toContainText('afterEach'); + test('fail (404)', async ({ page }) => { + const link404Elm = page.locator('a[href*="404"]'); + + await docsifyInit({ + markdown: { + sidebar: ` + - [404](404.md) + `, + }, + config: { + plugins: [ + function (hook, vm) { + hook.doneEach(html => { + console.log(JSON.stringify(vm.route)); + }); + }, + ], + }, + }); + + await link404Elm.click(); + await waitForFunction(() => routeData?.response?.status === 404); + + expect(routeData).toHaveProperty('response'); + expect(routeData.response).toHaveProperty('ok', false); + expect(routeData.response).toHaveProperty('status', 404); + expect(routeData.response).toHaveProperty('statusText', 'Not Found'); + }); }); }); diff --git a/test/e2e/search.test.js b/test/e2e/search.test.js index ed79f05f9..a99e0121a 100644 --- a/test/e2e/search.test.js +++ b/test/e2e/search.test.js @@ -1,5 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +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 }) => { @@ -21,11 +21,11 @@ test.describe('Search Plugin Tests', () => { This is a custom route. `, }, - scriptURLs: ['/lib/plugins/search.min.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); @@ -57,18 +57,18 @@ test.describe('Search Plugin Tests', () => { ## GitHub Pages ignore1 - There're three places to populate your docs for your Github repository1. + 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. + There're three places to populate your docs for your GitHub repository2. `, }, - scriptURLs: ['/lib/plugins/search.min.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); @@ -99,11 +99,11 @@ test.describe('Search Plugin Tests', () => { This is a custom route. `, }, - scriptURLs: ['/lib/plugins/search.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + const resultsHeadingElm = page.locator('.results-panel .title'); const resultElm = page.locator('.matching-post'); await docsifyInit(docsifyInitConfig); @@ -125,11 +125,11 @@ test.describe('Search Plugin Tests', () => { 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: ['/lib/plugins/search.min.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); @@ -159,11 +159,11 @@ test.describe('Search Plugin Tests', () => { hello, this is a changelog `, }, - scriptURLs: ['/lib/plugins/search.min.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + const resultsHeadingElm = page.locator('.results-panel .title'); await docsifyInit(docsifyInitConfig); @@ -176,6 +176,7 @@ test.describe('Search Plugin Tests', () => { await searchFieldElm.fill('hello'); await expect(resultsHeadingElm).toHaveText('Changelog Title'); }); + test('search when there is no body', async ({ page }) => { const docsifyInitConfig = { markdown: { @@ -185,15 +186,151 @@ test.describe('Search Plugin Tests', () => { --- `, }, - scriptURLs: ['/lib/plugins/search.min.js'], + scriptURLs: ['/dist/plugins/search.js'], }; const searchFieldElm = page.locator('input[type=search]'); - const resultsHeadingElm = page.locator('.results-panel h2'); + 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 + + `, + }, + 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!...', + ); + }); }); diff --git a/test/e2e/security.test.js b/test/e2e/security.test.js index 7d0c98830..44913b334 100644 --- a/test/e2e/security.test.js +++ b/test/e2e/security.test.js @@ -1,5 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; test.describe('Security - Cross Site Scripting (XSS)', () => { const sharedOptions = { @@ -12,7 +12,7 @@ test.describe('Security - Cross Site Scripting (XSS)', () => { }; const slashStrings = ['//', '///']; - for (let slashString of slashStrings) { + for (const slashString of slashStrings) { const hash = `#${slashString}domain.com/file.md`; test(`should not load remote content from hash (${hash})`, async ({ diff --git a/test/e2e/sidebar.test.js b/test/e2e/sidebar.test.js index e29fba075..ff4526601 100644 --- a/test/e2e/sidebar.test.js +++ b/test/e2e/sidebar.test.js @@ -1,5 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; // Suite // ----------------------------------------------------------------------------- @@ -44,6 +44,10 @@ test.describe('Sidebar Tests', () => { await docsifyInit(docsifyInitConfig); + await page.click('a[href="#/test"]'); + await expect(activeLinkElm).toHaveText('Test'); + expect(page.url()).toMatch(/\/test$/); + await page.click('a[href="#/test%20space"]'); await expect(activeLinkElm).toHaveText('Test Space'); expect(page.url()).toMatch(/\/test%20space$/); @@ -57,15 +61,97 @@ test.describe('Sidebar Tests', () => { expect(page.url()).toMatch(/\/test-foo$/); await page.click('a[href="#/test.foo"]'); - expect(page.url()).toMatch(/\/test.foo$/); await expect(activeLinkElm).toHaveText('Test .'); + expect(page.url()).toMatch(/\/test.foo$/); await page.click('a[href="#/test>foo"]'); await expect(activeLinkElm).toHaveText('Test >'); expect(page.url()).toMatch(/\/test%3Efoo$/); + }); +}); - await page.click('a[href="#/test"]'); - await expect(activeLinkElm).toHaveText('Test'); - expect(page.url()).toMatch(/\/test$/); +test.describe('Configuration: autoHeader', () => { + test('autoHeader=false', async ({ page }) => { + const docsifyInitConfig = { + config: { + loadSidebar: '_sidebar.md', + autoHeader: false, + }, + markdown: { + sidebar: ` + - [QuickStartAutoHeader](quickstart.md) + `, + }, + routes: { + '/quickstart.md': ` + the content of quickstart space + ## In the main content there is no h1 + `, + }, + }; + + await docsifyInit(docsifyInitConfig); + + await page.click('a[href="#/quickstart"]'); + expect(page.url()).toMatch(/\/quickstart$/); + // not heading + await expect(page.locator('#quickstart')).toBeHidden(); + }); + + test('autoHeader=true', async ({ page }) => { + const docsifyInitConfig = { + config: { + loadSidebar: '_sidebar.md', + autoHeader: true, + }, + markdown: { + sidebar: ` + - [QuickStartAutoHeader](quickstart.md ) + `, + }, + routes: { + '/quickstart.md': ` + the content of quickstart space + ## In the main content there is no h1 + `, + }, + }; + + await docsifyInit(docsifyInitConfig); + + await page.click('a[href="#/quickstart"]'); + expect(page.url()).toMatch(/\/quickstart$/); + + // auto generate default heading id + const autoHeader = page.locator('#quickstartautoheader'); + expect(await autoHeader.innerText()).toContain('QuickStartAutoHeader'); + }); + + test('autoHeader=true and custom headingId', async ({ page }) => { + const docsifyInitConfig = { + config: { + loadSidebar: '_sidebar.md', + autoHeader: true, + }, + markdown: { + sidebar: ` + - [QuickStartAutoHeader](quickstart.md ":id=quickstartId") + `, + }, + routes: { + '/quickstart.md': ` + the content of quickstart space + ## In the main content there is no h1 + `, + }, + }; + + await docsifyInit(docsifyInitConfig); + + await page.click('a[href="#/quickstart"]'); + expect(page.url()).toMatch(/\/quickstart$/); + // auto generate custom heading id + const autoHeader = page.locator('#quickstartId'); + expect(await autoHeader.innerText()).toContain('QuickStartAutoHeader'); }); }); diff --git a/test/e2e/virtual-routes.test.js b/test/e2e/virtual-routes.test.js index 21636d159..6c0885fc6 100644 --- a/test/e2e/virtual-routes.test.js +++ b/test/e2e/virtual-routes.test.js @@ -1,5 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; /** * Navigate to a specific route in the site @@ -8,7 +8,7 @@ const { test, expect } = require('./fixtures/docsify-init-fixture'); */ async function navigateToRoute(page, route) { await page.evaluate(r => (window.location.hash = r), route); - await page.waitForLoadState('networkidle'); + await page.waitForLoadState('load'); } test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { @@ -58,7 +58,7 @@ test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { '/my-awesome-async-function-route': async function ( route, matched, - next + next, ) { setTimeout(() => next('# My Awesome Function Route'), 100); }, @@ -99,9 +99,7 @@ test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { page, }) => { const routes = { - '/pets/(.*)': function (route) { - return `# Route: /pets/dog`; - }, + '/pets/(.*)': route => '# Route: /pets/dog', }; await docsifyInit({ @@ -120,7 +118,7 @@ test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { page, }) => { const routes = { - '/pets/(.*)': function (_, matched) { + '/pets/(.*)'(_, matched) { return `# Pets Page (${matched[1]})`; }, }; @@ -221,7 +219,7 @@ test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { await navigateToRoute(page, '/d'); const mainElm = page.locator('#main'); - await expect(mainElm).toContainText('404 - Not found'); + await expect(mainElm).toContainText('404 - Not Found'); }); test('skip routes that returned a falsy value that is not a boolean', async ({ @@ -263,7 +261,7 @@ test.describe('Virtual Routes - Generate Dynamic Content via Config', () => { await navigateToRoute(page, '/multiple/matches'); const mainElm = page.locator('#main'); - await expect(mainElm).toContainText('404 - Not found'); + await expect(mainElm).toContainText('404 - Not Found'); }); test('skip routes that are not a valid string or function', async ({ diff --git a/test/e2e/vue.test.js b/test/e2e/vue.test.js index 299b85a8d..334788101 100644 --- a/test/e2e/vue.test.js +++ b/test/e2e/vue.test.js @@ -1,11 +1,8 @@ -const stripIndent = require('common-tags/lib/stripIndent'); -const docsifyInit = require('../helpers/docsify-init'); -const { test, expect } = require('./fixtures/docsify-init-fixture'); +import { stripIndent } from 'common-tags'; +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; -const vueURLs = [ - '/node_modules/vue2/dist/vue.js', - '/node_modules/vue3/dist/vue.global.js', -]; +const vueURL = '/node_modules/vue/dist/vue.global.js'; test.describe('Vue.js Compatibility', () => { function getSharedConfig() { @@ -24,16 +21,14 @@ test.describe('Vue.js Compatibility', () => { }, }, vueGlobalOptions: { - data: function () { - return { - counter: 0, - msg: 'vueglobaloptions', - }; - }, + data: () => ({ + counter: 0, + msg: 'vueglobaloptions', + }), }, vueMounts: { '#vuemounts': { - data: function () { + data() { return { counter: 0, msg: 'vuemounts', @@ -76,14 +71,8 @@ test.describe('Vue.js Compatibility', () => { }, } const vueMountElm = '#vuescript'; - const vueVersion = Number(window.Vue.version.charAt(0)); - if (vueVersion === 2) { - new Vue(vueConfig).$mount(vueMountElm); - } - else if (vueVersion === 3) { - Vue.createApp(vueConfig).mount(vueMountElm); - } + Vue.createApp(vueConfig).mount(vueMountElm); `, }, @@ -93,126 +82,113 @@ test.describe('Vue.js Compatibility', () => { } // Tests - // --------------------------------------------------------------------------- - for (const vueURL of vueURLs) { - const vueVersion = Number(vueURL.match(/vue(\d+)/)[1]); // 2|3 - - test.describe(`Vue v${vueVersion}`, () => { - for (const executeScript of [true, undefined]) { - test(`renders content when executeScript is ${executeScript}`, async ({ - page, - }) => { - const docsifyInitConfig = getSharedConfig(); - - docsifyInitConfig.config.executeScript = executeScript; - docsifyInitConfig.scriptURLs = vueURL; - - await docsifyInit(docsifyInitConfig); - - // Static - await expect(page.locator('#vuefor')).toHaveText('12345'); - await expect(page.locator('#vuecomponent')).toHaveText('0'); - await expect(page.locator('#vueglobaloptions p')).toHaveText( - 'vueglobaloptions' - ); - await expect(page.locator('#vueglobaloptions > span')).toHaveText( - '0' - ); - await expect(page.locator('#vuemounts p')).toHaveText('vuemounts'); - await expect(page.locator('#vuemounts > span')).toHaveText('0'); - await expect(page.locator('#vuescript p')).toHaveText('vuescript'); - await expect(page.locator('#vuescript > span')).toHaveText('0'); - - // Reactive - await page.click('#vuecomponent'); - await expect(page.locator('#vuecomponent')).toHaveText('1'); - await page.click('#vueglobaloptions button'); - await expect(page.locator('#vueglobaloptions > span')).toHaveText( - '1' - ); - await page.click('#vuemounts button'); - await expect(page.locator('#vuemounts > span')).toHaveText('1'); - await page.click('#vuescript button'); - await expect(page.locator('#vuescript > span')).toHaveText('1'); - }); - } - - test(`ignores content when Vue is not present`, async ({ page }) => { - const docsifyInitConfig = getSharedConfig(); - - await docsifyInit(docsifyInitConfig); - await page.evaluate(() => 'Vue' in window === false); - await expect(page.locator('#vuefor')).toHaveText('{{ i }}'); - await expect(page.locator('#vuecomponent')).toHaveText('---'); - await expect(page.locator('#vueglobaloptions p')).toHaveText('---'); - await expect(page.locator('#vuemounts p')).toHaveText('---'); - await expect(page.locator('#vuescript p')).toHaveText('---'); - }); - - test(`ignores content when vueComponents, vueMounts, and vueGlobalOptions are undefined`, async ({ - page, - }) => { - const docsifyInitConfig = getSharedConfig(); - - docsifyInitConfig.config.vueComponents = undefined; - docsifyInitConfig.config.vueGlobalOptions = undefined; - docsifyInitConfig.config.vueMounts = undefined; - docsifyInitConfig.scriptURLs = vueURL; - - await docsifyInit(docsifyInitConfig); - await expect(page.locator('#vuefor')).toHaveText('{{ i }}'); - await expect(page.locator('#vuecomponent')).toHaveText('---'); - await expect(page.locator('#vueglobaloptions p')).toHaveText('---'); - await expect(page.locator('#vuemounts p')).toHaveText('---'); - await expect(page.locator('#vuescript p')).toHaveText('vuescript'); - }); - - test(`ignores content when vueGlobalOptions is undefined`, async ({ - page, - }) => { - const docsifyInitConfig = getSharedConfig(); - - docsifyInitConfig.config.vueGlobalOptions = undefined; - docsifyInitConfig.scriptURLs = vueURL; - - await docsifyInit(docsifyInitConfig); - await expect(page.locator('#vuefor')).toHaveText('12345'); - await expect(page.locator('#vuecomponent')).toHaveText('0'); - await expect(page.locator('#vuecomponent')).toHaveText('0'); - expect(await page.locator('#vueglobaloptions p').innerText()).toBe(''); - await expect(page.locator('#vuemounts p')).toHaveText('vuemounts'); - await expect(page.locator('#vuescript p')).toHaveText('vuescript'); - }); - - test(`ignores content when vueMounts is undefined`, async ({ page }) => { - const docsifyInitConfig = getSharedConfig(); - - docsifyInitConfig.config.vueMounts['#vuemounts'] = undefined; - docsifyInitConfig.scriptURLs = vueURL; - - await docsifyInit(docsifyInitConfig); - await expect(page.locator('#vuefor')).toHaveText('12345'); - await expect(page.locator('#vuecomponent')).toHaveText('0'); - await expect(page.locator('#vueglobaloptions p')).toHaveText( - 'vueglobaloptions' - ); - await expect(page.locator('#vuemounts p')).toHaveText( - 'vueglobaloptions' - ); - await expect(page.locator('#vuescript p')).toHaveText('vuescript'); - }); - - test(`ignores "`; +exports[`Emoji Ignores emoji shorthand codes in html attributes 1`] = `" 
hh:mm
hh:mm:ss
Namespace::SubNameSpace
Namespace::SubNameSpace::Class
2014-12-29T16:11:20+00:00
"`; -exports[`Emoji Renders GitHub emoji images (nativeEmoji:false) 1`] = `"![\\"smile\\"](\\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8.png\\"){kind=icon}
text
text
texttext
text
text
texttext
๐๏ธ
๐๏ธ๐๏ธ
๐๏ธ ๐๏ธ
๐๏ธ๐๏ธ๐๏ธ
๐๏ธ ๐๏ธ ๐๏ธ
text๐๏ธ
๐๏ธtext
text๐๏ธtext
"`; +exports[`Emoji Renders native emoji characters (nativeEmoji:true) 1`] = `"๐๏ธ
๐๏ธ๐๏ธ
๐๏ธ ๐๏ธ
๐๏ธ๐๏ธ๐๏ธ
๐๏ธ ๐๏ธ ๐๏ธ
text๐๏ธ
๐๏ธtext
text๐๏ธtext
"`; diff --git a/test/integration/docs.test.js b/test/integration/docs.test.js index c3921c3e2..c4528addc 100644 --- a/test/integration/docs.test.js +++ b/test/integration/docs.test.js @@ -1,4 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); +import { jest } from '@jest/globals'; +import docsifyInit from '../helpers/docsify-init.js'; // Suite // ----------------------------------------------------------------------------- @@ -12,7 +13,7 @@ describe('Docs Site', function () { await docsifyInit({ config: { - coverpage: 'docs/_coverpage.md', + coverpage: '_coverpage.md', }, markdown: { homepage: '# Hello World', @@ -31,7 +32,7 @@ describe('Docs Site', function () { test('sidebar renders and is unchanged', async () => { await docsifyInit({ config: { - loadSidebar: 'docs/_sidebar.md', + loadSidebar: '_sidebar.md', }, markdown: { homepage: '# Hello World', @@ -49,7 +50,7 @@ describe('Docs Site', function () { test('navbar renders and is unchanged', async () => { await docsifyInit({ config: { - loadNavbar: 'docs/_navbar.md', + loadNavbar: '_navbar.md', }, markdown: { homepage: '# Hello World', diff --git a/test/integration/docsify.test.js b/test/integration/docsify.test.js index b766aae7d..438030314 100644 --- a/test/integration/docsify.test.js +++ b/test/integration/docsify.test.js @@ -1,4 +1,5 @@ -const docsifyInit = require('../helpers/docsify-init'); +import { jest } from '@jest/globals'; +import docsifyInit from '../helpers/docsify-init.js'; // Suite // ----------------------------------------------------------------------------- @@ -10,7 +11,6 @@ describe('Docsify', function () { expect(vm).toBeInstanceOf(Object); expect(vm.constructor.name).toBe('Docsify'); expect(vm.$fetch).toBeInstanceOf(Function); - expect(vm.$resetEvents).toBeInstanceOf(Function); expect(vm.route).toBeInstanceOf(Object); }); diff --git a/test/integration/emoji.test.js b/test/integration/emoji.test.js index dfd8516ac..7b9375299 100644 --- a/test/integration/emoji.test.js +++ b/test/integration/emoji.test.js @@ -1,4 +1,4 @@ -const docsifyInit = require('../helpers/docsify-init'); +import docsifyInit from '../helpers/docsify-init.js'; // Suite // ----------------------------------------------------------------------------- @@ -137,7 +137,8 @@ describe('Emoji', function () { test('Ignores emoji shorthand codes in html attributes', async () => { await docsifyInit({ markdown: { - homepage: ` `,
+ homepage:
+ /* html */ ' 
',
},
// _logHTML: true,
});
@@ -150,7 +151,8 @@ describe('Emoji', function () {
test('Ignores emoji shorthand codes in style url() values', async () => {
await docsifyInit({
markdown: {
- homepage: ``,
+ homepage:
+ /* html */ '',
},
// _logHTML: true,
});
@@ -163,7 +165,7 @@ describe('Emoji', function () {
test('Ignores emoji shorthand codes in code, pre, script, and template tags', async () => {
await docsifyInit({
markdown: {
- homepage: `
+ homepage: /* html */ `
:100:
:100:
diff --git a/test/integration/example.test.js b/test/integration/example.test.js
index 7365a1459..4f6b57378 100644
--- a/test/integration/example.test.js
+++ b/test/integration/example.test.js
@@ -1,17 +1,9 @@
-const { waitForFunction, waitForText } = require('../helpers/wait-for');
+import { waitForFunction, waitForText } from '../helpers/wait-for.js';
+import docsifyInit from '../helpers/docsify-init.js';
-const docsifyInit = require('../helpers/docsify-init');
-
-// Suite
-// -----------------------------------------------------------------------------
-describe('Example Tests', function () {
- // Tests
- // ---------------------------------------------------------------------------
+describe('Creating a Docsify site (integration tests in Jest)', function () {
test('Docsify /docs/ site using docsifyInit()', async () => {
await docsifyInit({
- config: {
- basePath: '/docs/',
- },
// _logHTML: true,
});
@@ -20,7 +12,7 @@ describe('Example Tests', function () {
// Verify options.markdown content was rendered
expect(document.querySelector('#main').textContent).toContain(
- 'A magical documentation site generator'
+ 'A magical documentation site generator',
);
});
@@ -28,7 +20,6 @@ describe('Example Tests', function () {
const docsifyInitConfig = {
config: {
name: 'Docsify Name',
- themeColor: 'red',
},
markdown: {
coverpage: `
@@ -66,15 +57,13 @@ describe('Example Tests', function () {
scriptURLs: [
// docsifyInit() route
'data-test-scripturls.js',
- // Server route
- '/lib/plugins/search.min.js',
],
style: `
body {
background: red !important;
}
`,
- styleURLs: ['/lib/themes/vue.css'],
+ styleURLs: ['/dist/themes/core.css'],
};
await docsifyInit({
@@ -84,9 +73,8 @@ describe('Example Tests', function () {
// Verify config options
expect(typeof window.$docsify).toBe('object');
- expect(window.$docsify).toHaveProperty('themeColor', 'red');
expect(document.querySelector('.app-name').textContent).toContain(
- 'Docsify Name'
+ 'Docsify Name',
);
// Verify docsifyInitConfig.markdown content was rendered
@@ -102,22 +90,21 @@ describe('Example Tests', function () {
// Verify docsifyInitConfig.scriptURLs were added to the DOM
for (const scriptURL of docsifyInitConfig.scriptURLs) {
const matchElm = document.querySelector(
- `script[data-src$="${scriptURL}"]`
+ `script[data-src$="${scriptURL}"]`,
);
expect(matchElm).toBeTruthy();
}
// Verify docsifyInitConfig.scriptURLs were executed
expect(document.body.hasAttribute('data-test-scripturls')).toBe(true);
- expect(document.querySelector('.search input[type="search"]')).toBeTruthy();
// Verify docsifyInitConfig.script was added to the DOM
expect(
[...document.querySelectorAll('script')].some(
elm =>
elm.textContent.replace(/\s+/g, '') ===
- docsifyInitConfig.script.replace(/\s+/g, '')
- )
+ docsifyInitConfig.script.replace(/\s+/g, ''),
+ ),
).toBe(true);
// Verify docsifyInitConfig.script was executed
@@ -126,7 +113,7 @@ describe('Example Tests', function () {
// Verify docsifyInitConfig.styleURLs were added to the DOM
for (const styleURL of docsifyInitConfig.styleURLs) {
const matchElm = document.querySelector(
- `link[rel*="stylesheet"][href$="${styleURL}"]`
+ `link[rel*="stylesheet"][href$="${styleURL}"]`,
);
expect(matchElm).toBeTruthy();
}
@@ -136,14 +123,14 @@ describe('Example Tests', function () {
[...document.querySelectorAll('style')].some(
elm =>
elm.textContent.replace(/\s+/g, '') ===
- docsifyInitConfig.style.replace(/\s+/g, '')
- )
+ docsifyInitConfig.style.replace(/\s+/g, ''),
+ ),
).toBe(true);
// Verify docsify navigation and docsifyInitConfig.routes
document.querySelector('a[href="#/test"]').click();
expect(
- await waitForFunction(() => /#\/test$/.test(window.location.href))
+ await waitForFunction(() => /#\/test$/.test(window.location.href)),
).toBeTruthy();
expect(await waitForText('#main', 'This is a custom route')).toBeTruthy();
});
diff --git a/test/integration/render.test.js b/test/integration/render.test.js
index f1335a064..4f624618b 100644
--- a/test/integration/render.test.js
+++ b/test/integration/render.test.js
@@ -1,23 +1,22 @@
-const stripIndent = require('common-tags/lib/stripIndent');
-const docsifyInit = require('../helpers/docsify-init');
+import { stripIndent } from 'common-tags';
+import docsifyInit from '../helpers/docsify-init.js';
+import { waitForText } from '../helpers/wait-for.js';
// Suite
// -----------------------------------------------------------------------------
describe('render', function () {
- // Setup & Teardown
- // -------------------------------------------------------------------------
- beforeEach(async () => {
- await docsifyInit();
- });
-
// Helpers
// ---------------------------------------------------------------------------
describe('helpers', () => {
+ beforeEach(async () => {
+ await docsifyInit();
+ });
+
test('important content', () => {
const output = window.marked('!> Important content');
expect(output).toMatchInlineSnapshot(
- `"Important content
"` + `"Important content
"`, ); }); @@ -25,7 +24,7 @@ describe('render', function () { const output = window.marked('?> General tip'); expect(output).toMatchInlineSnapshot( - `"General tip
"` + `"General tip
"`, ); }); }); @@ -33,6 +32,10 @@ describe('render', function () { // Lists // --------------------------------------------------------------------------- describe('lists', function () { + beforeEach(async () => { + await docsifyInit(); + }); + test('as unordered task list', async function () { const output = window.marked(stripIndent` - [x] Task 1 @@ -41,7 +44,7 @@ describe('render', function () { `); expect(output).toMatchInlineSnapshot( - `"text
text
This is a test
"`; diff --git a/test/unit/core-util.test.js b/test/unit/core-util.test.js index a6ff7d3ef..a1b941271 100644 --- a/test/unit/core-util.test.js +++ b/test/unit/core-util.test.js @@ -1,4 +1,4 @@ -const { isExternal } = require('../../src/core/util'); +import { isExternal } from '../../src/core/util/index.js'; // Core util // ----------------------------------------------------------------------------- @@ -27,7 +27,7 @@ describe('core/util', () => { test('non external local url with more /', () => { const result = isExternal( - `//////////////////${location.host}/docsify/demo.md` + `//////////////////${location.host}/docsify/demo.md`, ); expect(result).toBeFalsy(); @@ -54,7 +54,7 @@ describe('core/util', () => { test('external url with more /', () => { const result = isExternal( - '//////////////////example.github.io/docsify/demo.md' + '//////////////////example.github.io/docsify/demo.md', ); expect(result).toBeTruthy(); diff --git a/test/unit/example.test.js b/test/unit/example.test.js deleted file mode 100644 index d750ae36d..000000000 --- a/test/unit/example.test.js +++ /dev/null @@ -1,119 +0,0 @@ -// -import { greet } from './fixtures/greet.js'; -import { getTimeOfDay } from './fixtures/get-time-of-day.js'; -import * as getTimeOfDayModule from './fixtures/get-time-of-day.js'; - -// const greet = require('./fixtures/greet'); -// const getTimeOfDay = require('./fixtures/get-time-of-day'); -// const getTimeOfDayModule = { getTimeOfDay: getTimeOfDay }; - -// Suite -// ----------------------------------------------------------------------------- -describe(`Example Tests`, function() { - // Tests - // --------------------------------------------------------------------------- - describe('Jest & JSDOM basics', function() { - test('dom manipulation (jsdom)', () => { - const testText = 'This is a test'; - const testHTML = `${testText}
`; - - // Inject HTML - document.body.innerHTML = testHTML; - - // Add class to element and verify - document.body.classList.add('foo'); - - // Test HTML - expect(document.body.getAttribute('class')).toBe('foo'); - expect(document.body.textContent).toMatch(/Test/); - expect(document.querySelectorAll('p')).toHaveLength(1); - expect(document.querySelector('p').textContent).toBe(testText); - expect(document.querySelector('table')).toBeNull(); - }); - - // Snapshot Testing - // https://jestjs.io/docs/en/snapshot-testing - test('snapshot (jsdom)', () => { - const testText = 'This is a test'; - const testHTML = `${testText}
`; - - // Inject HTML - document.body.innerHTML = testHTML; - - // Add class to element and verify - document.body.classList.add('foo'); - - const documentHTML = document.documentElement.outerHTML; - - // Test snapshots - expect(documentHTML).toMatchSnapshot(); // See __snapshots__ - expect(documentHTML).toMatchInlineSnapshot( - `"This is a test
"` - ); - }); - }); - - describe('Fake Timers', function() { - // jest version issue - // test('data & time', () => { - // jest.useFakeTimers(); - // jest.setSystemTime(fakeDate); - // const timeOfDay = getTimeOfDay(); - // expect(timeOfDay).toContain; - // }); - }); - - describe('Mocks & Spies', function() { - test('mock import/require dependency using jest.fn()', () => { - const testModule = require('./fixtures/get-time-of-day.js'); - const { greet: testGreet } = require('./fixtures/greet.js'); - - testModule.getTimeOfDay = jest.fn(() => 'day'); - - const timeOfDay = testModule.getTimeOfDay(); - const greeting = testGreet('John'); - - expect(timeOfDay).toBe('day'); - expect(greeting).toBe(`Good day, John!`); - }); - - test('mock import/require dependency using jest.doMock()', () => { - const mockModulePath = './fixtures/get-time-of-day.js'; - - jest.doMock(mockModulePath, () => ({ - __esModule: true, - getTimeOfDay: jest.fn(() => 'night') - })); - - const mockGetTimeOfDay = require(mockModulePath).getTimeOfDay; - const { greet: testGreet } = require('./fixtures/greet.js'); - - const timeOfDay = mockGetTimeOfDay(); - const greeting = testGreet('John'); - - expect(timeOfDay).toBe('night'); - expect(greeting).toBe(`Good night, John!`); - }); - - test('spy on native method using jest.spyOn()', () => { - // Replace Math.random() implementation to return fixed value - jest.spyOn(Math, 'random').mockImplementation(() => 0.1); - - expect(Math.random()).toBe(0.1); - expect(Math.random()).toBe(0.1); - expect(Math.random()).toBe(0.1); - }); - - test('spy on import/require dependency using jest.spyOn()', () => { - jest - .spyOn(getTimeOfDayModule, 'getTimeOfDay') - .mockImplementation(() => 'night'); - - const timeOfDay = getTimeOfDay(); - const greeting = greet('John'); - - expect(timeOfDay).toBe('night'); - expect(greeting).toBe(`Good night, John!`); - }); - }); -}); diff --git a/test/unit/fixtures/get-time-of-day.js b/test/unit/fixtures/get-time-of-day.js deleted file mode 100644 index 2381e8836..000000000 --- a/test/unit/fixtures/get-time-of-day.js +++ /dev/null @@ -1,6 +0,0 @@ -export function getTimeOfDay(hours = new Date().getHours()) { - const timeOfDay = - hours < 12 ? 'morning' : hours < 17 ? 'afternoon' : 'evening'; - - return timeOfDay; -} diff --git a/test/unit/fixtures/greet.js b/test/unit/fixtures/greet.js deleted file mode 100644 index 61c58edda..000000000 --- a/test/unit/fixtures/greet.js +++ /dev/null @@ -1,7 +0,0 @@ -import { getTimeOfDay } from './get-time-of-day'; - -export function greet(name = 'friend') { - const timeOfDay = getTimeOfDay(); - - return `Good ${timeOfDay}, ${name}!`; -} diff --git a/test/unit/render-util.test.js b/test/unit/render-util.test.js index 574e0a8ef..33ae14ad2 100644 --- a/test/unit/render-util.test.js +++ b/test/unit/render-util.test.js @@ -1,11 +1,10 @@ -const { +import { removeAtag, getAndRemoveConfig, -} = require('../../src/core/render/utils'); - -const { tree } = require(`../../src/core/render/tpl`); - -const { slugify } = require(`../../src/core/render/slugify`); + getAndRemoveDocsifyIgnoreConfig, +} from '../../src/core/render/utils.js'; +import { tree } from '../../src/core/render/tpl.js'; +import { slugify } from '../../src/core/render/slugify.js'; // Suite // ----------------------------------------------------------------------------- @@ -20,23 +19,63 @@ describe('core/render/utils', () => { }); }); + // getAndRemoveDocsifyIgnoreConfig() + // --------------------------------------------------------------------------- + describe('getAndRemoveDocsifyIgnoreConfig()', () => { + test('getAndRemoveDocsifyIgnoreConfig from ', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocsifyIgnoreConfig( + 'My Ignore Title', + ); + expect(content).toBe('My Ignore Title'); + expect(ignoreSubHeading).toBeTruthy(); + expect(ignoreAllSubs === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocsifyIgnoreConfig from ', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocsifyIgnoreConfig( + 'My Ignore Title', + ); + expect(content).toBe('My Ignore Title'); + expect(ignoreAllSubs).toBeTruthy(); + expect(ignoreSubHeading === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocsifyIgnoreConfig from {docsify-ignore}', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocsifyIgnoreConfig('My Ignore Title{docsify-ignore}'); + expect(content).toBe('My Ignore Title'); + expect(ignoreSubHeading).toBeTruthy(); + expect(ignoreAllSubs === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocsifyIgnoreConfig from {docsify-ignore-all}', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocsifyIgnoreConfig('My Ignore Title{docsify-ignore-all}'); + expect(content).toBe('My Ignore Title'); + expect(ignoreAllSubs).toBeTruthy(); + expect(ignoreSubHeading === undefined).toBeTruthy(); + }); + }); + // getAndRemoveConfig() // --------------------------------------------------------------------------- describe('getAndRemoveConfig()', () => { test('parse simple config', () => { const result = getAndRemoveConfig( - `[filename](_media/example.md ':include')` + "[filename](_media/example.md ':include')", ); expect(result).toMatchObject({ config: {}, - str: `[filename](_media/example.md ':include')`, + str: "[filename](_media/example.md ':include')", }); }); test('parse config with arguments', () => { const result = getAndRemoveConfig( - `[filename](_media/example.md ':include :foo=bar :baz test')` + "[filename](_media/example.md ':include :foo=bar :baz test')", ); expect(result).toMatchObject({ @@ -44,18 +83,18 @@ describe('core/render/utils', () => { foo: 'bar', baz: true, }, - str: `[filename](_media/example.md ':include test')`, + str: "[filename](_media/example.md ':include test')", }); }); test('parse config with double quotes', () => { const result = getAndRemoveConfig( - `[filename](_media/example.md ":include")` + '[filename](_media/example.md ":include")', ); expect(result).toMatchObject({ config: {}, - str: `[filename](_media/example.md ":include")`, + str: '[filename](_media/example.md ":include")', }); }); }); @@ -83,7 +122,7 @@ describe('core/render/tpl', () => { ]); expect(result).toBe( - `` + /* html */ '', ); }); }); @@ -91,12 +130,12 @@ describe('core/render/tpl', () => { describe('core/render/slugify', () => { test('slugify()', () => { const result = slugify( - `Bla bla bla ` + 'Bla bla bla ', ); const result2 = slugify( - `Another ` + 'Another ', ); - expect(result).toBe(`bla-bla-bla-`); - expect(result2).toBe(`another-broken-example`); + expect(result).toBe('bla-bla-bla-'); + expect(result2).toBe('another-broken-example'); }); }); diff --git a/test/unit/router-history-base.test.js b/test/unit/router-history-base.test.js index e296fb8b3..58ff08246 100644 --- a/test/unit/router-history-base.test.js +++ b/test/unit/router-history-base.test.js @@ -1,4 +1,4 @@ -const { History } = require('../../src/core/router/history/base'); +import { History } from '../../src/core/router/history/base.js'; class MockHistory extends History { parse(path) { @@ -66,4 +66,35 @@ describe('router/history/base', () => { expect(url).toBe('/README'); }); }); + + // getFile test + // --------------------------------------------------------------------------- + describe('getFile', () => { + // Tests + // ------------------------------------------------------------------------- + test('path is url', () => { + const file = history.getFile('https://some/raw/url/README.md'); + + expect(file).toBe('https://some/raw/url/README.md'); + }); + test('path is url, but ext is .html', () => { + const file = history.getFile('https://foo.com/index.html'); + + expect(file).toBe('https://foo.com/index.html'); + }); + test('path is url, but with parameters', () => { + const file = history.getFile( + 'https://some/raw/url/README.md?token=Mytoken', + ); + + expect(file).toBe('https://some/raw/url/README.md?token=Mytoken'); + }); + test('path is url, but ext is different', () => { + history = new MockHistory({ ext: '.ext' }); + + const file = history.getFile('https://some/raw/url/README.md'); + + expect(file).toBe('https://some/raw/url/README.md.ext'); + }); + }); }); diff --git a/test/unit/router-util.test.js b/test/unit/router-util.test.js index 769d871ab..82973fa3a 100644 --- a/test/unit/router-util.test.js +++ b/test/unit/router-util.test.js @@ -1,4 +1,4 @@ -const { resolvePath } = require('../../src/core/util'); +import { resolvePath } from '../../src/core/util/index.js'; // Suite // ----------------------------------------------------------------------------- diff --git a/vercel.json b/vercel.json new file mode 100644 index 000000000..da3464f69 --- /dev/null +++ b/vercel.json @@ -0,0 +1,13 @@ +{ + "headers": [ + { + "source": "/(.*)", + "headers": [{ "key": "x-robots-tag", "value": "noindex" }] + } + ], + "redirects": [{ "source": "/", "destination": "/preview/" }], + "rewrites": [ + { "source": "/preview/CHANGELOG.md", "destination": "/CHANGELOG.md" }, + { "source": "/preview/:path*", "destination": "/docs/:path*" } + ] +}