refactor(core): adjust directory structure:

This commit is contained in:
qingwei.li 2017-02-16 23:37:39 +08:00 • committed by cinwell.li
commit aad62b65f5
20 changed files with 381 additions and 93 deletions

38
src/core/config.js Normal file
View file

@ -0,0 +1,38 @@
import { merge, camelize, isPrimitive } from './util/core'
const config = merge({
el: '#app',
repo: '',
maxLevel: 6,
subMaxLevel: 0,
loadSidebar: null,
loadNavbar: null,
homepage: 'README.md',
coverpage: '',
basePath: '',
auto2top: false,
name: '',
themeColor: '',
nameLink: window.location.pathname,
ga: ''
}, window.$docsify)
const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop()
if (script) {
for (const prop in config) {
const val = script.getAttribute('data-' + camelize(prop))
if (isPrimitive(val)) {
config[prop] = val === '' ? true : val
}
}
if (config.loadSidebar === true) config.loadSidebar = '_sidebar.md'
if (config.loadNavbar === true) config.loadNavbar = '_navbar.md'
if (config.coverpage === true) config.coverpage = '_coverpage.md'
if (config.repo === true) config.repo = ''
if (config.name === true) config.name = ''
}
export default config

11
src/core/event/index.js Normal file
View file

@ -0,0 +1,11 @@
export function eventMixin (Docsify) {
Docsify.prototype.$bindEvents = function () {
}
Docsify.prototype.$resetEvents = function () {
}
}
export function initEvent (vm) {
vm.$bindEvents()
}

37
src/core/fetch/ajax.js Normal file
View file

@ -0,0 +1,37 @@
import progressbar from '../render/progressbar'
import { noop } from '../util/core'
/**
* Simple ajax get
* @param {String} url
* @param {Boolean} [loading=false] has loading bar
* @return { then(resolve, reject), abort }
*/
export function get (url, hasLoading = false) {
const xhr = new XMLHttpRequest()
xhr.open('GET', url)
xhr.send()
return {
then: function (success, error = noop) {
const on = xhr.addEventListener
if (hasLoading) {
const id = setInterval(_ => progressbar({}), 500)
on('progress', progressbar)
on('loadend', evt => {
progressbar(evt)
clearInterval(id)
})
}
on('error', error)
on('load', ({ target }) => {
target.status >= 400 ? error(target) : success(target.response)
})
},
abort: () => xhr.readyState !== 4 && xhr.abort()
}
}

13
src/core/fetch/index.js Normal file
View file

@ -0,0 +1,13 @@
import { callHook } from '../init/lifecycle'
export function fetchMixin (Docsify) {
Docsify.prototype.$fetch = function () {
}
}
export function initFetch (vm) {
vm.$fetch(result => {
vm.$resetEvents()
callHook(vm, 'doneEach')
})
}

30
src/core/index.js Normal file
View file

@ -0,0 +1,30 @@
import { initMixin } from './init'
import { routeMixin } from './route'
import { renderMixin } from './render'
import { fetchMixin } from './fetch'
import { eventMixin } from './event'
import * as util from './util'
import { get as load } from './fetch/ajax'
import * as routeUtil from './route/util'
function Docsify () {
this._init()
}
initMixin(Docsify)
routeMixin(Docsify)
renderMixin(Docsify)
fetchMixin(Docsify)
eventMixin(Docsify)
/**
* Global API
*/
window.Docsify = {
util: util.merge({ load }, util, routeUtil)
}
/**
* Run Docsify
*/
setTimeout(() => new Docsify(), 0)

27
src/core/init/index.js Normal file
View file

@ -0,0 +1,27 @@
import config from '../config'
import { initLifecycle, callHook } from './lifecycle'
import { initRender } from '../render'
import { initRoute } from '../route'
import { initEvent } from '../event'
import { initFetch } from '../fetch'
import { isFn } from '../util/core'
export function initMixin (Docsify) {
Docsify.prototype._init = function () {
const vm = this
vm._config = config || {}
initLifecycle(vm) // Init hooks
initPlugin(vm) // Install plugins
callHook(vm, 'init')
initRender(vm) // Render base DOM
initEvent(vm) // Bind events
initRoute(vm) // Add hashchange eventListener
initFetch(vm) // Fetch data
callHook(vm, 'ready')
}
}
function initPlugin (vm) {
[].concat(vm.config.plugins).forEach(fn => isFn(fn) && fn(vm.bindHook))
}

