atom-beautify/docs/index.coffee

#!/usr/bin/env coffee

# Dependencies
Handlebars = require('handlebars')
Beautifiers = require("../src/beautifiers")
fs = require('fs')

console.log('Generating options...')
beautifier = new Beautifiers()
languageOptions = beautifier.options
packageOptions = require('../src/config.coffee')
# Build options by Beautifier
beautifierOptions = {}
for optionName, optionDef of languageOptions
    beautifiers = optionDef.beautifiers ? []
    for beautifierName in beautifiers
        beautifierOptions[beautifierName] ?= {}
        beautifierOptions[beautifierName][optionName] = optionDef

console.log('Loading options template...')
optionsTemplatePath = __dirname + '/options-template.md'
optionTemplatePath = __dirname + '/option-template.md'
optionsPath = __dirname + '/options.md'
optionsTemplate = fs.readFileSync(optionsTemplatePath).toString()
optionTemplate = fs.readFileSync(optionTemplatePath).toString()

console.log('Building documentation from template and options...')
Handlebars.registerPartial('option', optionTemplate)
template = Handlebars.compile(optionsTemplate)

linkifyTitle = (title) ->
    title = title.toLowerCase()
    p = title.split(/[\s,+#;,\/?:@&=+$]+/) # split into parts
    sep = "-"
    p.join(sep)

Handlebars.registerHelper('linkify', (title, options) ->
    return new Handlebars.SafeString(
        "[#{options.fn(this)}](\##{linkifyTitle(title)})"
    )
)

exampleConfig = (option) ->
  # console.log(option)
  t = option.type
  d = switch
    when option.default? then option.default
    when t is "string" then ""
    when t is "integer" then 0
    when t is "boolean" then false
    else null

  json = {}
  namespace = option.language.namespace
  k = option.key
  c = {}
  c[k] = d
  json[namespace] = c
  return """```json
  #{JSON.stringify(json, undefined, 4)}
  ```"""

Handlebars.registerHelper('example-config', (key, option, options) ->
  results = exampleConfig(key, option)
  # console.log(results)
  return new Handlebars.SafeString(results)
)

context = {
    packageOptions: packageOptions
    languageOptions: languageOptions
    beautifierOptions: beautifierOptions
}
result = template(context)

console.log('Writing documentation to file...')
fs.writeFileSync(optionsPath, result)

console.log('Done.')