BuilderContext.md

firedoc 1.9.2

Fireball is the game engine for the future.

BuilderContext Class

Defined in: lib/builder.js:36

Module: firedoc

The Builder Context

Index

Properties

• ast AST The AST object
• options Option The command options
• helpers Object The view helpers function
• cacheView Boolean cache the views
• template Object The template
• files Number records the files
• viewExtname String The ext name of current view

Methods

• metadata load the metadata from theme.json
• addHelper Add helper
• addHelpers Add helpers
• _inlineCode Ported from Selleck, this handles ```'s in fields that are not parsed by the Markdown parser.
• _parseCrossLink Parse the item to be cross linked and return an HREF linked to the item
• populateClasses Populate the meta data for classes
• populateModules Populate the meta data for modules
• populateFiles Populate the meta data for files
• addFoundAt Parses file and line number from an item object and build's an HREF
• mixExternal Fetches the remote data and fires the callback when it's all complete
• makeDirs Makes the default directories needed
• init Set BuilderContext context and return
• correctTheme correct the theme
• compile Compule the AST
• render Render
• writeApiMeta Write api.json
• NATIVES_LINKER Function to link an external type uses NATIVES object
• compile compile

Details

Properties

ast

The AST object

meta	description
Type	AST
Defined	lib/builder.js:43

options

The command options

meta	description
Type	Option
Defined	lib/builder.js:48

helpers

The view helpers function

meta	description
Type	Object
Defined	lib/builder.js:53

cacheView

cache the views

meta	description
Type	Boolean
Defined	lib/builder.js:58

template

The template

meta	description
Type	Object
Defined	lib/builder.js:63

files

records the files

meta	description
Type	Number
Defined	lib/builder.js:68

viewExtname

The ext name of current view

meta	description
Type	String
Defined	lib/builder.js:73

Methods

metadata

load the metadata from theme.json

meta	description
Defined	lib/builder.js:80
Return	Object

addHelper

Add helper

meta	description
Defined	lib/builder.js:110

Parameters

• name String The helper name
• helper Function The helper logic

addHelpers

Add helpers

meta	description
Defined	lib/builder.js:122

Parameters

• helpers Object

_inlineCode

Ported from Selleck, this handles ```'s in fields that are not parsed by the Markdown parser.

meta	description
Defined	lib/builder.js:134
Return	HTML

Parameters

• html HTML The HTML to parse

_parseCrossLink

Parse the item to be cross linked and return an HREF linked to the item

meta	description
Defined	lib/builder.js:152

Parameters

• item String The item to crossLink
• raw Boolean Do not wrap it in HTML
• content String crossLink helper content

populateClasses

Populate the meta data for classes

meta	description
Defined	lib/builder.js:261
Return	Object

Parameters

• opts Object The original options

populateModules

Populate the meta data for modules

meta	description
Defined	lib/builder.js:285
Return	Object

Parameters

• opts Object The original options

populateFiles

Populate the meta data for files

meta	description
Defined	lib/builder.js:310
Return	Object

Parameters

• opts Object The original options

addFoundAt

Parses file and line number from an item object and build's an HREF

meta	description
Defined	lib/builder.js:330
Return	String

Parameters

• a Object The item to parse

mixExternal

Fetches the remote data and fires the callback when it's all complete

meta	description
Defined	lib/builder.js:341
Return	Promise

Parameters

• cb Function The callback to execute when complete

makeDirs

Makes the default directories needed

meta	description
Defined	lib/builder.js:414

init

Set BuilderContext context and return

meta	description
Defined	lib/builder.js:430
Return	BuilderContext

Parameters

• ast AST
• options Option

correctTheme

correct the theme

meta	description
Defined	lib/builder.js:447

compile

Compule the AST

meta	description
Defined	lib/builder.js:469

Parameters

• callback Function The callback

render

Render

meta	description
Defined	lib/builder.js:529

writeApiMeta

Write api.json

meta	description
Defined	lib/builder.js:556

Parameters

• locals Locals The locals

NATIVES_LINKER

Function to link an external type uses NATIVES object

meta	description
Defined	lib/builder.js:691
Return	String

Parameters

• name String The name of the type to link

compile

compile

meta	description
Defined	lib/builder.js:706

Parameters

• ast AST The AST object
• options Option The options
• onfinish Function fired when compile has completed