View file

@ -0,0 +1,41 @@
import { noop } from '../util/core'
export function initLifecycle (vm) {
const hooks = ['init', 'beforeEach', 'afterEach', 'doneEach', 'ready']
vm._hooks = {}
vm.bindHook = {}
hooks.forEach(hook => {
const arr = vm._hooks[hook] = []
vm._bindHook[hook] = fn => arr.push(fn)
})
}
export function callHook (vm, hook, data, next = noop) {
let newData = data
const queue = vm._hooks[hook]
const step = function (index) {
const hook = queue[index]
if (index >= queue.length) {
next(newData)
} else {
if (typeof hook === 'function') {
if (hook.length === 2) {
hook(data, result => {
newData = result
step(index + 1)
})
} else {
const result = hook(data)
newData = result !== undefined ? result : newData
step(index + 1)
}
} else {
step(index + 1)
}
}
}
step(0)
}

12
src/core/render/dom.js Normal file
View file

@ -0,0 +1,12 @@
const cacheNode = {}
export function getCacheNode (el) {
if (typeof el === 'string') {
const selector = el
el = cacheNode[el] || document.querySelector(el)
if (!el) console.error('Cannot find element:', selector)
}
return el
}

9
src/core/render/index.js Normal file
View file

@ -0,0 +1,9 @@
export function renderMixin (Docsify) {
Docsify.prototype._renderTo = function (dom, content) {
}
}
export function initRender (vm) {
// init
}

View file

@ -0,0 +1,45 @@
import { isPrimitive } from '../util/core'
let loadingEl
let timeId
/**
* Init progress component
*/
function init () {
if (loadingEl) return
const div = document.createElement('div')
div.classList.add('progress')
document.body.appendChild(div)
loadingEl = div
}
/**
* Render progress bar
*/
export default function ({ loaded, total, step }) {
let num
loadingEl = init()
if (!isPrimitive(step)) {
step = Math.floor(Math.random() * 5 + 1)
}
if (step) {
num = parseInt(loadingEl.style.width, 10) + step
num = num > 80 ? 80 : num
} else {
num = Math.floor(loaded / total * 100)
}
loadingEl.style.opacity = 1
loadingEl.style.width = num >= 95 ? '100%' : num + '%'
if (num >= 95) {
clearTimeout(timeId)
timeId = setTimeout(_ => {
loadingEl.style.opacity = 0
loadingEl.style.width = '0%'
}, 200)
}
}

81
src/core/render/tpl.js Normal file
View file

