mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
fix xhr usage, fix init URL setup
provide full test setup including fixtures
This commit is contained in:
Anton Wilhelm
parent
bc4d06bb16
commit
01ea44106b
6
package-lock.json
generated
6
package-lock.json
generated
@ -8791,12 +8791,6 @@
|
|||||||
"async-limiter": "~1.0.0"
|
"async-limiter": "~1.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"xhr2": {
|
|
||||||
"version": "0.1.4",
|
|
||||||
"resolved": "https://registry.npmjs.org/xhr2/-/xhr2-0.1.4.tgz",
|
|
||||||
"integrity": "sha1-f4dliEdxbbUCYyOBL4GMras4el8=",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"xml-name-validator": {
|
"xml-name-validator": {
|
||||||
"version": "3.0.0",
|
"version": "3.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz",
|
||||||
|
|||||||
@ -72,8 +72,7 @@
|
|||||||
"rollup-plugin-node-resolve": "^3.0.0",
|
"rollup-plugin-node-resolve": "^3.0.0",
|
||||||
"rollup-plugin-replace": "^2.0.0",
|
"rollup-plugin-replace": "^2.0.0",
|
||||||
"rollup-plugin-uglify": "^2.0.1",
|
"rollup-plugin-uglify": "^2.0.1",
|
||||||
"stylus": "^0.54.5",
|
"stylus": "^0.54.5"
|
||||||
"xhr2": "^0.1.4"
|
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"doc",
|
"doc",
|
||||||
|
|||||||
103
test/_helper.js
103
test/_helper.js
@ -1,45 +1,10 @@
|
|||||||
// load ES6 modules in Node.js on the fly
|
// load ES6 modules in Node.js on the fly
|
||||||
require = require('esm')(module/*, options*/)
|
require = require('esm')(module/*, options*/)
|
||||||
|
|
||||||
|
const path = require('path')
|
||||||
const {expect} = require('chai')
|
const {expect} = require('chai')
|
||||||
|
|
||||||
const {JSDOM} = require('jsdom')
|
const {JSDOM} = require('jsdom')
|
||||||
const XMLHttpRequest = require('xhr2') // JSDOM doesn't support XMLHttpRequest
|
|
||||||
// TODO: try to fix tests when using `<div id="app"></div>` in body
|
|
||||||
const markup = `<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head></head>
|
|
||||||
<body></body>
|
|
||||||
</html>`
|
|
||||||
// TODO: this may not work if tests are mutate the DOM, instead a new instance needs to be created
|
|
||||||
// for every test case but that will slow down the tests
|
|
||||||
const dom = new JSDOM(markup)
|
|
||||||
|
|
||||||
global.window = dom.window
|
|
||||||
global.document = dom.window.document
|
|
||||||
global.navigator = dom.window.navigator
|
|
||||||
global.location = dom.window.location
|
|
||||||
global.XMLHttpRequest = XMLHttpRequest
|
|
||||||
|
|
||||||
const {initMixin} = require('../src/core/init')
|
|
||||||
const {routerMixin} = require('../src/core//router')
|
|
||||||
const {renderMixin} = require('../src/core//render')
|
|
||||||
const {fetchMixin} = require('../src/core/fetch')
|
|
||||||
const {eventMixin} = require('../src/core//event')
|
|
||||||
|
|
||||||
// mimic src/core/index.js but for Node.js
|
|
||||||
|
|
||||||
function Docsify() {
|
|
||||||
this._init()
|
|
||||||
}
|
|
||||||
|
|
||||||
const proto = Docsify.prototype
|
|
||||||
|
|
||||||
initMixin(proto)
|
|
||||||
routerMixin(proto)
|
|
||||||
renderMixin(proto)
|
|
||||||
fetchMixin(proto)
|
|
||||||
eventMixin(proto)
|
|
||||||
|
|
||||||
function ready(callback) {
|
function ready(callback) {
|
||||||
const state = document.readyState
|
const state = document.readyState
|
||||||
@ -50,16 +15,64 @@ function ready(callback) {
|
|||||||
|
|
||||||
document.addEventListener('DOMContentLoaded', callback)
|
document.addEventListener('DOMContentLoaded', callback)
|
||||||
}
|
}
|
||||||
let docsify = null
|
module.exports.init = function(fixture = 'default', config = {}, markup) {
|
||||||
module.exports.init = function(callback) {
|
if (markup == null) {
|
||||||
|
markup = `<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head></head>
|
||||||
|
<body>
|
||||||
|
<div id="app"></div>
|
||||||
|
<script>
|
||||||
|
window.$docsify = ${JSON.stringify(config, null, 2)}
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>`
|
||||||
|
}
|
||||||
|
const rootPath = path.join(__dirname, 'fixtures', fixture)
|
||||||
|
|
||||||
|
const dom = new JSDOM(markup)
|
||||||
|
dom.reconfigure({ url: 'file:///' + rootPath })
|
||||||
|
|
||||||
|
global.window = dom.window
|
||||||
|
global.document = dom.window.document
|
||||||
|
global.navigator = dom.window.navigator
|
||||||
|
global.location = dom.window.location
|
||||||
|
global.XMLHttpRequest = dom.window.XMLHttpRequest
|
||||||
|
|
||||||
|
// mimic src/core/index.js but for Node.js
|
||||||
|
function Docsify() {
|
||||||
|
this._init()
|
||||||
|
}
|
||||||
|
|
||||||
|
const proto = Docsify.prototype
|
||||||
|
|
||||||
|
const {initMixin} = require('../src/core/init')
|
||||||
|
const {routerMixin} = require('../src/core//router')
|
||||||
|
const {renderMixin} = require('../src/core//render')
|
||||||
|
const {fetchMixin} = require('../src/core/fetch')
|
||||||
|
const {eventMixin} = require('../src/core//event')
|
||||||
|
|
||||||
|
initMixin(proto)
|
||||||
|
routerMixin(proto)
|
||||||
|
renderMixin(proto)
|
||||||
|
fetchMixin(proto)
|
||||||
|
eventMixin(proto)
|
||||||
|
|
||||||
|
const NOT_INIT_PATTERN = '<!--main-->'
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
// return cached version / TODO: see above: this might not scale, new instance of JSDOM is reqiured
|
ready(() => {
|
||||||
if (docsify != null) {
|
const docsify = new Docsify()
|
||||||
return resolve(docsify)
|
// TODO: use callback instead of polling, but usually it works after 10ms
|
||||||
}
|
const id = setInterval(() => {
|
||||||
ready(_ => {
|
if (dom.window.document.body.innerHTML.indexOf(NOT_INIT_PATTERN) == -1) {
|
||||||
docsify = new Docsify()
|
clearInterval(id)
|
||||||
return resolve(docsify)
|
return resolve({
|
||||||
|
docsify: docsify,
|
||||||
|
dom: dom
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}, 10)
|
||||||
})
|
})
|
||||||
|
|
||||||
})
|
})
|
||||||
|
|||||||
6
test/fixtures/default/README.md
vendored
Normal file
6
test/fixtures/default/README.md
vendored
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
<!--
|
||||||
|
|
||||||
|
create your own fixture directory
|
||||||
|
if you need a custom README.md or sidebar
|
||||||
|
|
||||||
|
-->
|
||||||
@ -6,14 +6,14 @@ const {init, expectSameDom} = require('./_helper')
|
|||||||
|
|
||||||
describe('render', function() {
|
describe('render', function() {
|
||||||
it('important content (tips)', async function() {
|
it('important content (tips)', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile('!> **Time** is money, my friend!')
|
const output = docsify.compiler.compile('!> **Time** is money, my friend!')
|
||||||
expect(output).equal('<p class="tip"><strong>Time</strong> is money, my friend!</p>')
|
expect(output).equal('<p class="tip"><strong>Time</strong> is money, my friend!</p>')
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('lists', function() {
|
describe('lists', function() {
|
||||||
it('as unordered task list', async function() {
|
it('as unordered task list', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile(`
|
const output = docsify.compiler.compile(`
|
||||||
- [x] Task 1
|
- [x] Task 1
|
||||||
- [ ] Task 2
|
- [ ] Task 2
|
||||||
@ -26,7 +26,7 @@ describe('render', function() {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('as ordered task list', async function() {
|
it('as ordered task list', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile(`
|
const output = docsify.compiler.compile(`
|
||||||
1. [ ] Task 1
|
1. [ ] Task 1
|
||||||
2. [x] Task 2`)
|
2. [x] Task 2`)
|
||||||
@ -37,7 +37,7 @@ describe('render', function() {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('normal unordered', async function() {
|
it('normal unordered', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile(`
|
const output = docsify.compiler.compile(`
|
||||||
- [linktext](link)
|
- [linktext](link)
|
||||||
- just text`)
|
- just text`)
|
||||||
@ -48,7 +48,7 @@ describe('render', function() {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('unordered with custom start', async function() {
|
it('unordered with custom start', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile(`
|
const output = docsify.compiler.compile(`
|
||||||
1. first
|
1. first
|
||||||
2. second
|
2. second
|
||||||
@ -67,7 +67,7 @@ text
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('nested', async function() {
|
it('nested', async function() {
|
||||||
docsify = await init()
|
const {docsify, dom} = await init()
|
||||||
const output = docsify.compiler.compile(`
|
const output = docsify.compiler.compile(`
|
||||||
- 1
|
- 1
|
||||||
- 2
|
- 2
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user