chore: deprecation warnings

pull/317/head
Evan You 4 years ago
parent aaf4910d93
commit f5d0e1881c

@ -38,6 +38,10 @@ export interface UserConfig<ThemeConfig = any> {
* @deprecated use `srcExclude` instead * @deprecated use `srcExclude` instead
*/ */
exclude?: string[] exclude?: string[]
/**
* @deprecated use `vue` instead
*/
vueOptions?: VuePluginOptions
} }
export interface SiteConfig<ThemeConfig = any> { export interface SiteConfig<ThemeConfig = any> {
@ -62,6 +66,20 @@ export async function resolveConfig(
root: string = process.cwd() root: string = process.cwd()
): Promise<SiteConfig> { ): Promise<SiteConfig> {
const userConfig = await resolveUserConfig(root) const userConfig = await resolveUserConfig(root)
if (userConfig.vueOptions) {
console.warn(
chalk.yellow(`[vitepress] "vueOptions" option has been renamed to "vue".`)
)
}
if (userConfig.exclude) {
console.warn(
chalk.yellow(
`[vitepress] "exclude" option has been renamed to "ssrExclude".`
)
)
}
const site = await resolveSiteData(root, userConfig) const site = await resolveSiteData(root, userConfig)
const srcDir = path.resolve(root, userConfig.srcDir || '.') const srcDir = path.resolve(root, userConfig.srcDir || '.')
@ -79,10 +97,7 @@ export async function resolveConfig(
themeDir, themeDir,
pages: await globby(['**.md'], { pages: await globby(['**.md'], {
cwd: srcDir, cwd: srcDir,
ignore: [ ignore: ['**/node_modules', ...(userConfig.srcExclude || [])]
'**/node_modules',
...(userConfig.srcExclude || userConfig.exclude || [])
]
}), }),
configPath: resolve(root, 'config.js'), configPath: resolve(root, 'config.js'),
outDir: resolve(root, 'dist'), outDir: resolve(root, 'dist'),

Loading…
Cancel
Save