Vue Styleguidist

# API Node.js

# Инициализация

Во-первых, вам необходимо создать API для конфигурации вашего управления по стилю.

Использование объекта JavaScript:

const styleguidist = require('vue-styleguidist')
const styleguide = styleguidist({
  logger: {
    warn: console.warn,
    info: console.log,
    debug: console.log
  },
  components: './lib/components/**/*.vue',
  webpackConfig: {
    module: {
      rules: [
        {
          test: /\.vue$/,
          exclude: /node_modules/,
          loader: 'vue-loader'
        },
        {
          test: /\.js?$/,
          exclude: /node_modules/,
          loader: 'babel-loader'
        },
        {
          test: /\.css$/,
          loader: 'style-loader!css-loader?modules'
        }
      ]
    }
  }
})

Использование файла конфигурации:

const styleguidist = require('vue-styleguidist')
const styleguide = styleguidist(require('../styleguide.config.js'))

Или автоматический поиск файла конфигурации:

const styleguidist = require('vue-styleguidist')
const styleguide = styleguidist()

Посмотреть все доступные config options.

Примечание. вывод консоли по умолчанию отключен. Возможно, вам удастся определить свой участок logger.

# Методы

# build(callback)

# Аргументы

  1. callback(err, config, stats) (Function): обратный вызов, который будет сохраняться при построении управления по стилю:

  2. err (Объект): сведения о деньгах. 2. config (Объект): нормализованная конфигурация управления по стилю. 3. stats (Объект): статистика сборки веб-пакета.

# Возврат

(Компилятор): пример веб-пакета Compiler.

# Пример

const styleguidist = require('vue-styleguidist')
styleguidist(require('../styleguide.config.js')).build(
  (err, config) => {
    if (err) {
      console.log(err)
    } else {
      console.log('Style guide published to', config.styleguideDir)
    }
  }
)

# server(callback)

# Аргументы

  1. callback(err, config) (Function): обратный вызов, который будет сохраняться при построении управления по стилю:

  2. err (Объект): сведения о деньгах. 2. config (Объект): нормализованная конфигурация управления по стилю.

# Возврат

(Object): объект, состоящий из экземпляра веб-пакета Compiler и vue-styleguidist Server.

# Пример

const styleguidist = require('vue-styleguidist')
styleguidist(require('../styleguide.config.js')).server(
  (err, config) => {
    if (err) {
      console.log(err)
    } else {
      const url = `http://${config.serverHost}:${config.serverPort}`
      console.log(`Listening at ${url}`)
    }
  }
)

# makeWebpackConfig([env])

# Аргументы

  1. [env='production'] (String): production или development.

# Возврат

(Object): внешний вид веб-пакета.

# Пример

// webpack.config.js
module.exports = [
  {
    // User webpack config
  },
  require('vue-styleguidist')().makeWebpackConfig()
]

← Развертывание →