Skip to content
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

Jump to bottom

Configurable paths galore #216

Merged
merged 6 commits into from
Jan 1, 2016
Merged

Configurable paths galore #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d40ff89
Path reform! Make paths more configurable from the config.json, and try
geoffp Dec 22, 2015
d585257
some gulp cleanup
geoffp Dec 22, 2015
9dcfc63
make the gulpfile use the paths from the config JSON
geoffp Dec 23, 2015
57c1302
Nice comments in the gulpfile
geoffp Dec 23, 2015
9177378
we are not yet ready for handlebars unit tests, clearly
geoffp Dec 23, 2015
cafd440
fix one unit test
geoffp Dec 23, 2015
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
10 changes: 5 additions & 5 deletions builder/pattern_assembler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
path = require('path');

//extract some information
var subdir = path.dirname(path.relative(patternlab.config.patterns.source, file)).replace('\\', '/');
var subdir = path.dirname(path.relative(patternlab.config.paths.source.patterns, file)).replace('\\', '/');
var filename = path.basename(file);
var ext = path.extname(filename);

Expand Down Expand Up @@ -119,8 +119,8 @@

//look for a json file for this template
try {
var jsonFilename = patternlab.config.patterns.source + currentPattern.subdir + '/' + currentPattern.fileName + ".json";
currentPattern.jsonFileData = fs.readJSONSync(jsonFilename.substring(2));
var jsonFilename = path.resolve(patternlab.config.paths.source.patterns, currentPattern.subdir, currentPattern.fileName + ".json");
currentPattern.jsonFileData = fs.readJSONSync(jsonFilename);
if(patternlab.config.debug){
console.log('found pattern-specific data.json for ' + currentPattern.key);
}
Expand All @@ -130,8 +130,8 @@

//look for a listitems.json file for this template
try {
var listJsonFileName = patternlab.config.patterns.source + currentPattern.subdir + '/' + currentPattern.fileName + ".listitems.json";
currentPattern.listitems = fs.readJSONSync(listJsonFileName.substring(2));
var listJsonFileName = path.resolve(patternlab.config.paths.source.patterns, currentPattern.subdir,currentPattern.fileName + ".listitems.json");
currentPattern.listitems = fs.readJSONSync(listJsonFileName);
buildListItems(currentPattern);
if(patternlab.config.debug){
console.log('found pattern-specific listitems.json for ' + currentPattern.key);
Expand Down
45 changes: 23 additions & 22 deletions builder/patternlab.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ var patternlab_engine = function () {
patternlab.package = fs.readJSONSync('./package.json');
patternlab.config = fs.readJSONSync('./config.json');

var paths = patternlab.config.paths;


function getVersion() {
console.log(patternlab.package.version);
}
Expand Down Expand Up @@ -55,18 +58,18 @@ var patternlab_engine = function () {
}

function buildPatterns(deletePatternDir){
patternlab.data = fs.readJSONSync('./source/_data/data.json');
patternlab.listitems = fs.readJSONSync('./source/_data/listitems.json');
patternlab.header = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/header.html', 'utf8');
patternlab.footer = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/footer.html', 'utf8');
patternlab.data = fs.readJSONSync(path.resolve(paths.source.data, 'data.json'));
patternlab.listitems = fs.readJSONSync(path.resolve(paths.source.data, 'listitems.json'));
patternlab.header = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'pattern-header-footer/header.html'), 'utf8');
patternlab.footer = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'pattern-header-footer/footer.html'), 'utf8');
patternlab.patterns = [];
patternlab.partials = {};
patternlab.data.link = {};

var pattern_assembler = new pa(),
entity_encoder = new he(),
pattern_exporter = new pe(),
patterns_dir = './source/_patterns';
patterns_dir = paths.source.patterns;

pattern_assembler.combine_listItems(patternlab);

Expand All @@ -87,7 +90,6 @@ var patternlab_engine = function () {
console.log(err);
return;
}

pattern_assembler.process_pattern_iterative(file.substring(2), patternlab);
});

Expand All @@ -113,13 +115,12 @@ var patternlab_engine = function () {
console.log(err);
return;
}

pattern_assembler.process_pattern_recursive(file.substring(2), patternlab);
});

//delete the contents of config.patterns.public before writing
if(deletePatternDir){
fs.emptyDirSync(patternlab.config.patterns.public);
fs.emptyDirSync(paths.public.patterns);
}

