refactor(core): add type comments for internal plugins

wangchenpu · Dec 25, 2021 · c926aff · c926aff
1 parent 17c8fe4
commit c926aff
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 8 deletions.
diff --git a/packages/@vuepress/core/lib/node/internal-plugins/dataBlock/index.js b/packages/@vuepress/core/lib/node/internal-plugins/dataBlock/index.js
@@ -1,3 +1,6 @@
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = () => ({
   name: '@vuepress/internal-data-block',
 

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/enhanceApp.js b/packages/@vuepress/core/lib/node/internal-plugins/enhanceApp.js
@@ -1,10 +1,13 @@
 const { path } = require('@vuepress/shared-utils')
 
-module.exports = (options, context) => ({
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
+module.exports = (options, ctx) => ({
   name: '@vuepress/internal-enhance-app',
 
   enhanceAppFiles () {
-    const { sourceDir, themeAPI } = context
+    const { sourceDir, themeAPI } = ctx
     const enhanceAppPath = path.resolve(sourceDir, '.vuepress/enhanceApp.js')
     const files = [enhanceAppPath]
     if (themeAPI.existsParentTheme) {

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/frontmatterBlock/index.js b/packages/@vuepress/core/lib/node/internal-plugins/frontmatterBlock/index.js
@@ -1,3 +1,6 @@
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = () => ({
   name: '@vuepress/internal-frontmatter-block',
 

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/layoutComponents.js b/packages/@vuepress/core/lib/node/internal-plugins/layoutComponents.js
@@ -1,3 +1,6 @@
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = (options, ctx) => {
   return {
     name: '@vuepress/internal-layout-components',

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/pageComponents.js b/packages/@vuepress/core/lib/node/internal-plugins/pageComponents.js
@@ -1,3 +1,6 @@
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = (options, ctx) => {
   const { pages } = ctx
   // const componentNames = Object.keys(layoutComponentMap)

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/palette/index.js b/packages/@vuepress/core/lib/node/internal-plugins/palette/index.js
@@ -3,6 +3,9 @@ const {
   datatypes: { isPlainObject }
 } = require('@vuepress/shared-utils')
 
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = (options, ctx) => ({
   name: '@vuepress/internal-palette',
 

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/rootMixins.js b/packages/@vuepress/core/lib/node/internal-plugins/rootMixins.js
@@ -1,12 +1,15 @@
 const { codegen: { pathsToModuleCode }} = require('@vuepress/shared-utils')
 
-module.exports = (options, context, api) => ({
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
+module.exports = (options, ctx, api) => ({
   name: '@vuepress/internal-root-mixins',
 
   // @internal/root-mixins
   async clientDynamicModules () {
     const builtInRootMixins = [
-      context.getLibFilePath('client/root-mixins/updateMeta.js')
+      ctx.getLibFilePath('client/root-mixins/updateMeta.js')
     ]
 
     const rootMixins = [

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/routes.js b/packages/@vuepress/core/lib/node/internal-plugins/routes.js
@@ -1,3 +1,6 @@
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = (options, ctx) => ({
   name: '@vuepress/internal-routes',
 

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/siteData.js b/packages/@vuepress/core/lib/node/internal-plugins/siteData.js
@@ -1,9 +1,12 @@
-module.exports = (options, context) => ({
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
+module.exports = (options, ctx) => ({
   name: '@vuepress/internal-site-data',
 
   // @internal/siteData
   async clientDynamicModules () {
-    const code = `export const siteData = ${JSON.stringify(context.getSiteData(), null, 2)}`
+    const code = `export const siteData = ${JSON.stringify(ctx.getSiteData(), null, 2)}`
     return { name: 'siteData.js', content: code, dirname: 'internal' }
   }
 })
diff --git a/packages/@vuepress/core/lib/node/internal-plugins/style/index.js b/packages/@vuepress/core/lib/node/internal-plugins/style/index.js
@@ -1,8 +1,7 @@
 const { fs, path, logger, chalk } = require('@vuepress/shared-utils')
 
 /**
- * @param options
- * @param {AppContext} ctx
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
  */
 module.exports = (options, ctx) => ({
   name: '@vuepress/internal-style',

diff --git a/packages/@vuepress/core/lib/node/internal-plugins/transformModule.js b/packages/@vuepress/core/lib/node/internal-plugins/transformModule.js
@@ -2,6 +2,9 @@ const { fs, path } = require('@vuepress/shared-utils')
 
 const DIR = 'transform'
 
+/**
+ * @type {import('@vuepress/types').Plugin<{}, import('@vuepress/types').DefaultThemeConfig>}
+ */
 module.exports = (options, ctx) => ({
   name: '@vuepress/internal-transform-modules',
 

diff --git a/packages/@vuepress/core/package.json b/packages/@vuepress/core/package.json
@@ -30,6 +30,7 @@
     "@vuepress/plugin-last-updated": "1.9.4",
     "@vuepress/plugin-register-components": "1.9.4",
     "@vuepress/shared-utils": "1.9.4",
+    "@vuepress/types": "1.9.4",
     "autoprefixer": "^9.5.1",
     "babel-loader": "^8.0.4",
     "bundle-require": "2.1.8",