Generates heap snapshots during selected docpad events
CoffeeScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitattributes
.gitignore
.npmignore
Cakefile
Contributing.md
History.md
LICENSE.md
README.md
package.json

README.md

HeapDump Plugin for DocPad

NPM version Dependency Status Gittip donate button Analytics

Generates heap snapshots during specified docpad events that can be loaded in to the chrome profiler. Snapshot files are generated in the root of docpad by default

Config

plugins:
	heapdumper:
		# default output path relative to the docpad root path
		snapshotPath: "snapshots"
		# default events that this plugin write a snapshot at (change to suit your docpad instance)
		events: [
			'writeAfter' # (default)
		]
Some of the events that can be specified
	'generateBefore'
	'generateAfter'
	'parseBefore'
	'parseAfter'
	'populateCollectionsBefore'
	'populateCollections'
	'contextualizeBefore'
	'contextualizeAfter'
	'renderBefore'
	'renderAfter'
	'renderCollectionBefore'
	'renderCollectionAfter'
	'writeBefore'
	'writeAfter' # (default)
	'serverBefore'
	'serverAfter'

Full event list is here

Be warned that snapshoting the render event will take a long time depending on how many documents you have to render. So use wisley, i.e. a test instance of docpad with 3 files to render

Tips

Good advice here:

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

License

Licensed under the incredibly permissive MIT License
Copyright © 2013+ Stringz Solutions Ltd
Copyright © 2013+ Peter Flannery