Merge pull request #2 from monsat/fix-vuepress-update

Update for VuePress 2.0.0-beta.40

README.md

@@ -21,10 +21,20 @@ $ yarn add -D vuepress-plugin-use-pages
 
 Add `vuepress-plugin-use-pages` in your config file.
 
+> Since version 1.0.5 is for VuePress 2.0.0-beta.40 or later.
+> Usage of plugins is changed.
+
 ```ts:docs/.vuepress/config.ts
+import { defineUserConfig } from 'vuepress'
+import { viteBundler } from 'vuepress'
+import { usePagesPlugin } from 'vuepress-plugin-use-pages'
+
+export default defineUserConfig({
+  bundler: viteBundler(),
   plugins: [
-    ['vuepress-plugin-use-pages'],
+    usePagesPlugin(),
   ],
+})
 ```
 
 in your doc file or component.
@@ -62,13 +72,13 @@ export default defineComponent({
 
 ```ts:docs/.vuepress/config.ts
   plugins: [
-    ['vuepress-plugin-use-pages', {
+    usePagesPlugin({
       startsWith: '/articles/',                   // fetch only matched paths
       filter: (page) => page.data.lang === 'ja',  // fetch only filtered pages
       sort: (a, b) => b.data.git.updatedTime - a.data.git.updatedTime
       limit: 30,                                  // maximum cached size
       file: 'articles.js',                        // temp file name
-    }],
+    }),
   ],
 ```
 
@@ -110,9 +120,9 @@ This plugin is usable for multiple times.
 
 ```ts:docs/.vuepress/config.ts
   plugins: [
-    ['vuepress-plugin-use-pages', { startsWith: '/articles/', file: 'articles.js' }],
-    ['vuepress-plugin-use-pages', { startsWith: '/posts/', file: 'posts.js' }],
-    ['vuepress-plugin-use-pages', { startsWith: '/pages/', file: 'pages.js' }],
+    usePagesPlugin({ startsWith: '/articles/', file: 'articles.js' }),
+    usePagesPlugin({ startsWith: '/posts/', file: 'posts.js' }),
+    usePagesPlugin({ startsWith: '/pages/', file: 'pages.js' }),
   ],
 ```
 

package.json

@@ -12,7 +12,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "@vuepress/core": "^2.0.0-beta.27"
+    "@vuepress/core": "^2.0.0-beta.48"
   },
   "devDependencies": {
     "typescript": "^4.4.4"

src/node/index.ts

@@ -1,46 +1,5 @@
-import type { Plugin, PluginObject, Page } from '@vuepress/core'
+import { usePagesPlugin } from './usePagesPlugin'
 
-export interface UsePagesPluginOptions {
-  startsWith?: string
-  filter?: (page: Page) => boolean
-  sort?: (a: Page, b: Page) => number
-  limit?: number | false
-  file?: string
-}
-
-const usePagesPlugin: Plugin = (options, app): PluginObject => {
-  const name = 'vuepress-plugin-use-pages'
-  const multiple = true
-
-  const onInitialized = () => {
-    const defaultSort = (a: Page, b: Page) => {
-      if (!a.data.frontmatter.date || !b.data.frontmatter.date) {
-        return 0
-      }
-      return (new Date(b.data.frontmatter.date).getTime()) - (new Date(a.data.frontmatter.date).getTime())
-    }
-    const {
-      startsWith = '/articles/',
-      filter,
-      sort = defaultSort,
-      limit = false,
-      file = 'pages.js',
-    }: UsePagesPluginOptions = options || {}
-
-    const docs = app.pages.filter(p => p.data.path.startsWith(startsWith))
-    const filtered = filter ? docs.filter(filter) : docs
-    filtered.sort(sort)   // Sorted in place
-    const limited = limit ? filtered.slice(0, limit) : filtered
-    const pageData = limited.map(p => p.data)
-    const content = `export const usePages = () => ${JSON.stringify(pageData)}`
-    app.writeTemp(file, content)
-  }
-
-  return {
-    name,
-    multiple,
-    onInitialized,
-  }
-}
+export * from './usePagesPlugin'
 
 export default usePagesPlugin

src/node/usePagesPlugin.ts

@@ -0,0 +1,44 @@
+import type { Page, PluginObject } from '@vuepress/core'
+
+export interface UsePagesPluginOptions {
+  startsWith?: string
+  filter?: (page: Page) => boolean
+  sort?: (a: Page, b: Page) => number
+  limit?: number | false
+  file?: string
+}
+
+export const usePagesPlugin = (options?: UsePagesPluginOptions): PluginObject => {
+  const name = 'vuepress-plugin-use-pages'
+  const multiple = true
+
+  const onPrepared: PluginObject['onPrepared'] = (app) => {
+    const defaultSort = (a: Page, b: Page) => {
+      if (!a.data.frontmatter.date || !b.data.frontmatter.date) {
+        return 0
+      }
+      return (new Date(b.data.frontmatter.date).getTime()) - (new Date(a.data.frontmatter.date).getTime())
+    }
+    const {
+      startsWith = '/articles/',
+      filter,
+      sort = defaultSort,
+      limit = false,
+      file = 'pages.js',
+    }: UsePagesPluginOptions = options || {}
+
+    const docs = app.pages.filter(p => p.data.path.startsWith(startsWith))
+    const filtered = filter ? docs.filter(filter) : docs
+    filtered.sort(sort)   // Sorted in place
+    const limited = limit ? filtered.slice(0, limit) : filtered
+    const pageData = limited.map(p => p.data)
+    const content = `export const usePages = () => ${JSON.stringify(pageData)}`
+    app.writeTemp(file, content)
+  }
+
+  return {
+    name,
+    multiple,
+    onPrepared,
+  }
+}