@ -0,0 +1,81 @@
import { isMobile } from '../util/core'
/**
* Render github corner
* @param {Object} data
* @return {String}
*/
export function corner (data) {
if (!data) return ''
if (!/\/\//.test(data)) data = 'https://github.com/' + data
data = data.replace(/^git\+/, '')
return `
<a href="${data}" class="github-corner" aria-label="View source on Github">
<svg viewBox="0 0 250 250" aria-hidden="true">
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
</svg>
</a>`
}
/**
* Render main content
*/
export function main () {
const aside = `${toggle()}<aside class="sidebar"><div class="sidebar-nav"></div></aside>`
return (isMobile() ? `${aside}<main>` : `<main>${aside}`) +
`<section class="content">
<article class="markdown-section"></article>
</section>
</main>`
}
/**
* Cover Page
*/
export function cover () {
const SL = ', 100%, 85%'
const bgc = `linear-gradient(to left bottom, hsl(${Math.floor(Math.random() * 255) + SL}) 0%, hsl(${Math.floor(Math.random() * 255) + SL}) 100%)`
return `<section class="cover" style="background: ${bgc}">
<div class="cover-main"></div>
<div class="mask"></div>
</section>`
}
export function toggle () {
return `<button class="sidebar-toggle">
<div class="sidebar-toggle-button">
<span></span><span></span><span></span>
</div>
</button>`
}
/**
* Render tree
* @param {Array} tree
* @param {String} tpl
* @return {String}
*/
export function tree (toc, tpl = '') {
if (!toc || !toc.length) return ''
toc.forEach(node => {
tpl += `<li><a class="section-link" href="${node.slug}">${node.title}</a></li>`
if (node.children) {
tpl += `<li><ul class="children">${tree(node.children)}</li></ul>`
}
})
return tpl
}
export function helper (className, content) {
return `<p class="${className}">${content.slice(5).trim()}</p>`
}
export function theme (color) {
return `<style>:root{--theme-color: ${color};}</style>`
}

24
src/core/route/hash.js Normal file
View file

@ -0,0 +1,24 @@
import { cleanPath, getLocation } from './util'
export function ensureSlash () {
const path = getHash()
if (path.charAt(0) === '/') return
replaceHash('/' + path)
}
export function getHash () {
// We can't use window.location.hash here because it's not
// consistent across browsers - Firefox will pre-decode it!
const href = window.location.href
const index = href.indexOf('#')
return index === -1 ? '' : href.slice(index + 1)
}
function replaceHash (path) {
const i = window.location.href.indexOf('#')
window.location.replace(
window.location.href.slice(0, i >= 0 ? i : 0) + '#' + path
)
}
// TODO 把第二个 hash 转成 ?id=

17
src/core/route/index.js Normal file
View file

@ -0,0 +1,17 @@
import { ensureSlash } from './hash'
export function routeMixin (Docsify) {
Docsify.prototype.$route = {
query: location.query || {},
path: location.path || '/',
base: ''
}
}
export function initRoute (vm) {
ensureSlash()
window.addEventListener('hashchange', () => {
ensureSlash()
vm.$fetch()
})
}

11
src/core/route/util.js Normal file
View file

@ -0,0 +1,11 @@
export function cleanPath (path) {
return path.replace(/\/+/g, '/')
}
export function getLocation (base) {
let path = window.location.pathname
if (base && path.indexOf(base) === 0) {
path = path.slice(base.length)
}
return (path || '/') + window.location.search + window.location.hash
}

56
src/core/util/core.js Normal file
View file

@ -0,0 +1,56 @@
/**
* Create a cached version of a pure function.
*/
function cached (fn) {
const cache = Object.create(null)
return function cachedFn (str) {
const hit = cache[str]
return hit || (cache[str] = fn(str))
}
}
/**
* Camelize a hyphen-delimited string.
*/
const camelizeRE = /-(\w)/g
export const camelize = cached((str) => {
return str.replace(camelizeRE, (_, c) => c ? c.toUpperCase() : '')
})
/**
* Simple Object.assign polyfill
*/
export const merge = Object.assign || function (to) {
const hasOwn = Object.prototype.hasOwnProperty
for (let i = 1; i < arguments.length; i++) {
const from = Object(arguments[i])
for (const key in from) {
if (hasOwn.call(from, key)) {
to[key] = from[key]
}
}
}
return to
}
/**
* Check if value is primitive
*/
export function isPrimitive (value) {
return typeof value === 'string' || typeof value === 'number'
}
/**
* Perform no operation.
*/
export function noop () {}
/**
* Check if value is function
*/
export function isFn (obj) {
return typeof obj === 'function'
}

5
src/core/util/env.js Normal file
View file

@ -0,0 +1,5 @@
export const UA = window.navigator.userAgent.toLowerCase()
export const isIE = UA && /msie|trident/.test(UA)
export const isMobile = document.body.clientWidth <= 600

2
src/core/util/index.js Normal file
View file

@ -0,0 +1,2 @@
export * from './core'
export * from './env'

View file

@ -0,0 +1,30 @@
import { get } from '../fetch/ajax'
function replaceVar (block) {
block.innerHTML = block.innerHTML.replace(/var\(\s*--theme-color.*?\)/g, $docsify.themeColor)
}
export function cssVars () {
// variable support
if (window.CSS && window.CSS.supports && window.CSS.supports('(--foo: red)')) return
const styleBlocks = document.querySelectorAll('style:not(.inserted),link')
;[].forEach.call(styleBlocks, block => {
if (block.nodeName === 'STYLE') {
replaceVar(block)
} else if (block.nodeName === 'LINK') {
const href = block.getAttribute('href')
if (!/\.css$/.test(href)) return
get(href).then(res => {
const style = document.createElement('style')
style.innerHTML = res
document.head.appendChild(style)
replaceVar(style)
})
}
})
}