From e0d8ed1ed219ec51ae009734cdf9c1bef54e0f4c Mon Sep 17 00:00:00 2001 From: Mathieu TUDISCO Date: Mon, 11 Mar 2019 18:46:30 +0100 Subject: [PATCH 1/3] refactor(default-theme): Extract PageEdit component. --- .../theme-default/components/Page.vue | 131 +---------------- .../theme-default/components/PageEdit.vue | 137 ++++++++++++++++++ 2 files changed, 141 insertions(+), 127 deletions(-) create mode 100644 packages/@vuepress/theme-default/components/PageEdit.vue diff --git a/packages/@vuepress/theme-default/components/Page.vue b/packages/@vuepress/theme-default/components/Page.vue index 29214521fc..94a0203e16 100644 --- a/packages/@vuepress/theme-default/components/Page.vue +++ b/packages/@vuepress/theme-default/components/Page.vue @@ -4,27 +4,7 @@ - +

@@ -62,26 +42,14 @@ + From ec64dac02412189a05fb18d276b25b3707944658 Mon Sep 17 00:00:00 2001 From: Mathieu TUDISCO Date: Mon, 11 Mar 2019 19:01:27 +0100 Subject: [PATCH 2/3] refactor(default-theme): Extract PageNav component. --- .../theme-default/components/Page.vue | 110 +----------------- .../theme-default/components/PageNav.vue | 109 +++++++++++++++++ 2 files changed, 114 insertions(+), 105 deletions(-) create mode 100644 packages/@vuepress/theme-default/components/PageNav.vue diff --git a/packages/@vuepress/theme-default/components/Page.vue b/packages/@vuepress/theme-default/components/Page.vue index 94a0203e16..a0ce695fec 100644 --- a/packages/@vuepress/theme-default/components/Page.vue +++ b/packages/@vuepress/theme-default/components/Page.vue @@ -3,125 +3,25 @@ - - -

-

- - ← - - {{ prev.title || prev.path }} - - - - - - {{ next.title || next.path }} - - → - -

