Skip to content

Issues/393 styleguide excludes #440

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
merged 3 commits into from
Aug 19, 2016
Merged

Issues/393 styleguide excludes #440

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
eb3db58
set property when excluded, do not omit outright
bmuenzenmeyer Aug 19, 2016
03b47d8
Merge branch 'dev' into issues/393-styleguideExcludes
bmuenzenmeyer Aug 19, 2016
1cea9c1
exclude styleguideExcludes from all page - but still render them in t…
bmuenzenmeyer Aug 19, 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
26 changes: 14 additions & 12 deletions core/lib/ui_builder.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,6 @@ var ui_builder = function () {
return true;
}

//this pattern is a member of any excluded pattern groups
isOmitted = styleGuideExcludes && styleGuideExcludes.length && _.some(styleGuideExcludes, function (exclude) {
return exclude === pattern.patternGroup; });
if (isOmitted) {
if (patternlab.config.debug) {
console.log('Omitting ' + pattern.patternPartial + ' from styleguide patterns its patternGroup is specified in styleguideExcludes.');
}
return true;
}

//this pattern is contained with a directory prefixed with an underscore (a handy way to hide whole directories from the nav
isOmitted = pattern.relPath.charAt(0) === '_' || pattern.relPath.indexOf('/_') > -1;
if (isOmitted) {
Expand Down Expand Up @@ -463,6 +453,7 @@ var ui_builder = function () {

var p;
var typePatterns = [];
var styleGuideExcludes = patternlab.config.styleGuideExcludes;

_.forOwn(patternTypeObj, function (patternSubtypes, patternSubtype) {

Expand Down Expand Up @@ -492,7 +483,6 @@ var ui_builder = function () {
return true; //stop yelling at us eslint we know we know
});


//do not create a viewall page for flat patterns
if (!writeViewAllFile || !p) {
return false;
Expand All @@ -509,7 +499,19 @@ var ui_builder = function () {
var viewAllHTML = buildViewAllHTML(patternlab, typePatterns, patternType);
writeFile(paths.public.patterns + p.subdir + '/index.html', mainPageHeadHtml + viewAllHTML + footerHTML);

patterns = patterns.concat(typePatterns);
//determine if we should omit this patterntype completely from the viewall page
var omitPatternType = styleGuideExcludes && styleGuideExcludes.length
&& _.some(styleGuideExcludes, function (exclude) {
return exclude === patternType;
});
if (omitPatternType) {
if (patternlab.config.debug) {
console.log('Omitting ' + patternType+ ' from building a viewall page because its patternGroup is specified in styleguideExcludes.');
}
} else {
patterns = patterns.concat(typePatterns);
}

return true; //stop yelling at us eslint we know we know
});
return patterns;
Expand Down
15 changes: 0 additions & 15 deletions test/ui_builder_tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,21 +53,6 @@ exports['ui_builder'] = {
test.done();
},

'isPatternExcluded - returns true when patterngroup is specified in styleguideExcludes': function (test) {
//arrange
var patternlab = createFakePatternLab({});
var pattern = new Pattern('00-test/foo.mustache');
patternlab.config.defaultPattern = 'test-boaz';
patternlab.config.styleGuideExcludes.push('test');

//act
var result = ui.isPatternExcluded(pattern, patternlab);

//assert
test.equals(result, true);
test.done();
},

'isPatternExcluded - returns true when pattern within underscored directory - top level': function (test) {
//arrange
var patternlab = createFakePatternLab({});
Expand Down