//render all patterns last, so lineageR works
Expand All @@ -136,13 +137,13 @@ var patternlab_engine = function () {
var patternFooter = pattern_assembler.renderPattern(patternlab.footer, pattern);

//write the compiled template to the public patterns directory
fs.outputFileSync(patternlab.config.patterns.public + pattern.patternLink, patternlab.header + pattern.patternPartial + patternFooter);
fs.outputFileSync(paths.public.patterns + pattern.patternLink, patternlab.header + pattern.patternPartial + patternFooter);

//write the mustache file too
fs.outputFileSync(patternlab.config.patterns.public + pattern.patternLink.replace('.html', '.mustache'), entity_encoder.encode(pattern.template));
fs.outputFileSync(paths.public.patterns + pattern.patternLink.replace('.html', '.mustache'), entity_encoder.encode(pattern.template));

//write the encoded version too
fs.outputFileSync(patternlab.config.patterns.public + pattern.patternLink.replace('.html', '.escaped.html'), entity_encoder.encode(pattern.patternPartial));
fs.outputFileSync(paths.public.patterns + pattern.patternLink.replace('.html', '.escaped.html'), entity_encoder.encode(pattern.patternPartial));
});

//export patterns if necessary
Expand All @@ -164,7 +165,7 @@ var patternlab_engine = function () {
media_hunter.find_media_queries('./source/css', patternlab);

// check if patterns are excluded, if not add them to styleguidePatterns
if (styleGuideExcludes.length) {
if (styleGuideExcludes && styleGuideExcludes.length) {
for (i = 0; i < patternlab.patterns.length; i++) {

// skip underscore-prefixed files
Expand All @@ -187,9 +188,9 @@ var patternlab_engine = function () {
}

//build the styleguide
var styleguideTemplate = fs.readFileSync('./source/_patternlab-files/styleguide.mustache', 'utf8'),
var styleguideTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'styleguide.mustache'), 'utf8'),
styleguideHtml = pattern_assembler.renderPattern(styleguideTemplate, {partials: styleguidePatterns});
fs.outputFileSync('./public/styleguide/html/styleguide.html', styleguideHtml);
fs.outputFileSync(path.resolve(paths.public.styleguide, 'html/styleguide.html'), styleguideHtml);

//build the viewall pages
var prevSubdir = '',
Expand Down Expand Up @@ -228,14 +229,14 @@ var patternlab_engine = function () {
}
}

var viewAllTemplate = fs.readFileSync('./source/_patternlab-files/viewall.mustache', 'utf8');
var viewAllTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'viewall.mustache'), 'utf8');
var viewAllHtml = pattern_assembler.renderPattern(viewAllTemplate, {partials: viewAllPatterns, patternPartial: patternPartial});
fs.outputFileSync(patternlab.config.patterns.public + pattern.flatPatternPath + '/index.html', viewAllHtml);
fs.outputFileSync(paths.public.patterns + pattern.flatPatternPath + '/index.html', viewAllHtml);
}
}

//build the patternlab website
var patternlabSiteTemplate = fs.readFileSync('./source/_patternlab-files/index.mustache', 'utf8');
var patternlabSiteTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'index.mustache'), 'utf8');

//sort all patterns explicitly.
patternlab.patterns = patternlab.patterns.sort(function(a,b){
Expand Down Expand Up @@ -415,20 +416,20 @@ var patternlab_engine = function () {

//the patternlab site requires a lot of partials to be rendered.
//patternNav
var patternNavTemplate = fs.readFileSync('./source/_patternlab-files/partials/patternNav.mustache', 'utf8');
var patternNavTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'partials/patternNav.mustache'), 'utf8');
var patternNavPartialHtml = pattern_assembler.renderPattern(patternNavTemplate, patternlab);

//ishControls
var ishControlsTemplate = fs.readFileSync('./source/_patternlab-files/partials/ishControls.mustache', 'utf8');
var ishControlsTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'partials/ishControls.mustache'), 'utf8');
patternlab.config.mqs = patternlab.mediaQueries;
var ishControlsPartialHtml = pattern_assembler.renderPattern(ishControlsTemplate, patternlab.config);

//patternPaths
var patternPathsTemplate = fs.readFileSync('./source/_patternlab-files/partials/patternPaths.mustache', 'utf8');
var patternPathsTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'partials/patternPaths.mustache'), 'utf8');
var patternPathsPartialHtml = pattern_assembler.renderPattern(patternPathsTemplate, {'patternPaths': JSON.stringify(patternlab.patternPaths)});

