refactor: typed all official plugins

ulivz · ulivz · commit b81413303346 · 2021-12-24T02:49:12.000+08:00
diff --git a/packages/@vuepress/plugin-active-header-links/index.js b/packages/@vuepress/plugin-active-header-links/index.js
@@ -1,6 +1,9 @@
 const { path } = require('@vuepress/shared-utils')
 
-module.exports = (options) => ({
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
+module.exports = options => ({
   clientRootMixin: path.resolve(__dirname, 'clientRootMixin.js'),
   define: {
     AHL_SIDEBAR_LINK_SELECTOR: options.sidebarLinkSelector || '.sidebar-link',
diff --git a/packages/@vuepress/plugin-active-header-links/package.json b/packages/@vuepress/plugin-active-header-links/package.json
@@ -21,6 +21,7 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
+    "@vuepress/types": "1.9.1",
     "lodash.debounce": "^4.0.8"
   },
   "publishConfig": {
diff --git a/packages/@vuepress/plugin-back-to-top/index.js b/packages/@vuepress/plugin-back-to-top/index.js
@@ -1,5 +1,8 @@
 const { path } = require('@vuepress/shared-utils')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = {
   enhanceAppFiles: [
     path.resolve(__dirname, 'enhanceAppFile.js')
diff --git a/packages/@vuepress/plugin-back-to-top/package.json b/packages/@vuepress/plugin-back-to-top/package.json
@@ -21,6 +21,7 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
+    "@vuepress/types": "1.9.1",
     "lodash.debounce": "^4.0.8"
   },
   "publishConfig": {
diff --git a/packages/@vuepress/plugin-google-analytics/index.js b/packages/@vuepress/plugin-google-analytics/index.js
@@ -1,5 +1,8 @@
 const { path } = require('@vuepress/shared-utils')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = (options = {}, context) => ({
   define () {
     const { siteConfig = {}} = context
diff --git a/packages/@vuepress/plugin-google-analytics/package.json b/packages/@vuepress/plugin-google-analytics/package.json
@@ -20,6 +20,9 @@
   "license": "MIT",
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
+  "dependencies": {
+    "@vuepress/types": "1.9.1"
+  },
   "publishConfig": {
     "access": "public"
   }
diff --git a/packages/@vuepress/plugin-last-updated/index.js b/packages/@vuepress/plugin-last-updated/index.js
@@ -1,6 +1,9 @@
 const path = require('path')
 const spawn = require('cross-spawn')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = (options = {}, context) => ({
   extendPageData ($page) {
     const { transformer, dateOptions } = options
diff --git a/packages/@vuepress/plugin-last-updated/package.json b/packages/@vuepress/plugin-last-updated/package.json
@@ -21,6 +21,7 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
+    "@vuepress/types": "1.9.1",
     "cross-spawn": "^6.0.5"
   },
   "publishConfig": {
diff --git a/packages/@vuepress/plugin-medium-zoom/index.js b/packages/@vuepress/plugin-medium-zoom/index.js
@@ -1,5 +1,8 @@
 const { path } = require('@vuepress/shared-utils')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = (options, context) => ({
   define: {
     SELECTOR: options.selector || '.theme-default-content :not(a) > img',
diff --git a/packages/@vuepress/plugin-medium-zoom/package.json b/packages/@vuepress/plugin-medium-zoom/package.json
@@ -21,6 +21,7 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
+    "@vuepress/types": "1.9.1",
     "medium-zoom": "^1.0.4"
   },
   "publishConfig": {
diff --git a/packages/@vuepress/plugin-nprogress/index.js b/packages/@vuepress/plugin-nprogress/index.js
@@ -1,5 +1,8 @@
 const { resolve } = require('path')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = {
   clientRootMixin: resolve(__dirname, 'clientRootMixin.js'),
   enhanceAppFiles: resolve(__dirname, 'enhanceAppFile.js')
diff --git a/packages/@vuepress/plugin-nprogress/package.json b/packages/@vuepress/plugin-nprogress/package.json
@@ -21,6 +21,7 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
+    "@vuepress/types": "1.9.1",
     "nprogress": "^0.2.0"
   },
   "publishConfig": {
diff --git a/packages/@vuepress/plugin-pwa/index.js b/packages/@vuepress/plugin-pwa/index.js
@@ -1,11 +1,17 @@
 const { logger, fs, path } = require('@vuepress/shared-utils')
 
-module.exports = ({
-  serviceWorker = true,
-  updatePopup = false,
-  popupComponent = 'SWUpdatePopup',
-  generateSWConfig = {}
-}, context) => ({
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
+module.exports = (
+  {
+    serviceWorker = true,
+    updatePopup = false,
+    popupComponent = 'SWUpdatePopup',
+    generateSWConfig = {}
+  },
+  context
+) => ({
   alias: {
     '@sw-event': path.resolve(__dirname, 'lib/event.js')
   },
@@ -33,12 +39,17 @@ module.exports = ({
       await wbb.generateSW({
         swDest: swFilePath,
         globDirectory: outDir,
-        globPatterns: ['**\/*.{js,css,html,png,jpg,jpeg,gif,svg,woff,woff2,eot,ttf,otf}'],
+        globPatterns: [
+          '**/*.{js,css,html,png,jpg,jpeg,gif,svg,woff,woff2,eot,ttf,otf}'
+        ],
         ...generateSWConfig
       })
       await fs.writeFile(
         swFilePath,
-        await fs.readFile(path.resolve(__dirname, 'lib/skip-waiting.js'), 'utf8'),
+        await fs.readFile(
+          path.resolve(__dirname, 'lib/skip-waiting.js'),
+          'utf8'
+        ),
         { flag: 'a' }
       )
     }
diff --git a/packages/@vuepress/plugin-pwa/package.json b/packages/@vuepress/plugin-pwa/package.json
@@ -22,6 +22,7 @@
   "main": "index.js",
   "dependencies": {
     "@vuepress/shared-utils": "1.9.1",
+    "@vuepress/types": "1.9.1",
     "register-service-worker": "^1.7.0",
     "workbox-build": "^4.3.1"
   },
diff --git a/packages/@vuepress/plugin-register-components/index.js b/packages/@vuepress/plugin-register-components/index.js
@@ -16,6 +16,9 @@ async function resolveComponents (componentDir) {
 // overwritten.
 let moduleId = 0
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = (options, context) => ({
   multiple: true,
 
diff --git a/packages/@vuepress/plugin-register-components/package.json b/packages/@vuepress/plugin-register-components/package.json
@@ -21,7 +21,8 @@
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
   "dependencies": {
-    "@vuepress/shared-utils": "1.9.1"
+    "@vuepress/shared-utils": "1.9.1",
+    "@vuepress/types": "1.9.1"
   },
   "publishConfig": {
     "access": "public"
diff --git a/packages/@vuepress/plugin-search/index.js b/packages/@vuepress/plugin-search/index.js
@@ -1,5 +1,8 @@
 const { path } = require('@vuepress/shared-utils')
 
+/**
+ * @type {import('@vuepress/types').Plugin}
+ */
 module.exports = (options) => ({
   alias: {
     '@SearchBox':
diff --git a/packages/@vuepress/plugin-search/package.json b/packages/@vuepress/plugin-search/package.json
@@ -20,6 +20,9 @@
   "license": "MIT",
   "author": "ULIVZ <chl814@foxmail.com>",
   "main": "index.js",
+  "dependencies": {
+    "@vuepress/types": "1.9.1"
+  },
   "publishConfig": {
     "access": "public"
   }
diff --git a/packages/@vuepress/theme-default/index.js b/packages/@vuepress/theme-default/index.js
@@ -1,7 +1,7 @@
 const path = require('path')
 
 /**
- * @type {import('@vuepress/types'.UserThemeEntry)}
+ * @type {import('@vuepress/types'.Theme)}
  */
 module.exports = (options, ctx) => {
   const { themeConfig, siteConfig } = ctx
diff --git a/packages/@vuepress/types/index.d.ts b/packages/@vuepress/types/index.d.ts
@@ -3,8 +3,8 @@ import {
   ThemeConfig,
   PluginOptions,
   DefaultThemeConfig,
-  UserThemeEntry,
-  UserPluginEntry,
+  Theme,
+  Plugin,
 } from './lib'
 
 export * from './lib'
@@ -30,11 +30,11 @@ export function defineConfig4CustomTheme<T extends ThemeConfig = ThemeConfig>(
  *
  * @see https://vuepress.vuejs.org/theme/option-api.html
  */
-export function defineThemeEntry<T extends ThemeConfig = ThemeConfig>(config: UserThemeEntry<T>): void;
+export function defineTheme<T extends ThemeConfig = ThemeConfig>(config: Theme<T>): void;
 
 /**
  * A helper function to define VuePress theme entry file.
  *
  * @see https://vuepress.vuejs.org/plugin/writing-a-plugin.html
  */
-export function definePluginEntry<T extends PluginOptions = PluginOptions>(config: UserPluginEntry<T>): void;
+export function definePlugin<T extends PluginOptions = PluginOptions>(config: Plugin<T>): void;
diff --git a/packages/@vuepress/types/index.js b/packages/@vuepress/types/index.js
@@ -3,5 +3,5 @@ function define(config) {
 }
 exports.defineConfig = define;
 exports.defineConfig4CustomTheme = define;
-exports.defineThemeEntry = define;
-exports.definePluginEntry = define;
+exports.defineTheme = define;
+exports.definePlugin = define;
diff --git a/packages/@vuepress/types/lib/plugin-api.ts b/packages/@vuepress/types/lib/plugin-api.ts
@@ -1,7 +1,7 @@
 import { Application } from "express";
 import WebpackDevServer from "webpack-dev-server";
 import { UserPlugins, PluginOptions } from "./plugin";
-import { ChainWebpack, Hook, AsyncHook } from "./shared";
+import { ChainWebpack, Hook, AsyncHook, PluginObject } from "./shared";
 import { Page, Context } from "./context";
 import { ExtendMarkdown } from "./markdown";
 
@@ -14,6 +14,8 @@ export type LifeCycleHook$Ready = AsyncHook<[], unknown>;
 export type LifeCycleHook$Updated = Hook<[], unknown>;
 export type LifeCycleHook$Generated = Hook<[], unknown>;
 
+export type FileDescriptor = { name: string; content: string };
+
 /**
  * Plugin Options API
  */
@@ -22,6 +24,10 @@ export type PluginEntryOptions = {
    * Current name
    */
   name: string;
+  /**
+   * Specify whether current plugin can be applied multiple times.
+   */
+  multiple?: boolean;
   /**
    * Sub plugins
    */
@@ -76,19 +82,19 @@ export type PluginEntryOptions = {
   enhanceAppFiles?:
     | string
     | string[]
-    | AsyncHook<[], { name: string; content: string }>;
+    | AsyncHook<[], FileDescriptor | FileDescriptor[]>;
   /**
    * Generate some client modules at compile time.
    *
    * @see https://vuepress.vuejs.org/plugin/option-api.html#clientdynamicmodules
    */
-  clientDynamicModules?: AsyncHook<[], { name: string; content: string }>;
+  clientDynamicModules?: AsyncHook<[], FileDescriptor | FileDescriptor[]>;
   /**
    * A function used to extend or edit the $page object
    *
    * @see https://vuepress.vuejs.org/plugin/option-api.html#extendpagedata
    */
-  extendPageData: Hook<[Page], unknown>;
+  extendPageData: <T extends PluginObject = PluginObject>(page: Page & T) => void;
   /**
    * A path to the mixin file which allows you to control the lifecycle of root component.
    *
@@ -155,6 +161,6 @@ export type PluginEntry = PluginEntryOptions & {
  *
  * @see https://vuepress.vuejs.org/plugin/writing-a-plugin.html
  */
-export type UserPluginEntry<T extends PluginOptions = PluginOptions> =
+export type Plugin<T extends PluginOptions = PluginOptions> =
   | PluginEntry
   | ((options: T, ctx: Context) => PluginEntry);
diff --git a/packages/@vuepress/types/lib/shared.ts b/packages/@vuepress/types/lib/shared.ts
@@ -8,3 +8,5 @@ export type AsyncHook<U extends unknown[], R extends unknown> = Hook<
   U,
   Promise<R>
 >;
+
+export type PluginObject = Record<string, any>;
diff --git a/packages/@vuepress/types/lib/theme.ts b/packages/@vuepress/types/lib/theme.ts
@@ -51,6 +51,6 @@ export type ThemeEntry = PluginEntryOptions & {
  *
  * @see https://vuepress.vuejs.org/theme/option-api.html
  */
-export type UserThemeEntry<T extends ThemeConfig = ThemeConfig> =
+export type Theme<T extends ThemeConfig = ThemeConfig> =
   | ThemeEntry
   | ((themeConfig: T, ctx: Context<T, Config<T>>) => ThemeEntry);
