refactor: unify code style.

Author: ulivz

packages/@vuepress/core/lib/build.js

@@ -1,3 +1,5 @@
+'use strict'
+
 module.exports = async function build (sourceDir, cliOptions = {}) {
   process.env.NODE_ENV = 'production'
 

packages/@vuepress/core/lib/dev.js

@@ -1,3 +1,5 @@
+'use strict'
+
 module.exports = async function dev (sourceDir, cliOptions = {}) {
   const path = require('path')
   const webpack = require('webpack')

packages/@vuepress/core/lib/eject.js

@@ -1,3 +1,5 @@
+'use strict'
+
 const path = require('path')
 const { chalk, fs, logger } = require('@vuepress/shared-utils')
 

packages/@vuepress/core/lib/index.js

@@ -1,3 +1,5 @@
+'use strict'
+
 exports.dev = require('./dev')
 exports.build = require('./build')
 exports.eject = require('./eject')

packages/@vuepress/core/lib/prepare/AppContext.js

@@ -1,3 +1,9 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ */
+
 const path = require('path')
 const createMarkdown = require('../markdown/index')
 const loadConfig = require('./loadConfig')
@@ -8,17 +14,23 @@ const Page = require('./Page')
 const I18n = require('./I18n')
 const PluginAPI = require('../plugin-api/index')
 
+/**
+ * Expose AppContext.
+ */
+
 module.exports = class AppContext {
   /**
    * Instantiate the app context with a new API
-   * @param { string } sourceDir
+   *
+   * @param {string} sourceDir
    * @param {{
    *  isProd: boolean,
    *  plugins: pluginsConfig,
    *  theme: themeNameConfig
    *  temp: string
    * }} options
    */
+
   constructor (sourceDir, cliOptions = {}, isProd) {
     this.sourceDir = sourceDir
     this.cliOptions = cliOptions
@@ -47,8 +59,11 @@ module.exports = class AppContext {
 
   /**
    * Load pages, load plugins, apply plugins / plugin options, etc.
+   *
    * @returns {Promise<void>}
+   * @api private
    */
+
   async process () {
     this.normalizeHeadTagUrls()
     this.markdown = createMarkdown(this.siteConfig)
@@ -72,7 +87,10 @@ module.exports = class AppContext {
 
   /**
    * Apply internal and user plugins
+   *
+   * @api private
    */
+
   resolvePlugins () {
     const themeConfig = this.themeConfig
     const siteConfig = this.siteConfig
@@ -111,7 +129,10 @@ module.exports = class AppContext {
 
   /**
    * normalize head tag urls for base
+   *
+   * @api private
    */
+
   normalizeHeadTagUrls () {
     if (this.base !== '/' && this.siteConfig.head) {
       this.siteConfig.head.forEach(tag => {
@@ -132,7 +153,10 @@ module.exports = class AppContext {
 
   /**
    * Make template configurable
+   *
+   * @api private
    */
+
   resolveTemplates () {
     let { ssrTemplate, devTemplate } = this.siteConfig
     const templateDir = path.resolve(this.vuepressDir, 'templates')
@@ -156,8 +180,11 @@ module.exports = class AppContext {
 
   /**
    * Find all page source files located in sourceDir
+   *
    * @returns {Promise<void>}
+   * @api private
    */
+
   async resolvePages () {
     // resolve pageFiles
     const patterns = ['**/*.md', '!.vuepress', '!node_modules']
@@ -179,8 +206,11 @@ module.exports = class AppContext {
 
   /**
    * Add a page
-   * @returns { Promise<void> }
+   *
+   * @returns {Promise<void>}
+   * @api public
    */
+
   async addPage (options) {
     options.permalinkPattern = this.siteConfig.permalink
     const page = new Page(options)
@@ -194,15 +224,19 @@ module.exports = class AppContext {
 
   /**
    * Resolve theme
-   * @returns { Promise<void> }
+   *
+   * @returns {Promise<void>}
+   * @api private
    */
+
   async resolveTheme () {
     const theme = this.siteConfig.theme || this.cliOptions.theme
     Object.assign(this, (await loadTheme(theme, this.sourceDir, this.vuepressDir)))
   }
 
   /**
    * Get the data to be delivered to the client.
+   *
    * @returns {{
    *  title: string,
    *  description: string,
@@ -211,7 +245,9 @@ module.exports = class AppContext {
    *  themeConfig: ThemeConfig,
    *  locales: Locales
    * }}
+   * @api public
    */
+
   getSiteData () {
     return {
       title: this.siteConfig.title || '',
@@ -233,6 +269,7 @@ module.exports = class AppContext {
  *  tempPath: string
  * }}
  */
+
 function createTemp (tempPath) {
   if (!tempPath) {
     tempPath = path.resolve(__dirname, '../../.temp')

packages/@vuepress/core/lib/prepare/I18n.js

@@ -1,3 +1,13 @@
+'use strict'
+
+/**
+ * Get page data via path (permalink).
+ *
+ * @param {array} pages
+ * @param {string} path
+ * @returns {object}
+ */
+
 function findPageForPath (pages, path) {
   for (let i = 0; i < pages.length; i++) {
     const page = pages[i]
@@ -11,6 +21,14 @@ function findPageForPath (pages, path) {
   }
 }
 
+/**
+ * Expose I18n constructor.Note that this file will
+ * be run in both server and client side.
+ *
+ * @param store
+ * @returns {{new(*): I18n, prototype: I18n}}
+ */
+
 module.exports = (store /* null in server side */) => class I18n {
   constructor (dataProvider) {
     this.__ssrContext = true

packages/@vuepress/core/lib/prepare/Page.js

@@ -1,17 +1,28 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ */
+
 const path = require('path')
 const slugify = require('../markdown/slugify')
 const { inferTitle, extractHeaders } = require('../util/index')
 const { fs, fileToPath, parseFrontmatter, getPermalink } = require('@vuepress/shared-utils')
 
+/**
+ * Expose Page class.
+ */
+
 module.exports = class Page {
   /**
-   * @param { string } title markdown title
-   * @param { string } content markdown file content
-   * @param { string } filePath absolute file path of source markdown file.
-   * @param { string } relative relative file path of source markdown file.
-   * @param { string } permalink the URL (excluding the domain name) for your pages, posts.
-   * @param { object } frontmatter
-   * @param { string } permalinkPattern
+   * @param {string} path the URL (excluding the domain name) for your page/post.
+   * @param {string} title markdown title
+   * @param {string} content markdown file content
+   * @param {string} filePath absolute file path of source markdown file.
+   * @param {string} relative relative file path of source markdown file.
+   * @param {string} permalink same to path, the URL (excluding the domain name) for your page/post.
+   * @param {object} frontmatter
+   * @param {string} permalinkPattern
    */
   constructor ({
     path,
@@ -44,6 +55,16 @@ module.exports = class Page {
     this._permalinkPattern = permalinkPattern
   }
 
+  /**
+   * Process a page.
+   *
+   *   1. If it's a page pointing to a md file, this method will try
+   *      to resolve the page's title / headers from the content.
+   *   2. If it's a pure route. this method will only enhance it.
+   *
+   * @api public
+   */
+
   async process ({
     i18n,
     markdown,
@@ -85,10 +106,57 @@ module.exports = class Page {
     this._i18n = i18n
     this._localePath = i18n.$localePath
 
-    this._enhance(enhancers)
+    this.enhance(enhancers)
     this.buildPermalink()
   }
 
+  /**
+   * file name of page's source markdown file, or the last cut of regularPath.
+   *
+   * @returns {string}
+   * @api public
+   */
+
+  get filename () {
+    return path.parse(this._filePath || this.regularPath).name
+  }
+
+  /**
+   * slugified file name.
+   *
+   * @returns {string}
+   * @api public
+   */
+
+  get slug () {
+    return slugify(this.filename)
+  }
+
+  /**
+   * Convert page's metadata to JSON, note that all fields beginning
+   * with an underscore will not be serialized.
+   *
+   * @returns {object}
+   * @api public
+   */
+
+  toJson () {
+    const json = {}
+    Object.keys(this).reduce((json, key) => {
+      if (!key.startsWith('_')) {
+        json[key] = this[key]
+      }
+      return json
+    }, json)
+    return json
+  }
+
+  /**
+   * Build permalink via permalink pattern and page's metadata.
+   *
+   * @api private
+   */
+
   buildPermalink () {
     if (!this._permalink) {
       this._permalink = getPermalink({
@@ -105,7 +173,16 @@ module.exports = class Page {
     }
   }
 
-  _enhance (enhancers) {
+  /**
+   * Execute the page enhancers. A enhancer could do following things:
+   *
+   *   1. Modify page's frontmetter.
+   *   2. Add extra field to the page.
+   *
+   * @api private
+   */
+
+  enhance (enhancers) {
     for (const { name: pluginName, value: enhancer } of enhancers) {
       try {
         enhancer(this)
@@ -115,23 +192,4 @@ module.exports = class Page {
       }
     }
   }
-
-  get filename () {
-    return path.parse(this._filePath || this.regularPath).name
-  }
-
-  get slug () {
-    return slugify(this.filename)
-  }
-
-  toJson () {
-    const json = {}
-    Object.keys(this).reduce((json, key) => {
-      if (!key.startsWith('_')) {
-        json[key] = this[key]
-      }
-      return json
-    }, json)
-    return json
-  }
 }

packages/@vuepress/core/lib/prepare/index.js

@@ -1,5 +1,15 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ */
+
 const AppContext = require('./AppContext')
 
+/**
+ * Expose prepare.
+ */
+
 module.exports = async function prepare (sourceDir, cliOptions, isProd) {
   const appContext = new AppContext(sourceDir, cliOptions, isProd)
   await appContext.process()

packages/@vuepress/core/lib/prepare/loadConfig.js

@@ -1,8 +1,18 @@
+'use strict'
+
+/**
+ * Module dependencies.
+ */
+
 const { fs } = require('@vuepress/shared-utils')
 const path = require('path')
 const yamlParser = require('js-yaml')
 const tomlParser = require('toml')
 
+/**
+ * Expose loadConfig.
+ */
+
 module.exports = function loadConfig (vuepressDir, bustCache = true) {
   const configPath = path.resolve(vuepressDir, 'config.js')
   const configYmlPath = path.resolve(vuepressDir, 'config.yml')