[pull] master from vuejs:master

.all-contributorsrc

@@ -19,17 +19,6 @@
         "code"
       ]
     },
-    {
-      "login": "bencodezen",
-      "name": "Ben Hong",
-      "avatar_url": "https://avatars0.githubusercontent.com/u/4836334?v=4",
-      "profile": "http://www.bencodezen.io",
-      "contributions": [
-        "code",
-        "doc",
-        "question"
-      ]
-    },
     {
       "login": "meteorlxy",
       "name": "meteorlxy",
@@ -49,7 +38,7 @@
         "doc"
       ]
     },
-        {
+    {
       "login": "kefranabg",
       "name": "Franck Abgrall",
       "avatar_url": "https://avatars3.githubusercontent.com/u/9840435?v=4",

.commitlintrc.js

@@ -1,7 +1,14 @@
 const fs = require('fs')
 const path = require('path')
 
-const VuepressPackages = fs.readdirSync(path.resolve(__dirname, 'packages/@vuepress'))
+const vuepressPackages = fs.readdirSync(path.resolve(__dirname, 'packages/@vuepress'))
+const availableScopes = [
+  'all',
+  'cli',
+  'zh',
+  'types',
+  ...vuepressPackages
+]
 
 module.exports = {
   extends: [
@@ -12,10 +19,9 @@ module.exports = {
       2,
       'always',
       [
-        'cli',
-        'zh',
-        ...VuepressPackages
-      ].map(name => `$${name}`)
+        ...availableScopes,
+        ...availableScopes.map(name => `$${name}`)
+      ]
     ]
   }
 }

.eslintignore

@@ -4,3 +4,4 @@
 !.vuepress
 packages/@vuepress/shared-utils/lib
 packages/@vuepress/shared-utils/types
+packages/@vuepress/types

.github/workflows/pull-request-ci.yml

@@ -7,20 +7,19 @@ jobs:
   pr:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
         with:
-          node-version: '12'
+          node-version: '14'
+          check-latest: true
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
-      - uses: actions/cache@v1
+
+      - uses: actions/cache@v2
         with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-node-modules-${{ hashFiles('yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-node-modules-
-            ${{ runner.os }}-
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
 
       - name: Install dependencies
         if: steps.yarn-cache.outputs.cache-hit != 'true'

.gitignore

@@ -11,7 +11,6 @@ node_modules
 TODOs.md
 
 # Editors
-.vscode
 .idea
 
 # VuePress temp directory

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "amour1688.ts-in-markdown",
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,48 @@
+{
+    "eslint.validate": [
+      "javascript",
+      "javascriptreact",
+      "typescript",
+      "typescriptreact",
+      "html",
+      "markdown"
+    ],
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    },
+    "search.exclude": {
+      "**/.git": true,
+      "**/.svn": true,
+      "**/.hg": true,
+      "**/CVS": true,
+      "**/.DS_Store": true,
+      "docs/docs/out/**": true,
+      "packages/*/lib/**": true
+    },
+    "typescript.tsdk": "node_modules/typescript/lib",
+    "[typescript]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[typescriptreact]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[javascript]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[javascriptreact]": {
+      "editor.defaultFormatter": "esbenp.prettier-vscode"
+    },
+    "[markdown]": {
+      "editor.quickSuggestions": {
+        "other": true,
+        "comments": true,
+        "strings": true
+      }
+    },
+    "eslint.trace.server": "verbose",
+    "cSpell.words": [
+      "commitlint",
+      "monoo"
+    ]
+  }
+

README.md

@@ -5,13 +5,19 @@
 </p>
 
 <p align="center">
- <img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
+  <a href="#"><img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
   <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
   <a href="https://github.com/vuejs/vuepress/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
   <a href="https://discordapp.com/invite/HBherRA"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="VuePress channel on Discord"></a>
 </p>
 
-> VuePress 2 is coming! Please check out [vuepress-next](https://github.com/vuepress/vuepress-next).
+## Status
+
+VuePress v1 is now in maintenance mode.
+
+For a next-gen Vue-based SSG:
+- [VitePress](https://vitepress.vuejs.org/): Vue.js official team supported. Built on top of Vue 3 + Vite.
+- [VuePress v2+](https://github.com/vuepress/core): Community supported. Built on top of Vue 3 + Vite / Webpack / Other bundlers.
 
 ## Documentation
 
@@ -44,7 +50,7 @@ If you have a VuePress-related project/component/tool, add it with a pull reques
 
 <table>
   <td align="center"><a href="http://evanyou.me"><img src="https://avatars1.githubusercontent.com/u/499550?v=4" width="100px;" alt="Evan You"/><br /><sub><b>Evan You</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=yyx990803" title="Code">💻</a></td>
-  <td align="center"><a href="http://ulivz.com"><img src="https://avatars1.githubusercontent.com/u/23133919?v=4" width="100px;" alt="ULIVZ"/><br /><sub><b>ULIVZ</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Documentation">📖</a></td>
+  <td align="center"><a href="https://github.com/ulivz"><img src="https://avatars1.githubusercontent.com/u/23133919?v=4" width="100px;" alt="ULIVZ"/><br /><sub><b>ULIVZ</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Documentation">📖</a></td>
 </table>
 
 ### Active Core Team
@@ -55,7 +61,6 @@ If you have a VuePress-related project/component/tool, add it with a pull reques
 <table>
   <tr>
     <td align="center"><a href="https://billychin.netlify.com/"><img src="https://avatars0.githubusercontent.com/u/38957202?v=4" width="100px;" alt="Billyyyyy3320"/><br /><sub><b>Billyyyyy3320</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=newsbielt703" title="Code">💻</a></td>
-    <td align="center"><a href="http://www.bencodezen.io"><img src="https://avatars0.githubusercontent.com/u/4836334?v=4" width="100px;" alt="Ben Hong"/><br /><sub><b>Ben Hong</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Documentation">📖</a> <a href="#question-bencodezen" title="Answering Questions">💬</a></td>
     <td align="center"><a href="https://github.com/meteorlxy"><img src="https://avatars0.githubusercontent.com/u/18205362?s=400&v=4" width="100px;" alt="meteorlxy"/><br /><sub><b>meteorlxy</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=meteorlxy" title="Code">💻</a></td>
     <td align="center"><a href="https://twitter.com/CodesOfRa"><img src="https://avatars0.githubusercontent.com/u/945186?v=4" width="100px;" alt="Ramona"/><br /><sub><b>Ramona</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=CodesOfRa" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=CodesOfRa" title="Documentation">📖</a></td>
     <td align="center"><a href="https://www.franck-abgrall.me/"><img src="https://avatars3.githubusercontent.com/u/9840435?v=4" width="100px;" alt="Franck Abgrall"/><br /><sub><b>Franck Abgrall</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=kefranabg" title="Code">💻</a> <a href="#question-kefranabg" title="Answering Questions">💬</a></td>
@@ -73,6 +78,7 @@ Here we honor some no-longer-active core team members who have made valuable con
 
 <table>
   <tr>
+    <td align="center"><a href="http://www.bencodezen.io"><img src="https://avatars0.githubusercontent.com/u/4836334?v=4" width="100px;" alt="Ben Hong"/><br /><sub><b>Ben Hong</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Documentation">📖</a> <a href="#question-bencodezen" title="Answering Questions">💬</a></td>
     <td align="center"><a href="https://github.com/f3ltron"><img src="https://avatars1.githubusercontent.com/u/11556276?v=4" width="100px;" alt="Giraud Florent"/><br /><sub><b>Giraud Florent</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=f3ltron" title="Code">💻</a></td>
     <td align="center"><a href="https://frontstuff.io/"><img src="https://avatars0.githubusercontent.com/u/5370675?v=4" width="100px;" alt="Sarah Dayan"/><br /><sub><b>Sarah Dayan</b></sub></a><br /><a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Documentation">📖</a></td>
     <td align="center"><a href="https://twitter.com/_vinayak_k"><img src="https://avatars2.githubusercontent.com/u/19776877?v=4" width="100px;" alt="Vinayak Kulkarni"/><br /><sub><b>Vinayak Kulkarni</b></sub></a><br /><a href="#plugin-vinayakkulkarni" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/vuejs/vuepress/commits?author=vinayakkulkarni" title="Code">💻</a> <a href="#blog-vinayakkulkarni" title="Blogposts">📝</a></td>

babel.config.js

@@ -5,7 +5,13 @@ module.exports = {
         ['@babel/preset-env', { 'targets': { 'node': 'current' }}]
       ],
       'plugins': [
-        '@babel/plugin-syntax-dynamic-import'
+        '@babel/plugin-syntax-dynamic-import',
+        [
+          '@babel/plugin-proposal-class-properties',
+          {
+            'loose': true
+          }
+        ]
       ]
     }
   }

changelog/1.9.2.md

@@ -0,0 +1,116 @@
+# TS Support for VuePress Plugin and Theme.
+
+## Motivation
+
+We've announced [VuePress 1.9](https://github.com/vuejs/vuepress/releases/tag/v1.9.0) that takes full TypeScript Support for Config File, while VuePress 1.9.2 ships with **TS Support for VuePress Plugin and Theme**:
+
+<p align="center">
+    <img src="./assets/showcase.png" width="400px"></img>
+<p>
+
+## Quick Start
+
+In order to make the plugin developer not dependent on VuePress for development, we provide a completely independent type package `@vuepress/types`:
+
+```bash
+npm i @vuepress/types -D
+```
+
+`@vuepress/types` exports four functions:
+
+- `defineConfig`
+- `defineConfig4CustomTheme`
+- `defineTheme`
+- `definePlugin`
+
+Note that using `@vuepress/types` is equivalent to using `vuepress/config`.
+
+## Plugin Type
+
+If you already have some VuePress plugins written in JS, you can leverage your IDE's intellisense with jsdoc type hints:
+
+```js
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
+module.exports = {
+  ready() {
+    // ...
+  }
+};
+```
+
+Alternatively, you can use the defineConfig helper which should provide intellisense without the need for jsdoc annotations:
+
+```js
+import { definePlugin } from "@vuepress/types";
+
+export default definePlugin({
+  // ...
+});
+```
+
+## Plugin Options Type
+
+Type of plugin options also supports passing in through generic type:
+
+```ts
+import { definePlugin } from "@vuepress/types";
+
+interface Options {
+  name: string;
+}
+
+export default definePlugin<Options>((options, ctx) => {
+  return {
+    ready() {
+      return ctx.base + options.name;
+    }
+  };
+});
+```
+
+## Theme Type
+
+Similar to [plugin](plugin-type), the only difference is the type you use, and the define function:
+
+```diff
+ /**
+- * @type {import('@vuepress/types').Plugin}
++ * @type {import('@vuepress/types').Theme}
+  */
+```
+
+```diff
+-import { definePlugin } from "@vuepress/types";
++import { defineTheme } from "@vuepress/types";
+
+-export default definePlugin({
++export default defineTheme({
+   // ...
+ });
+```
+
+## Theme Config Type
+
+Type of theme config also supports passing in through generic type:
+
+```ts
+import { defineTheme } from "@vuepress/types";
+
+interface ThemeConfig {
+  lang: string;
+}
+
+export default defineTheme<ThemeConfig>((themeConfig, ctx) => {
+  return {
+    ready() {
+      return ctx.base + themeConfig.lang;
+    }
+  };
+});
+```
+
+## Notes
+
+It is worth noting that, unlike the [site configuration](https://vuepress.vuejs.org/config/), i.e. `.vuepress/config.js`, if you use TypeScript to write theme or plugin, you still need to compile it into JavaScript before publishing it to NPM.

lerna.json

@@ -1,7 +1,7 @@
 {
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "1.8.0",
+  "version": "1.9.10",
   "command": {
     "version": {
       "allowBranch": "master",

package.json

@@ -19,11 +19,11 @@
     "packages:diff": "lerna diff",
     "packages:list": "lerna ls -l",
     "register-vuepress": "lerna exec --scope vuepress -- yarn link",
-    "release": "yarn lint && yarn build && yarn test && node scripts/release.js",
+    "release": "yarn lint && yarn build && monoo release",
     "remote-version": "node scripts/remote-version.js",
     "show-help": "yarn workspace docs show-help",
     "test": "node scripts/test.js",
-    "tsc": "yarn workspace @vuepress/shared-utils tsc",
+    "tsc": "lerna run tsc --stream",
     "unregister-vuepress": "lerna exec --scope vuepress -- yarn unlink",
     "update-core-team": "all-contributors generate",
     "view-info": "yarn tsc && yarn workspace docs view-info"
@@ -45,6 +45,7 @@
     ]
   },
   "devDependencies": {
+    "@babel/plugin-proposal-class-properties": "7",
     "@commitlint/cli": "^8.2.0",
     "@commitlint/config-conventional": "^8.2.0",
     "@types/escape-html": "^0.0.20",
@@ -66,7 +67,8 @@
     "lerna": "3.16.4",
     "lint-staged": "^9.3.0",
     "minimist": "^1.2.0",
+    "monoo": "0.4.3",
     "sort-package-json": "^1.24.0",
-    "typescript": "^3.6.3"
+    "typescript": "4.5.2"
   }
 }

packages/@vuepress/core/lib/client/redirect.js

@@ -50,5 +50,6 @@ export function handleRedirectForCleanUrls (router) {
 }
 
 function isRouteExists (router, path) {
-  return router.options.routes.filter(route => route.path.toLowerCase() === path.toLowerCase()).length > 0
+  const pathLower = path.toLowerCase()
+  return router.options.routes.some(route => route.path.toLowerCase() === pathLower)
 }

packages/@vuepress/core/lib/client/root-mixins/updateMeta.js

@@ -1,4 +1,5 @@
 import unionBy from 'lodash/unionBy'
+import escape from 'escape-html'
 
 export default {
   // created will be called on both client and ssr
@@ -132,7 +133,7 @@ function renderPageMeta (meta) {
   return meta.map(m => {
     let res = `<meta`
     Object.keys(m).forEach(key => {
-      res += ` ${key}="${m[key]}"`
+      res += ` ${key}="${escape(m[key])}"`
     })
     return res + `>`
   }).join('\n    ')