-
+ diff --git a/packages/@vuepress/theme-default/components/PageNav.vue b/packages/@vuepress/theme-default/components/PageNav.vue new file mode 100644 index 0000000000..699adfcf63 --- /dev/null +++ b/packages/@vuepress/theme-default/components/PageNav.vue @@ -0,0 +1,109 @@ + + + From c4eca66d7da136fecf69dc9a6ca1640bbe5c502f Mon Sep 17 00:00:00 2001 From: Shigma <1700011071@pku.edu.cn> Date: Wed, 13 Mar 2019 16:10:40 +0800 Subject: [PATCH 3/3] Merge branch 'master' into pr/1427 --- packages/@vuepress/core/lib/node/Page.js | 16 +++++----- .../core/lib/node/plugin-api/index.js | 6 ++-- .../core/lib/node/plugin-api/util.js | 31 ------------------ packages/@vuepress/markdown/index.js | 19 ++++++++++- packages/@vuepress/plugin-blog/index.js | 11 +++---- .../plugin-register-components/index.js | 10 +++--- packages/@vuepress/shared-utils/src/index.ts | 2 ++ .../shared-utils/src/moduleResolver.ts | 14 ++++++-- .../shared-utils/src/normalizeConfig.ts | 28 ++++++++++++++++ .../theme-default/components/PageEdit.vue | 28 +++++++--------- packages/docs/docs/config/README.md | 32 +++++++++++++++++++ .../official/plugin-register-components.md | 7 ++++ packages/docs/docs/zh/config/README.md | 32 +++++++++++++++++++ .../official/plugin-register-components.md | 7 ++++ 14 files changed, 168 insertions(+), 75 deletions(-) create mode 100644 packages/@vuepress/shared-utils/src/normalizeConfig.ts diff --git a/packages/@vuepress/core/lib/node/Page.js b/packages/@vuepress/core/lib/node/Page.js index e04bd50f72..db3a6af2d8 100644 --- a/packages/@vuepress/core/lib/node/Page.js +++ b/packages/@vuepress/core/lib/node/Page.js @@ -37,7 +37,7 @@ module.exports = class Page { */ constructor ({ - path, + path: _path, meta, title, content, @@ -58,12 +58,16 @@ module.exports = class Page { if (relative) { this.regularPath = encodeURI(fileToPath(relative)) - } else if (path) { - this.regularPath = encodeURI(path) + } else if (_path) { + this.regularPath = encodeURI(_path) } else if (permalink) { this.regularPath = encodeURI(permalink) } + if (filePath) { + this.relativePath = path.relative(context.sourceDir, filePath).replace(/\\/g, '/') + } + this.key = 'v-' + hash(`${this._filePath}${this.regularPath}`) // Using regularPath first, would be override by permalink later. this.path = this.regularPath @@ -85,11 +89,7 @@ module.exports = class Page { enhancers = [], preRender = {} }) { - // relative path - let relPath - if (this._filePath) { - relPath = path.relative(this._context.sourceDir, this._filePath) logger.developer(`static_route`, chalk.cyan(this.path)) this._content = await fs.readFile(this._filePath, 'utf-8') } else if (this._content) { @@ -124,7 +124,7 @@ module.exports = class Page { if (excerpt) { const { html } = markdown.render(excerpt, { frontmatter: this.frontmatter, - relPath + relPath: this.relativePath }) this.excerpt = html } diff --git a/packages/@vuepress/core/lib/node/plugin-api/index.js b/packages/@vuepress/core/lib/node/plugin-api/index.js index 1606286f46..6dc8a9e3fd 100644 --- a/packages/@vuepress/core/lib/node/plugin-api/index.js +++ b/packages/@vuepress/core/lib/node/plugin-api/index.js @@ -5,12 +5,12 @@ */ const instantiateOption = require('./override/instantiateOption') -const { flattenPlugin, normalizePluginsConfig } = require('./util') +const { flattenPlugin } = require('./util') const { PLUGIN_OPTION_MAP } = require('./constants') const { moduleResolver: { getPluginResolver }, datatypes: { assertTypes, isPlainObject }, - logger, chalk + logger, chalk, normalizeConfig } = require('@vuepress/shared-utils') /** @@ -136,7 +136,7 @@ module.exports = class PluginAPI { */ useByPluginsConfig (pluginsConfig) { - pluginsConfig = normalizePluginsConfig(pluginsConfig) + pluginsConfig = normalizeConfig(pluginsConfig) pluginsConfig.forEach(([pluginRaw, pluginOptions]) => { this.use(pluginRaw, pluginOptions) }) diff --git a/packages/@vuepress/core/lib/node/plugin-api/util.js b/packages/@vuepress/core/lib/node/plugin-api/util.js index 706da428a5..af2ede4440 100644 --- a/packages/@vuepress/core/lib/node/plugin-api/util.js +++ b/packages/@vuepress/core/lib/node/plugin-api/util.js @@ -57,34 +57,3 @@ exports.flattenPlugin = function ( $$options: pluginOptions /* used for test */ }) } - -/** - * Normalize plugins config in `.vuepress/config.js` - * - * @param pluginsConfig - */ - -exports.normalizePluginsConfig = function (pluginsConfig) { - const { valid, warnMsg } = assertTypes(pluginsConfig, [Object, Array]) - if (!valid) { - if (pluginsConfig !== undefined) { - logger.warn( - `[${chalk.gray('config')}] ` - + `Invalid value for "plugin" field : ${warnMsg}` - ) - } - pluginsConfig = [] - return pluginsConfig - } - - if (Array.isArray(pluginsConfig)) { - pluginsConfig = pluginsConfig.map(item => { - return Array.isArray(item) ? item : [item] - }) - } else if (typeof pluginsConfig === 'object') { - pluginsConfig = Object.keys(pluginsConfig).map(item => { - return [item, pluginsConfig[item]] - }) - } - return pluginsConfig -} diff --git a/packages/@vuepress/markdown/index.js b/packages/@vuepress/markdown/index.js index dd5271d9fb..fdb0481fbe 100644 --- a/packages/@vuepress/markdown/index.js +++ b/packages/@vuepress/markdown/index.js @@ -18,7 +18,11 @@ const snippetPlugin = require('./lib/snippet') const tocPlugin = require('./lib/tableOfContents') const emojiPlugin = require('markdown-it-emoji') const anchorPlugin = require('markdown-it-anchor') -const { slugify: _slugify, logger, chalk, hash } = require('@vuepress/shared-utils') +const { + slugify: _slugify, + logger, chalk, hash, normalizeConfig, + moduleResolver: { getMarkdownItResolver } +} = require('@vuepress/shared-utils') /** * Create markdown by config. @@ -29,11 +33,14 @@ module.exports = (markdown = {}) => { externalLinks, anchor, toc, + plugins, lineNumbers, beforeInstantiate, afterInstantiate } = markdown + const resolver = getMarkdownItResolver() + // allow user config slugify const slugify = markdown.slugify || _slugify @@ -100,6 +107,16 @@ module.exports = (markdown = {}) => { const md = config.toMd(require('markdown-it'), markdown) + const pluginsConfig = normalizeConfig(plugins || []) + pluginsConfig.forEach(([pluginRaw, pluginOptions]) => { + const plugin = resolver.resolve(pluginRaw) + if (plugin.entry) { + md.use(plugin.entry, pluginOptions) + } else { + // TODO: error handling + } + }) + afterInstantiate && afterInstantiate(md) // override parse to allow cache diff --git a/packages/@vuepress/plugin-blog/index.js b/packages/@vuepress/plugin-blog/index.js index 697c33fc82..c2c8b453fd 100644 --- a/packages/@vuepress/plugin-blog/index.js +++ b/packages/@vuepress/plugin-blog/index.js @@ -20,7 +20,7 @@ module.exports = (options, ctx) => { frontmatter: { layout: getLayout('Categories', 'Page') } }, { - when: ({ regularPath }) => regularPath.startsWith('/category/'), + when: ({ regularPath }) => regularPath.startsWith(categoryIndexPageUrl), frontmatter: { layout: getLayout('Category', 'Page') } }, { @@ -28,7 +28,7 @@ module.exports = (options, ctx) => { frontmatter: { layout: getLayout('Tags', 'Page') } }, { - when: ({ regularPath }) => regularPath.startsWith('/tag/'), + when: ({ regularPath }) => regularPath.startsWith(tagIndexPageUrl), frontmatter: { layout: getLayout('Tag', 'Page') } }, { @@ -86,15 +86,14 @@ module.exports = (options, ctx) => { if (key) { if (!map[key]) { map[key] = {} - map[key].path = `/${scope}/${key}.html` + map[key].path = `${scope}${key}.html` map[key].pageKeys = [] } map[key].pageKeys.push(pageKey) } } - - const handleTag = curryHandler('tag', tagMap) - const handleCategory = curryHandler('category', categoryMap) + const handleTag = curryHandler(tagIndexPageUrl, tagMap) + const handleCategory = curryHandler(categoryIndexPageUrl, categoryMap) pages.forEach(({ key, diff --git a/packages/@vuepress/plugin-register-components/index.js b/packages/@vuepress/plugin-register-components/index.js index d5927f3f85..2def3e73fe 100644 --- a/packages/@vuepress/plugin-register-components/index.js +++ b/packages/@vuepress/plugin-register-components/index.js @@ -1,16 +1,14 @@ const { fs, path, globby, datatypes: { isString }} = require('@vuepress/shared-utils') function fileToComponentName (file) { - return file - .replace(/\/|\\/g, '-') - .replace(/\.vue$/, '') + return file.replace(/\/|\\/g, '-') } async function resolveComponents (componentDir) { if (!fs.existsSync(componentDir)) { return } - return (await globby(['**/*.vue'], { cwd: componentDir })) + return (await globby(['**/*.vue'], { cwd: componentDir })).map(file => file.slice(0, -4)) } // Since this plugin can ben used by multiple times, we need to @@ -22,7 +20,7 @@ module.exports = (options, context) => ({ multiple: true, async enhanceAppFiles () { - const { componentsDir = [], components = [] } = options + const { componentsDir = [], components = [], getComponentName = fileToComponentName } = options const baseDirs = Array.isArray(componentsDir) ? componentsDir : [componentsDir] function importCode (name, absolutePath) { @@ -30,7 +28,7 @@ module.exports = (options, context) => ({ } function genImport (baseDir, file) { - const name = fileToComponentName(file) + const name = getComponentName(file) const absolutePath = path.resolve(baseDir, file) const code = importCode(name, absolutePath) return code diff --git a/packages/@vuepress/shared-utils/src/index.ts b/packages/@vuepress/shared-utils/src/index.ts index 689300274e..ade68a6ed2 100644 --- a/packages/@vuepress/shared-utils/src/index.ts +++ b/packages/@vuepress/shared-utils/src/index.ts @@ -14,6 +14,7 @@ import * as isIndexFile from './isIndexFile' import logger from './logger' import * as moduleLoader from './moduleLoader' import * as moduleResolver from './moduleResolver' +import normalizeConfig from './normalizeConfig' import * as parseEmojis from './parseEmojis' import parseFrontmatter from './parseFrontmatter' import parseHeaders from './parseHeaders' @@ -50,6 +51,7 @@ export { logger, moduleLoader, moduleResolver, + normalizeConfig, parseEmojis, parseFrontmatter, parseHeaders, diff --git a/packages/@vuepress/shared-utils/src/moduleResolver.ts b/packages/@vuepress/shared-utils/src/moduleResolver.ts index ecab531b3f..93ab58cde4 100644 --- a/packages/@vuepress/shared-utils/src/moduleResolver.ts +++ b/packages/@vuepress/shared-utils/src/moduleResolver.ts @@ -76,8 +76,12 @@ class ModuleResolver { this.allowedTypes = allowedTypes this.load = load this.cwd = cwd || process.cwd() - this.nonScopePrefix = `${org}-${type}-` - this.scopePrefix = `@${org}/${type}-` + if (org) { + this.nonScopePrefix = `${org}-${type}-` + this.scopePrefix = `@${org}/${type}-` + } else { + this.nonScopePrefix = `${type}-` + } this.typePrefixLength = type.length + 1 /* - */ this.prefixSlicePosition = this.typePrefixLength + org.length + 1 @@ -197,7 +201,7 @@ class ModuleResolver { const pkg = resolveScopePackage(req) if (pkg) { // speicial handling for default org. - if (pkg.org === this.org) { + if (this.org && pkg.org === this.org) { shortcut = pkg.name.startsWith(`${this.type}-`) ? pkg.name.slice(this.typePrefixLength) : pkg.name @@ -265,6 +269,10 @@ export function resolveScopePackage (name: string) { } } +export const getMarkdownItResolver = (cwd: string) => new ModuleResolver( + 'markdown-it', '', [String, Function], true /* load module */, cwd +) + export const getPluginResolver = (cwd: string): ModuleResolver => new ModuleResolver( 'plugin', 'vuepress', [String, Function, Object], true /* load module */, cwd ) diff --git a/packages/@vuepress/shared-utils/src/normalizeConfig.ts b/packages/@vuepress/shared-utils/src/normalizeConfig.ts new file mode 100644 index 0000000000..4c9a8c41b0 --- /dev/null +++ b/packages/@vuepress/shared-utils/src/normalizeConfig.ts @@ -0,0 +1,28 @@ +import { assertTypes } from './datatypes' +import logger from './logger' +import chalk from 'chalk' + +export default function normalizeConfig (pluginsConfig: any) { + const { valid, warnMsg } = assertTypes(pluginsConfig, [Object, Array]) + if (!valid) { + if (pluginsConfig !== undefined) { + logger.warn( + `[${chalk.gray('config')}] ` + + `Invalid value for "plugin" field : ${warnMsg}` + ) + } + pluginsConfig = [] + return pluginsConfig + } + + if (Array.isArray(pluginsConfig)) { + pluginsConfig = pluginsConfig.map(item => { + return Array.isArray(item) ? item : [item] + }) + } else if (typeof pluginsConfig === 'object') { + pluginsConfig = Object.keys(pluginsConfig).map(item => { + return [item, pluginsConfig[item]] + }) + } + return pluginsConfig +} diff --git a/packages/@vuepress/theme-default/components/PageEdit.vue b/packages/@vuepress/theme-default/components/PageEdit.vue index 5a23a023e8..a5bb1f9c93 100644 --- a/packages/@vuepress/theme-default/components/PageEdit.vue +++ b/packages/@vuepress/theme-default/components/PageEdit.vue @@ -22,7 +22,7 @@