docsify-cli/lib/commands/init.js

A magical documentation generator.

'use strict'

const fs = require('fs')
const cp = require('cp-file').sync
const chalk = require('chalk')
const {version} = require('../../package.json')
const logger = require('../util/logger')
const {prompt, MultiSelect} = require('enquirer')
const {cwd, exists, pkg, pwd, read, resolve} = require('../util')
const colors = require('ansi-colors')

const replace = function (file, tpl, replace) {
  fs.writeFileSync(file, read(file).replace(tpl, replace), 'utf-8')
}

// eslint-disable-next-line
module.exports = async function (path = '', local, theme, plugins) {
  const msg =
    '\n' +
    chalk.green('Initialization succeeded!') +
    ' Please run ' +
    chalk.inverse(`docsify serve ${path}`) +
    '\n'

  const cwdPath = cwd(path || '.')

  if (exists(cwdPath)) {
    logger.error(`${path || '.'} already exists.`)

    let answer = {}
    try {
      answer = await prompt({
        type: 'confirm',
        name: 'rewrite',
        symbols: {
          separator: ''
        },
        message: 'Are you sure you want to rewrite it?'
      })
    } catch (err) {
      err && logger.error(err)
      process.exit(1)
    }

    if (!answer.rewrite) {
      return
    }
  }

  await createFile(cwdPath, local, theme, plugins)
  console.log(msg)
}

async function createFile(path, local, theme, plugins) {
  const target = file => resolve(path, file)
  const readme = exists(cwd('README.md')) || pwd('template/README.md')
  let main = pwd('template/index.html')

  if (local) {
    main = pwd('template/index.local.html')

    const vendor =
      exists(cwd('node_modules/docsify')) || pwd('../node_modules/docsify')

    cp(resolve(vendor, 'lib/docsify.min.js'), target('vendor/docsify.js'))
    cp(
      resolve(vendor, `lib/themes/${theme}.css`),
      target(`vendor/themes/${theme}.css`)
    )
  }

  const filename = 'index.html'

  cp(readme, target('README.md'))
  cp(main, target(filename))
  cp(pwd('template/.nojekyll'), target('.nojekyll'))

  replace(target(filename), 'vue.css', `${theme}.css`)

  if (pkg.name) {
    replace(
      target(filename),
      'Document',
      pkg.name + (pkg.description ? ' - ' + pkg.description : '')
    )
    replace(target(filename), 'name: \'\',', `name: '${pkg.name}',`)
  }

  if (pkg.description) {
    replace(target(filename), 'Description', pkg.description)
  }

  if (pkg.repository) {
    const repo = (pkg.repository.url || pkg.repository)
      .replace(/\.git$/g, '')
      .replace(/^git\+/g, '')
    replace(target(filename), 'repo: \'\'', `repo: '${repo}'`)
  }

  // Return early if not opted for plugins
  if (!plugins) {
    return replace(target(filename), '\n  _plugins_', '')
  }

  const officialPlugins = [
    'front-matter',
    'search',
    'disqus',
    'emoji',
    'external-script',
    'ga',
    'gitalk',
    'matomo',
    'zoom-image'
  ]

  const choices = officialPlugins.map(name => ({name, value: name}))
  const prompt = new MultiSelect({
    name: 'plugins',
    message: 'Select plugins to be used',
    hint: '(Use <space> to select, <return> to submit)',
    default: '',
    choices,
    indicator(state, choice) {
      if (choice.enabled) {
        return colors.cyan(state.symbols.radio.on)
      }

      return colors.gray(state.symbols.radio.off)
    }
  })

  prompt.on('cancel', () => replace(target(filename), '\n  _plugins_', ''))

  let answers = []
  try {
    answers = await prompt.run()
  } catch (err) {
    if (err) {
      logger.error(err)
      process.exitCode = 1
    }

    return
  }

  replace(target(filename), '  _plugins_', '_plugin'.repeat(answers.length + 1))

  answers.forEach(plugin => {
    const url = `//cdn.jsdelivr.net/npm/docsify@${version[0]}/lib/plugins/${plugin}.min.js`
    replace(target(filename), '_plugin', `  <script src="${url}"></script>\n`)
  })

  replace(target(filename), '\n_plugin', '')
}