Skip to content

Engine hooks for file writing #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bmuenzenmeyer merged 3 commits into from
Oct 28, 2016
Merged

Engine hooks for file writing #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd6feaf
Update linter to permit es6 syntax
geoffp Oct 23, 2016
d7952aa
factor out writePatternFiles() and add hooks for engines to allow
geoffp Oct 23, 2016
8ed2ad4
tighten things up quite a bit
geoffp Oct 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"node": true,
"builtin": true
},
"parserOptions": {
"ecmaVersion": 6,
"sourceType": "module"
},
"globals": {},
"rules": {
"block-scoped-var": 0,
Expand Down
47 changes: 32 additions & 15 deletions core/lib/patternlab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,37 @@ var patternlab_engine = function (config) {
}
}

function writePatternFiles(headHTML, pattern, footerHTML) {
const nullFormatter = str => str;
const defaultFormatter = codeString => cleanHtml(codeString, {indent_size: 2});
const makePath = type => path.join(paths.public.patterns, pattern.getPatternLink(patternlab, type));
const patternPage = headHTML + pattern.patternPartialCode + footerHTML;
const eng = pattern.engine;

//beautify the output if configured to do so
const formatters = config.cleanOutputHtml ? {
rendered: eng.renderedCodeFormatter || defaultFormatter,
rawTemplate: eng.rawTemplateCodeFormatter || defaultFormatter,
markupOnly: eng.markupOnlyCodeFormatter || defaultFormatter
} : {
rendered: nullFormatter,
rawTemplate: nullFormatter,
markupOnly: nullFormatter
};

//prepare the path and contents of each output file
const outputFiles = [
{ path: makePath('rendered'), content: formatters.rendered(patternPage, pattern) },
{ path: makePath('rawTemplate'), content: formatters.rawTemplate(pattern.template, pattern) },
{ path: makePath('markupOnly'), content: formatters.markupOnly(pattern.patternPartialCode, pattern) }
].concat(
eng.addOutputFiles ? eng.addOutputFiles(paths, patternlab) : []
);

//write the compiled template to the public patterns directory
outputFiles.forEach(outFile => fs.outputFileSync(outFile.path, outFile.content));
}

function buildPatterns(deletePatternDir) {

patternlab.events.emit('patternlab-build-pattern-start', patternlab);
Expand Down Expand Up @@ -427,21 +458,7 @@ var patternlab_engine = function (config) {
patternlab.events.emit('patternlab-pattern-write-begin', patternlab, pattern);

//write the compiled template to the public patterns directory
var patternPage = headHTML + pattern.patternPartialCode + footerHTML;

//beautify the output if configured to do so
var cleanedPatternPage = config.cleanOutputHtml ? cleanHtml(patternPage, {indent_size: 2}) : patternPage;
var cleanedPatternPartialCode = config.cleanOutputHtml ? cleanHtml(pattern.patternPartialCode, {indent_size: 2}) : pattern.patternPartialCode;
var cleanedPatternTemplateCode = config.cleanOutputHtml ? cleanHtml(pattern.template, {indent_size: 2}) : pattern.template;

//write the compiled template to the public patterns directory
fs.outputFileSync(paths.public.patterns + pattern.getPatternLink(patternlab, 'rendered'), cleanedPatternPage);

//write the mustache file too
fs.outputFileSync(paths.public.patterns + pattern.getPatternLink(patternlab, 'rawTemplate'), cleanedPatternTemplateCode);

//write the encoded version too
fs.outputFileSync(paths.public.patterns + pattern.getPatternLink(patternlab, 'markupOnly'), cleanedPatternPartialCode);
writePatternFiles(headHTML, pattern, footerHTML);

patternlab.events.emit('patternlab-pattern-write-end', patternlab, pattern);

Expand Down