//viewAllPaths
var viewAllPathsTemplate = fs.readFileSync('./source/_patternlab-files/partials/viewAllPaths.mustache', 'utf8');
var viewAllPathsTemplate = fs.readFileSync(path.resolve(paths.source.patternlabFiles, 'partials/viewAllPaths.mustache'), 'utf8');
var viewAllPathsPartialHtml = pattern_assembler.renderPattern(viewAllPathsTemplate, {'viewallpaths': JSON.stringify(patternlab.viewAllPaths)});

//render the patternlab template, with all partials
Expand All @@ -438,7 +439,7 @@ var patternlab_engine = function () {
'patternPaths': patternPathsPartialHtml,
'viewAllPaths': viewAllPathsPartialHtml
});
fs.outputFileSync('./public/index.html', patternlabSiteHtml);
fs.outputFileSync(path.resolve(paths.public.root, 'index.html'), patternlabSiteHtml);
}

function addToPatternPaths(bucketName, pattern){
Expand Down
8 changes: 4 additions & 4 deletions builder/patternlab_gulp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ module.exports = function(gulp) {
gulp.task('patternlab:version', function(){
var patternlab = patternlab_engine();
patternlab.version();
})
});

gulp.task('patternlab:only_patterns', ['clean'], function(){
var patternlab = patternlab_engine();
patternlab.build_patterns_only(false);
})
});

gulp.task('patternlab:help', function(){
var patternlab = patternlab_engine();
patternlab.help();
})
});

}
};
21 changes: 11 additions & 10 deletions builder/pseudopattern_hunter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/*
* patternlab-node - v1.0.1 - 2015
*
/*
* patternlab-node - v1.0.1 - 2015
*
* Brian Muenzenmeyer, and the web community.
* Licensed under the MIT license.
*
* Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
* Licensed under the MIT license.
*
* Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
*
*/

Expand All @@ -20,15 +20,16 @@
pa = require('./pattern_assembler'),
lh = require('./lineage_hunter'),
of = require('./object_factory'),
mustache = require('mustache');
path = require('path');

var pattern_assembler = new pa();
var lineage_hunter = new lh();
var paths = patternlab.config.paths;

//look for a pseudo pattern by checking if there is a file containing same name, with ~ in it, ending in .json
var needle = currentPattern.subdir + '/' + currentPattern.fileName + '~*.json';
var pseudoPatterns = glob.sync(needle, {
cwd: patternlab.config.patterns.source + '/',
cwd: paths.source.patterns,
debug: false,
nodir: true,
});
Expand All @@ -42,13 +43,13 @@
}

//we want to do everything we normally would here, except instead read the pseudoPattern data
var variantFileData = fs.readJSONSync(patternlab.config.patterns.source + '/' + pseudoPatterns[i]);
var variantFileData = fs.readJSONSync(path.resolve(paths.source.patterns, pseudoPatterns[i]));

//extend any existing data with variant data
variantFileData = pattern_assembler.merge_data(currentPattern.jsonFileData, variantFileData);

var variantName = pseudoPatterns[i].substring(pseudoPatterns[i].indexOf('~') + 1).split('.')[0];
var variantFilePath = patternlab.config.patterns.source + '/' + currentPattern.subdir + '/' + currentPattern.fileName + '~' + variantName + '.json';
var variantFilePath = path.resolve(paths.source.patterns, currentPattern.subdir, currentPattern.fileName + '~' + variantName + '.json');
var variantFileName = currentPattern.fileName + '-' + variantName + '.';
var patternVariant = new of.oPattern(variantFilePath, currentPattern.subdir, variantFileName, variantFileData);

Expand Down
30 changes: 24 additions & 6 deletions config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
{
"patterns" : {
"source" : "./source/_patterns/",
"public" : "./public/patterns/"
},
{
"paths" : {
"source" : {
"root": "./source/",
"patterns" : "./source/_patterns/",
"data" : "./source/_data/",
"patternlabFiles" : "./source/_patternlab-files/",
"js" : "./source/js",
"images" : "./source/images",
"fonts" : "./source/fonts",
"css" : "./source/css/"
},
"public" : {
"root" : "./public/",
"patterns" : "./public/patterns/",
"data" : "./public/data/",
"styleguide" : "./public/styleguide/",
"js" : "./public/js",
"images" : "./public/images",
"fonts" : "./public/fonts",
"css" : "./public/css"
}
},
"styleGuideExcludes": [
"templates",
"pages"
Expand Down Expand Up @@ -30,7 +48,7 @@
"tools-docs": true
},
"patternStates": {
"homepage-emergency" : "inprogress"
"homepage-emergency" : "inprogress"
},
"patternExportKeys": [],
"patternExportDirectory": "./pattern_exports/",
Expand Down
Loading