refactor(core): remove permalink and pattern from page options

BREAKING CHANGE: remove permalink and pattern from page options

Author: meteorlxy

packages/@vuepress/core/__tests__/page/resolvePagePermalink.spec.ts

@@ -3,7 +3,6 @@ import { resolvePagePermalink } from '@vuepress/core'
 describe('core > page > resolvePagePermalink', () => {
   it('should return null', () => {
     const resolved = resolvePagePermalink({
-      options: {},
       frontmatter: {},
       slug: '',
       date: '',
@@ -17,7 +16,6 @@ describe('core > page > resolvePagePermalink', () => {
   describe('use permalink or pattern', () => {
     it('should use permalink in frontmatter', () => {
       const resolved = resolvePagePermalink({
-        options: {},
         frontmatter: {
           permalink: '/frontmatter',
         },
@@ -30,24 +28,8 @@ describe('core > page > resolvePagePermalink', () => {
       expect(resolved).toBe('/frontmatter')
     })
 
-    it('should use permalink in options', () => {
-      const resolved = resolvePagePermalink({
-        options: {
-          permalink: '/options',
-        },
-        frontmatter: {},
-        slug: '',
-        date: '',
-        pathInferred: null,
-        pathLocale: '',
-      })
-
-      expect(resolved).toBe('/options')
-    })
-
     it('should use permalinkPattern in frontmatter', () => {
       const resolved = resolvePagePermalink({
-        options: {},
         frontmatter: {
           permalinkPattern: '/:year/:month/:day/:slug/frontmatter',
         },
@@ -59,30 +41,14 @@ describe('core > page > resolvePagePermalink', () => {
 
       expect(resolved).toBe('/2020/10/07/foo-bar/frontmatter')
     })
-
-    it('should use permalinkPattern in options', () => {
-      const resolved = resolvePagePermalink({
-        options: {
-          permalinkPattern: '/:year/:month/:day/:slug/options',
-        },
-        frontmatter: {},
-        slug: 'foo-bar',
-        date: '2020-10-07',
-        pathInferred: null,
-        pathLocale: '',
-      })
-
-      expect(resolved).toBe('/2020/10/07/foo-bar/options')
-    })
   })
 
   describe('permalink pattern', () => {
     it('should replace :raw with empty string 1', () => {
       const resolved = resolvePagePermalink({
-        options: {
+        frontmatter: {
           permalinkPattern: '/:year/:month/:day/:slug/:raw',
         },
-        frontmatter: {},
         slug: 'foo-bar',
         date: '2020-10-07',
         pathInferred: null,
@@ -94,10 +60,9 @@ describe('core > page > resolvePagePermalink', () => {
 
     it('should replace :raw with empty string 2', () => {
       const resolved = resolvePagePermalink({
-        options: {
+        frontmatter: {
           permalinkPattern: '/:year/:month/:day/:slug/:raw',
         },
-        frontmatter: {},
         slug: 'foo-bar',
         date: '2020-10-07',
         pathInferred: '',
@@ -109,10 +74,9 @@ describe('core > page > resolvePagePermalink', () => {
 
     it('should replace :raw with empty string 3', () => {
       const resolved = resolvePagePermalink({
-        options: {
+        frontmatter: {
           permalinkPattern: '/:year/:month/:day/:slug/:raw',
         },
-        frontmatter: {},
         slug: 'foo-bar',
         date: '2020-10-07',
         pathInferred: '/',
@@ -124,10 +88,9 @@ describe('core > page > resolvePagePermalink', () => {
 
     it('should prefix with locale path', () => {
       const resolved = resolvePagePermalink({
-        options: {
+        frontmatter: {
           permalinkPattern: '/:year/:month/:day/:slug/:raw',
         },
-        frontmatter: {},
         slug: 'foo-bar',
         date: '2020-10-07',
         pathInferred: '/raw.html',

packages/@vuepress/core/src/page/createPage.ts

@@ -54,7 +54,6 @@ export const createPage = async (
 
   // resolve page permalink
   const permalink = resolvePagePermalink({
-    options,
     frontmatter,
     slug,
     date,

packages/@vuepress/core/src/page/resolvePagePermalink.ts

@@ -1,19 +1,17 @@
 import { ensureLeadingSlash, isString } from '@vuepress/shared'
 import { path } from '@vuepress/utils'
-import type { PageOptions, PageFrontmatter } from '../types'
+import type { PageFrontmatter } from '../types'
 
 /**
  * Resolve page permalink from frontmatter / options / pattern
  */
 export const resolvePagePermalink = ({
-  options,
   frontmatter,
   slug,
   date,
   pathInferred,
   pathLocale,
 }: {
-  options: PageOptions
   frontmatter: PageFrontmatter
   slug: string
   date: string
@@ -25,15 +23,10 @@ export const resolvePagePermalink = ({
     return frontmatter.permalink
   }
 
-  // use permalink in options directly
-  if (options.permalink) {
-    return options.permalink
-  }
-
   // get permalink pattern from frontmatter or options
   const pattern = isString(frontmatter.permalinkPattern)
     ? frontmatter.permalinkPattern
-    : options.permalinkPattern
+    : null
 
   if (!pattern) {
     return null

packages/@vuepress/core/src/types/page.ts

@@ -113,6 +113,4 @@ export interface PageOptions {
   filePath?: string
   frontmatter?: PageFrontmatter
   content?: string
-  permalink?: string
-  permalinkPattern?: string
 }