-
### 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..8353d0266 100644
--- a/README.md
+++ b/README.md
@@ -27,14 +27,7 @@
-## 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,54 +36,30 @@
- 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
-## 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
@@ -100,18 +69,9 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com
## 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！:heart: [[Become a sponsor](https://opencollective.com/docsify)]
+
+
## Contributors
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..394c5435b
--- /dev/null
+++ b/babel.config.json
@@ -0,0 +1,12 @@
+{
+ "presets": [
+ [
+ "@babel/preset-env",
+ {
+ "targets": {
+ "node": "current"
+ }
+ }
+ ]
+ ]
+}
diff --git a/build/build.js b/build/build.js
index 0de786828..c8b9ab545 100644
--- a/build/build.js
+++ b/build/build.js
@@ -1,13 +1,18 @@
-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')
+import path from 'path';
+import { promises as fs } from 'fs';
+import * as rollup from 'rollup';
+import commonjs from '@rollup/plugin-commonjs';
+import nodeResolve from '@rollup/plugin-node-resolve';
+import uglify from '@rollup/plugin-terser';
+import replace from '@rollup/plugin-replace';
+import chokidar from 'chokidar';
+import { relative } from './util.js';
+
+const pkgPath = relative(import.meta, '..', 'package.json');
+const pkgString = (await fs.readFile(pkgPath)).toString();
+const pkg = JSON.parse(pkgString);
+const isProd = process.env.NODE_ENV === 'production';
+const version = process.env.VERSION || pkg.version;
/**
* @param {{
@@ -21,92 +26,95 @@ async function build(opts) {
await rollup
.rollup({
input: opts.input,
- plugins: (opts.plugins || []).concat([
- buble({
- transforms: {
- dangerousForOf: true
- }}),
+ plugins: [
+ ...(opts.plugins || []),
commonjs(),
nodeResolve(),
replace({
__VERSION__: version,
- 'process.env.SSR': false
- })
- ]),
- onwarn: function (message) {
+ }),
+ ],
+ onwarn(message) {
if (message.code === 'UNRESOLVED_IMPORT') {
throw new Error(
`Could not resolve module ` +
- message.source +
- `. Try running 'npm install' or using rollup's 'external' option if this is an external dependency. ` +
- `Module ${message.source} is imported in ${message.importer}`
- )
+ message.source +
+ `. Try running 'npm install' or using rollup's 'external' option if this is an external dependency. ` +
+ `Module ${message.source} is imported in ${message.importer}`
+ );
}
- }
+ },
})
- .then(function (bundle) {
- var dest = 'lib/' + (opts.output || opts.input)
+ .then(bundle => {
+ const dest = 'lib/' + (opts.output || opts.input);
- console.log(dest)
+ console.log(dest);
return bundle.write({
format: 'iife',
- output: opts.globalName ? {name: opts.globalName} : {},
+ output: opts.globalName ? { name: opts.globalName } : {},
file: dest,
- strict: false
- })
- })
+ strict: false,
+ });
+ });
}
async function buildCore() {
- const promises = []
+ const promises = [];
- promises.push(build({
- input: 'src/core/index.js',
- output: 'docsify.js',
- }))
+ promises.push(
+ build({
+ input: 'src/core/index.js',
+ output: 'docsify.js',
+ })
+ );
if (isProd) {
- promises.push(build({
- input: 'src/core/index.js',
- output: 'docsify.min.js',
- plugins: [uglify()]
- }))
+ promises.push(
+ build({
+ input: 'src/core/index.js',
+ output: 'docsify.min.js',
+ plugins: [uglify()],
+ })
+ );
}
- await Promise.all(promises)
+ await Promise.all(promises);
}
async function buildAllPlugin() {
- var plugins = [
- {name: 'search', input: 'search/index.js'},
- {name: 'ga', input: 'ga.js'},
- {name: 'matomo', input: 'matomo.js'},
- {name: 'emoji', input: 'emoji.js'},
- {name: 'external-script', input: 'external-script.js'},
- {name: 'front-matter', input: 'front-matter/index.js'},
- {name: 'zoom-image', input: 'zoom-image.js'},
- {name: 'disqus', input: 'disqus.js'},
- {name: 'gitalk', input: 'gitalk.js'}
- ]
+ const plugins = [
+ { name: 'search', input: 'search/index.js' },
+ { name: 'ga', input: 'ga.js' },
+ { name: 'gtag', input: 'gtag.js' },
+ { name: 'matomo', input: 'matomo.js' },
+ { name: 'emoji', input: 'emoji.js' },
+ { name: 'external-script', input: 'external-script.js' },
+ { name: 'front-matter', input: 'front-matter/index.js' },
+ { name: 'zoom-image', input: 'zoom-image.js' },
+ { name: 'disqus', input: 'disqus.js' },
+ { name: 'gitalk', input: 'gitalk.js' },
+ ];
const promises = plugins.map(item => {
return build({
input: 'src/plugins/' + item.input,
- output: 'plugins/' + item.name + '.js'
- })
- })
+ output: 'plugins/' + item.name + '.js',
+ });
+ });
if (isProd) {
plugins.forEach(item => {
- promises.push(build({
- input: 'src/plugins/' + item.input,
- output: 'plugins/' + item.name + '.min.js',
- plugins: [uglify()]
- }))
- })
+ promises.push(
+ build({
+ input: 'src/plugins/' + item.input,
+ output: 'plugins/' + item.name + '.min.js',
+ plugins: [uglify()],
+ })
+ );
+ });
}
- await Promise.all(promises)
+ await Promise.all(promises);
}
async function main() {
@@ -116,41 +124,37 @@ async function main() {
atomic: true,
awaitWriteFinish: {
stabilityThreshold: 1000,
- pollInterval: 100
- }
+ pollInterval: 100,
+ },
})
.on('change', p => {
- console.log('[watch] ', p)
- const dirs = p.split(path.sep)
+ console.log('[watch] ', p);
+ const dirs = p.split(path.sep);
if (dirs[1] === 'core') {
- buildCore()
+ buildCore();
} else if (dirs[2]) {
- const name = path.basename(dirs[2], '.js')
+ const name = path.basename(dirs[2], '.js');
const input = `src/plugins/${name}${
/\.js/.test(dirs[2]) ? '' : '/index'
- }.js`
+ }.js`;
build({
input,
- output: 'plugins/' + name + '.js'
- })
+ output: 'plugins/' + name + '.js',
+ });
}
})
.on('ready', () => {
- console.log('[start]')
- buildCore()
- buildAllPlugin()
- })
+ console.log('[start]');
+ buildCore();
+ buildAllPlugin();
+ });
} else {
- await Promise.all([
- buildCore(),
- buildAllPlugin()
- ])
+ await Promise.all([buildCore(), buildAllPlugin()]);
}
}
-main().catch((e) => {
- console.error(e)
- process.exit(1)
-})
-
+main().catch(e => {
+ console.error(e);
+ process.exit(1);
+});
diff --git a/build/cover.js b/build/cover.js
index fbd27f742..64bf5a70f 100644
--- a/build/cover.js
+++ b/build/cover.js
@@ -1,14 +1,18 @@
-var fs = require('fs')
-var read = fs.readFileSync
-var write = fs.writeFileSync
-var version = process.env.VERSION || require('../package.json').version
+import fs from 'fs';
+import { relative } from './util.js';
-var file = __dirname + '/../docs/_coverpage.md'
-var cover = read(file, 'utf8').toString()
+const read = fs.readFileSync;
+const write = fs.writeFileSync;
+const pkgPath = relative(import.meta, '..', 'package.json');
+const pkg = JSON.parse(read(pkgPath).toString());
+const version = process.env.VERSION || pkg.version;
-console.log('Replace version number in cover page...')
+const file = relative(import.meta, '..', 'docs', '_coverpage.md');
+let cover = read(file, 'utf8').toString();
+
+console.log('Replace version number in cover page...');
cover = cover.replace(
/(\S+)?<\/small>/g,
- '' + version + ''
-)
-write(file, cover)
+ /* html */ `${version}`
+);
+write(file, cover);
diff --git a/build/css.js b/build/css.js
index 2214f3fe4..71a9dc947 100644
--- a/build/css.js
+++ b/build/css.js
@@ -1,47 +1,48 @@
-const fs = require('fs')
-const path = require('path')
-const {spawn} = require('child_process')
+import fs from 'fs';
+import path from 'path';
+import { spawn } from 'child_process';
-const args = process.argv.slice(2)
-fs.readdir(path.join(__dirname, '../src/themes'), (err, files) => {
- if (err) {
- console.error('err', err)
- process.exit(1)
- }
- files.map(async (file) => {
- if (/\.styl/g.test(file)) {
- var stylusCMD;
- const stylusBin = ['node_modules', 'stylus', 'bin', 'stylus'].join(path.sep)
- var cmdargs = [
- stylusBin,
- `src/themes/${file}`,
- '-u',
- 'autoprefixer-stylus'
- ]
- cmdargs = cmdargs.concat(args)
+const relative = path => new URL(path, import.meta.url);
+const args = process.argv.slice(2);
+fs.readdir(relative('../src/themes'), (err, files) => {
+ if (err) {
+ console.error('err', err);
+ process.exit(1);
+ }
+ files.map(async file => {
+ if (/\.styl/g.test(file)) {
+ const stylusBin = ['node_modules', 'stylus', 'bin', 'stylus'].join(
+ path.sep
+ );
+ let cmdargs = [
+ stylusBin,
+ `src/themes/${file}`,
+ '-u',
+ 'autoprefixer-stylus',
+ ];
+ cmdargs = [...cmdargs, ...args];
- stylusCMD = spawn('node', cmdargs, { shell: true })
+ const stylusCMD = spawn('node', cmdargs, { shell: true });
- stylusCMD.stdout.on('data', (data) => {
- console.log(`[Stylus Build ] stdout: ${data}`);
- });
+ stylusCMD.stdout.on('data', data => {
+ console.log(`[Stylus Build ] stdout: ${data}`);
+ });
- stylusCMD.stderr.on('data', (data) => {
- console.error(`[Stylus Build ] stderr: ${data}`);
- });
+ stylusCMD.stderr.on('data', data => {
+ console.error(`[Stylus Build ] stderr: ${data}`);
+ });
- stylusCMD.on('close', (code) => {
- const message = `[Stylus Build ] child process exited with code ${code}`
+ stylusCMD.on('close', code => {
+ const message = `[Stylus Build ] child process exited with code ${code}`;
- if (code !== 0) {
- console.error(message);
- process.exit(code)
- }
- console.log(message);
- });
- } else {
- return
+ if (code !== 0) {
+ console.error(message);
+ process.exit(code);
}
-
- })
-})
+ console.log(message);
+ });
+ } else {
+ return;
+ }
+ });
+});
diff --git a/build/emoji.js b/build/emoji.js
index c19b8e735..f1ad8930b 100644
--- a/build/emoji.js
+++ b/build/emoji.js
@@ -1,6 +1,6 @@
-const axios = require('axios');
-const fs = require('fs');
-const path = require('path');
+import fs from 'fs';
+import path from 'path';
+import axios from 'axios';
const filePaths = {
emojiMarkdown: path.resolve(process.cwd(), 'docs', 'emoji.md'),
@@ -93,17 +93,15 @@ function writeEmojiJS(emojiData) {
}
}
-(async () => {
- console.info('Build emoji');
+console.info('Build emoji');
- try {
- const emojiData = await getEmojiData();
+try {
+ const emojiData = await getEmojiData();
- if (emojiData) {
- writeEmojiPage(emojiData);
- writeEmojiJS(emojiData);
- }
- } catch (err) {
- console.warn(`- Error: ${err.message}`);
+ if (emojiData) {
+ writeEmojiPage(emojiData);
+ writeEmojiJS(emojiData);
}
-})();
+} catch (err) {
+ console.warn(`- Error: ${err.message}`);
+}
diff --git a/build/mincss.js b/build/mincss.js
index 0c9c72280..3d480c1d8 100644
--- a/build/mincss.js
+++ b/build/mincss.js
@@ -1,15 +1,21 @@
-const cssnano = require('cssnano').process
-const path = require('path')
-const fs = require('fs')
+import path from 'path';
+import fs from 'fs';
+import cssnano from 'cssnano';
-files = fs.readdirSync(path.resolve('lib/themes'))
+const files = fs
+ .readdirSync(path.resolve('lib/themes'))
+ .filter(file => !file.endsWith('min.css'));
files.forEach(file => {
- file = path.resolve('lib/themes', file)
- cssnano(fs.readFileSync(file)).then(result => {
- fs.writeFileSync(file, result.css)
- }).catch(e => {
- console.error(e)
- process.exit(1)
- })
-})
+ file = path.resolve('lib/themes', file);
+ cssnano
+ .process(fs.readFileSync(file))
+ .then(result => {
+ file = file.replace(/\.css$/, '.min.css');
+ fs.writeFileSync(file, result.css);
+ })
+ .catch(e => {
+ console.error(e);
+ process.exit(1);
+ });
+});
diff --git a/build/release.sh b/build/release.sh
index d27275215..40de0777c 100755
--- a/build/release.sh
+++ b/build/release.sh
@@ -12,22 +12,11 @@ echo
if [[ $REPLY =~ ^[Yy]$ ]]; then
echo "Releasing $VERSION ..."
- # Removing test script as non - availibity of tests. Will Add it once tests are completed
-
- # npm run test
-
# build
VERSION=$VERSION npm run build
- # update packages
- cd packages/docsify-server-renderer
- npm version $VERSION
- if [[ -z $RELEASE_TAG ]]; then
- npm publish
- else
- npm publish --tag $RELEASE_TAG
- fi
- cd -
+ # TODO
+ # npm test
# commit
git add -A
diff --git a/build/ssr.js b/build/ssr.js
deleted file mode 100644
index 01fdd0518..000000000
--- a/build/ssr.js
+++ /dev/null
@@ -1,35 +0,0 @@
-var rollup = require('rollup')
-var buble = require('rollup-plugin-buble')
-var async = require('rollup-plugin-async')
-var replace = require('rollup-plugin-replace')
-
-rollup
- .rollup({
- input: 'packages/docsify-server-renderer/index.js',
- plugins: [
- async(),
- replace({
- __VERSION__: process.env.VERSION || require('../package.json').version,
- 'process.env.SSR': true
- }),
- buble({
- transforms: {
- generator: false
- }
- })
- ],
- onwarn: function () {}
- })
- .then(function (bundle) {
- var dest = 'packages/docsify-server-renderer/build.js'
-
- console.log(dest)
- return bundle.write({
- format: 'cjs',
- file: dest
- })
- })
- .catch(function (err) {
- console.error(err)
- process.exit(1)
- })
diff --git a/build/util.js b/build/util.js
new file mode 100644
index 000000000..0dad7d3a6
--- /dev/null
+++ b/build/util.js
@@ -0,0 +1,6 @@
+import url from 'url';
+import path from 'path';
+
+/** Get a new path relative to the current module (pass import.meta). */
+export const relative = (meta, ...to) =>
+ path.resolve(path.dirname(url.fileURLToPath(meta.url)), ...to);
diff --git a/docs/CNAME b/docs/CNAME
index e555e6fb4..2e8abd2c0 100644
--- a/docs/CNAME
+++ b/docs/CNAME
@@ -1 +1 @@
-docsify.js.org
\ No newline at end of file
+wiki.wellwei.top
\ No newline at end of file
diff --git a/docs/_media/example-with-yaml.md b/docs/_media/example-with-yaml.md
index 081bedde2..bfb280d74 100644
--- a/docs/_media/example-with-yaml.md
+++ b/docs/_media/example-with-yaml.md
@@ -3,4 +3,4 @@ author: John Smith
date: 2020-1-1
---
-> This is from the `example.md`
+> This is from the `example-with-yaml.md`
diff --git a/docs/_media/example.html b/docs/_media/example.html
index d35ee1624..9820b4c1e 100644
--- a/docs/_media/example.html
+++ b/docs/_media/example.html
@@ -1 +1 @@
-${text}${text}${text}
`; + result = /* html */ `${text}
`; } return result; diff --git a/src/core/render/compiler/taskListItem.js b/src/core/render/compiler/taskListItem.js index afc6b1052..e4b2512ff 100644 --- a/src/core/render/compiler/taskListItem.js +++ b/src/core/render/compiler/taskListItem.js @@ -2,8 +2,8 @@ export const taskListItemCompiler = ({ renderer }) => (renderer.listitem = text => { const isTaskItem = /^(
`;
+ result = /* html */ ``;
}
}
diff --git a/src/core/render/gen-tree.js b/src/core/render/gen-tree.js
index cfe49282c..f0e6dde56 100644
--- a/src/core/render/gen-tree.js
+++ b/src/core/render/gen-tree.js
@@ -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..0dcd0ed1d 100644
--- a/src/core/render/index.js
+++ b/src/core/render/index.js
@@ -1,250 +1,275 @@
/* 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)();
-}
+import * as dom from '../util/dom.js';
+import { getPath, isAbsolutePath } from '../router/util.js';
+import { isMobile, inBrowser } 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';
-function formatUpdated(html, updated, fn) {
- updated =
- typeof fn === 'function'
- ? fn(updated)
- : typeof fn === 'string'
- ? tinydate(fn)(new Date(updated))
- : updated;
+/** @typedef {import('../Docsify.js').Constructor} Constructor */
- return html.replace(/{docsify-updated}/g, updated);
-}
+/**
+ * @template {!Constructor} T
+ * @param {T} Base - The class to extend
+ */
+export function Render(Base) {
+ return class Render extends Base {
+ #vueGlobalData;
+
+ #executeScript() {
+ const script = dom
+ .findAll('.markdown-section>script')
+ .filter(s => !/template/.test(s.type))[0];
+ if (!script) {
+ return false;
+ }
-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));
+ const code = script.innerText.trim();
+ if (!code) {
+ return false;
+ }
- const isMountedVue = elm => {
- const isVue2 = Boolean(elm.__vue__ && elm.__vue__._isVue);
- const isVue3 = Boolean(elm._vnode && elm._vnode.__v_skip);
+ new Function(code)();
+ }
- return isVue2 || isVue3;
- };
+ #formatUpdated(html, updated, fn) {
+ updated =
+ typeof fn === 'function'
+ ? fn(updated)
+ : typeof fn === 'string'
+ ? tinydate(fn)(new Date(updated))
+ : updated;
- 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,7 +10,6 @@ test.describe('Example Tests', () => { await page.evaluate(() => { window.$docsify = { el: '#app', - basePath: '/docs/', themeColor: 'red', }; }); @@ -110,9 +35,6 @@ test.describe('Example Tests', () => { // Load custom docsify // (See ./helpers/docsifyInit.js for details) await docsifyInit({ - config: { - basePath: '/docs/', - }, // _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..5b37fbee9 --- /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: ['/lib/plugins/gtag.min.js'], + styleURLs: ['/lib/themes/vue.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: ['/lib/plugins/gtag.min.js'], + styleURLs: ['/lib/themes/vue.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..1000c124b 100644 --- a/test/e2e/index-file.test.js +++ b/test/e2e/index-file.test.js @@ -1,12 +1,12 @@ -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 }) => { 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..4b5a28a03 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 }) => { @@ -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: { @@ -196,4 +197,39 @@ test.describe('Search Plugin Tests', () => { await searchFieldElm.fill('empty'); await expect(resultsHeadingElm).toHaveText('EmptyContent'); }); + + test('handles default focusSearch binding', async ({ page }) => { + const docsifyInitConfig = { + scriptURLs: ['/lib/plugins/search.min.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: ['/lib/plugins/search.min.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(); + }); }); diff --git a/test/e2e/security.test.js b/test/e2e/security.test.js index 7d0c98830..c01d8716b 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 = { diff --git a/test/e2e/sidebar.test.js b/test/e2e/sidebar.test.js index e29fba075..077826f54 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 // ----------------------------------------------------------------------------- diff --git a/test/e2e/virtual-routes.test.js b/test/e2e/virtual-routes.test.js index 21636d159..0b2e3f86c 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,6 +8,8 @@ const { test, expect } = require('./fixtures/docsify-init-fixture'); */ async function navigateToRoute(page, route) { await page.evaluate(r => (window.location.hash = r), route); + // TODO: playwright eslint now recommends not using networkidle + // eslint-disable-next-line await page.waitForLoadState('networkidle'); } @@ -99,9 +101,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 +120,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 +221,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 +263,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..6997c7281 100644 --- a/test/e2e/vue.test.js +++ b/test/e2e/vue.test.js @@ -1,6 +1,6 @@ -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/lib/stripIndent/index.js'; +import docsifyInit from '../helpers/docsify-init.js'; +import { test, expect } from './fixtures/docsify-init-fixture.js'; const vueURLs = [ '/node_modules/vue2/dist/vue.js', @@ -24,16 +24,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', @@ -98,6 +96,23 @@ test.describe('Vue.js Compatibility', () => { const vueVersion = Number(vueURL.match(/vue(\d+)/)[1]); // 2|3 test.describe(`Vue v${vueVersion}`, () => { + test(`Parse templates and render content when import Vue v${vueVersion} resources`, async ({ + page, + }) => { + const docsifyInitConfig = { + config: {}, + markdown: { + homepage: stripIndent` +![\\"logo\\"](\\"http://127.0.0.1:3001/_media/icon.svg\\"){kind=icon}
+"+ + " +Getting Started
docsify 4.13.0
A magical documentation site generator.
- Simple and lightweight
- No statically built html files
- Multiple themes
`,
+ homepage: /* html */ ` `,
},
// _logHTML: true,
});
@@ -150,7 +150,7 @@ describe('Emoji', function () {
test('Ignores emoji shorthand codes in style url() values', async () => {
await docsifyInit({
markdown: {
- homepage: ``,
+ homepage: /* html */ ``,
},
// _logHTML: true,
});
@@ -163,7 +163,7 @@ describe('Emoji', function () {
test('Ignores emoji shorthand codes in code, pre, script, and template tags', async () => {
await docsifyInit({
markdown: {
- homepage: `
+ homepage: /* html */ `
:100:
![\\"logo\\"](\\"http://127.0.0.1:4000/_media/icon.svg\\"){kind=icon}
:100:
diff --git a/test/integration/example.test.js b/test/integration/example.test.js
index 7365a1459..b19e14a60 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,
});
diff --git a/test/integration/render.test.js b/test/integration/render.test.js
index f1335a064..4b6fbc1b3 100644
--- a/test/integration/render.test.js
+++ b/test/integration/render.test.js
@@ -1,18 +1,17 @@
-const stripIndent = require('common-tags/lib/stripIndent');
-const docsifyInit = require('../helpers/docsify-init');
+import stripIndent from 'common-tags/lib/stripIndent/index.js';
+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');
@@ -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
@@ -100,11 +103,15 @@ describe('render', function () {
// Images
// ---------------------------------------------------------------------------
describe('images', function () {
+ beforeEach(async () => {
+ await docsifyInit();
+ });
+
test('regular', async function () {
const output = window.marked('');
expect(output).toMatchInlineSnapshot(
- `"This is a test
"`; diff --git a/test/unit/core-util.test.js b/test/unit/core-util.test.js index 0ebbf7bbd..a71d84208 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 // ----------------------------------------------------------------------------- @@ -59,5 +59,17 @@ describe('core/util', () => { expect(result).toBeTruthy(); }); + + test('external url with one \\', () => { + const result = isExternal('/\\example.github.io/docsify/demo.md'); + + expect(result).toBeTruthy(); + }); + + test('external url with two \\', () => { + const result = isExternal('/\\\\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..24c750d01 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`); + getAndRemoveDocisfyIgnoreConfig, +} from '../../src/core/render/utils.js'; +import { tree } from '../../src/core/render/tpl.js'; +import { slugify } from '../../src/core/render/slugify.js'; // Suite // ----------------------------------------------------------------------------- @@ -20,6 +19,46 @@ describe('core/render/utils', () => { }); }); + // getAndRemoveDocisfyIgnorConfig() + // --------------------------------------------------------------------------- + describe('getAndRemoveDocisfyIgnorConfig()', () => { + test('getAndRemoveDocisfyIgnorConfig from ', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocisfyIgnoreConfig( + 'My Ignore Title' + ); + expect(content).toBe('My Ignore Title'); + expect(ignoreSubHeading).toBeTruthy(); + expect(ignoreAllSubs === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocisfyIgnorConfig from ', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocisfyIgnoreConfig( + 'My Ignore Title' + ); + expect(content).toBe('My Ignore Title'); + expect(ignoreAllSubs).toBeTruthy(); + expect(ignoreSubHeading === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocisfyIgnorConfig from {docsify-ignore}', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocisfyIgnoreConfig('My Ignore Title{docsify-ignore}'); + expect(content).toBe('My Ignore Title'); + expect(ignoreSubHeading).toBeTruthy(); + expect(ignoreAllSubs === undefined).toBeTruthy(); + }); + + test('getAndRemoveDocisfyIgnorConfig from {docsify-ignore-all}', () => { + const { content, ignoreAllSubs, ignoreSubHeading } = + getAndRemoveDocisfyIgnoreConfig('My Ignore Title{docsify-ignore-all}'); + expect(content).toBe('My Ignore Title'); + expect(ignoreAllSubs).toBeTruthy(); + expect(ignoreSubHeading === undefined).toBeTruthy(); + }); + }); + // getAndRemoveConfig() // --------------------------------------------------------------------------- describe('getAndRemoveConfig()', () => { @@ -83,7 +122,7 @@ describe('core/render/tpl', () => { ]); expect(result).toBe( - `` + /* html */ `` ); }); }); diff --git a/test/unit/router-history-base.test.js b/test/unit/router-history-base.test.js index e296fb8b3..a486ed2db 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) { 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*" } + ] +}