Additional subcommands

bedrock.config.js

@@ -18,6 +18,7 @@ module.exports = {
   },
   styleguide: {
     url: '/styleguide',
+    overrideStyleguideTemplates: false,
     search: true,
     colors: './content/scss/_colors.scss',
     categoryOrder: [

content/templates/_components/aov-icons/02-icon-font.pug

@@ -1,6 +1,6 @@
-include ../../../../core/templates/mixins/icon-overview
+include /core/templates/mixins/icon-overview
 
 if config.icons.generateIconFont
     +iconsOverview('icon-font', 'Icon font')
 else
-    p You don't seem to have icon fonts activated in <code>bedrock.config.js</code>. You can safely delete these documentation templates if you are not using an icon font, or document your icon font in your own manner.
+    p You don't seem to have icon fonts activated in <code>bedrock.config.js</code>. You can safely delete these documentation templates if you are not using an icon font, or document your icon font in your own manner.

content/templates/_layouts/master.pug

@@ -1,8 +1,8 @@
 //- Globally expose mixins without output, needed for Bedrock to work
-include ../../../core/templates/mixins/icon
-include ../../../core/templates/mixins/render-page-tree
-include ../../../core/templates/mixins/sample
-include ../../../core/templates/mixins/styleguide-settings
+include /core/templates/mixins/icon
+include /core/templates/mixins/render-page-tree
+include /core/templates/mixins/sample
+include /core/templates/mixins/styleguide-settings
 //- Use this include to add your own mixins
 include ../_mixins/all
 
@@ -51,14 +51,14 @@ html(dir="ltr" lang="en" class=htmlClass ? htmlClass : '')
 
         if config.pageTree && config.pageTree.layoutStyle == 'sidebar'
             .br-prototype-wrapper
-                include ../../../core/templates/includes/prototype-nav
+                include /core/templates/includes/prototype-nav
                 .br-prototype-content
                     block body
         else
             block body
             if config.pageTree && config.pageTree.layoutStyle == 'fixed'
                 .br-pagetree-fixed-wrapper
-                    include ../../../core/templates/includes/prototype-nav
+                    include /core/templates/includes/prototype-nav
 
         = "\n"
 

content/templates/page-index.pug

@@ -1,6 +1,6 @@
 extends /templates/_layouts/master
 
-include ../../core/templates/mixins/render-page-tree
+include /core/templates/mixins/render-page-tree
 
 block append headerStyles
     style.

core/cli/bedrock

@@ -0,0 +1,31 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+
+const cliVersion = require('../../package.json').version;
+
+program
+  .version(cliVersion, '-v, --version');
+
+program
+  .command('build', 'Build a static site');
+
+program
+  .command('config', 'Report the configuration');
+
+program
+  .command('content', 'Commands related to the main site content');
+
+program
+  .command('serve', 'Run a development server');
+
+program
+  .command('styleguide', 'Commands related to the styleguide content');
+
+program
+  .command('components', 'Commands related to the styleguide components');
+
+program
+  .parse(process.argv);

core/cli/bedrock-build

@@ -0,0 +1,17 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const gulp = require('gulp');
+
+const defineGulpTasks = require('../tasks/gulpfile');
+
+program
+  .action(() => {
+    defineGulpTasks();
+    gulp.series('build')();
+  });
+
+program
+  .parse(process.argv);

core/cli/bedrock-components

@@ -0,0 +1,49 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const glob = require('glob');
+const gulp = require('gulp');
+const path = require('path');
+
+const templates = require('../tasks/templates');
+const paths = require('../paths');
+
+
+program
+  .command('list')
+  .description('List the Pug templates under content/templates/_components')
+  .action(function () {
+    // glob.sync() is what gulp.src() uses, but the
+    console.log(glob.sync(paths.content.templates.allComponents, '**/*.pug'));
+  });
+
+program
+  .command('build')
+  .description('Build the component Pug templates')
+  .action(function () {
+    gulp.task('templates:compile:styleguide', templates.compile.styleguide);
+    gulp.series('templates:compile:styleguide')();
+  });
+
+program
+  .command('partials')
+  .description('Build the component Pug templates as partial HTML')
+  .action(function () {
+    gulp.task('templates:compile:partials', templates.compile.partials);
+    gulp.series('templates:compile:partials')();
+  });
+
+program
+  .action(() => {
+    program.help()
+  });
+
+if (process.argv.length === 2) {
+  program.help();
+  process.exit();
+}
+
+program
+  .parse(process.argv);

core/cli/bedrock-config

@@ -0,0 +1,21 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const glob = require('glob');
+const gulp = require('gulp');
+const path = require('path');
+
+const templates = require('../tasks/templates');
+const paths = require('../paths');
+
+const config = require('../discovery/config');
+
+program
+  .action(() => {
+    console.log(config)
+  });
+
+program
+  .parse(process.argv);

core/cli/bedrock-content

@@ -0,0 +1,40 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const glob = require('glob');
+const gulp = require('gulp');
+
+const templates = require('../tasks/templates');
+const paths = require('../paths');
+
+program
+  .command('list')
+  .description('List the Pug templates under content/templates/')
+  .action(function () {
+    // glob.sync() is what gulp.src() uses, but the
+    // task filters paths starting with an underscore...
+    console.log(glob.sync(paths.content.templates.all));
+  });
+
+program
+  .command('build')
+  .description('Build the Pug templates under content/temlates/')
+  .action(function () {
+    gulp.task('templates:compile:content', templates.compile.content);
+    gulp.series('templates:compile:content')();
+  });
+
+program
+  .action(() => {
+    program.help()
+  });
+
+if (process.argv.length === 2) {
+  program.help();
+  process.exit();
+}
+
+program
+  .parse(process.argv);

core/cli/bedrock-serve

@@ -0,0 +1,18 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const gulp = require('gulp');
+
+const browserSync = require('../tasks/browser-sync');
+const defineGulpTasks = require('../tasks/gulpfile');
+
+program
+  .action(() => {
+    defineGulpTasks();
+    gulp.parallel('server', 'compile-all', 'watch', browserSync)();
+  });
+
+program
+  .parse(process.argv);

core/cli/bedrock-styleguide

@@ -0,0 +1,33 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const program = require('commander');
+const glob = require('glob');
+const gulp = require('gulp');
+const path = require('path');
+
+const templates = require('../tasks/templates');
+const paths = require('../paths');
+
+program
+  .command('build')
+  .description('Build the style guide, using the styleguide and docs Pug templates')
+  .action(function () {
+    gulp.task('templates:compile:docs', templates.compile.docs);
+    gulp.task('templates:compile:styleguide', templates.compile.styleguide);
+    gulp.parallel('templates:compile:docs', 'templates:compile:styleguide')();
+  });
+
+program
+  .action(() => {
+    program.help()
+  });
+
+if (process.argv.length === 2) {
+  program.help();
+  process.exit();
+}
+
+program
+  .parse(process.argv);

core/discovery/default-config.js

@@ -28,6 +28,12 @@ const defaultConfig = {
    */
   styleguide: {
     url: '/styleguide',
+    /**
+     *  overrideStyleguideTemplates [boolean]
+     *  Make Bedrock use the current directory's styleguide
+     *  templates instead of Bedrock's core styleguide templates.
+    */
+    overrideStyleguideTemplates: false,
     /**
      *  search [boolean]
      *  Feature flag for search feature

core/discovery/docs.js

@@ -13,6 +13,8 @@ const config = require('./config');
 const locals = require('../templates/locals');
 const paths = require('../paths');
 
+const MultipleBaseDirs = require('../templates/multi-basedirs');
+
 module.exports = {
   discover: function () {
     const docFiles = glob.sync(paths.content.docs)
@@ -30,10 +32,11 @@ module.exports = {
           parsedFile.body = marked(parsedFile.body);
         } else if (extension === '.pug') {
           const indentedPugMarkup = parsedFile.body.split('\n').map(line => `    ${line}`).join('\n');
-          const markupWithLayout = `extends /../core/templates/layouts/sample\n\nblock content\n${indentedPugMarkup}`;
+          const markupWithLayout = `extends /core/templates/layouts/sample\n\nblock content\n${indentedPugMarkup}`;
 
           const compiler = pug.compile(markupWithLayout, Object.assign({}, config.pug, {
-            filename: docPath
+            filename: docPath,
+            plugins: [MultipleBaseDirs()]
           }));
           parsedFile.body = compiler(Object.assign({}, locals.getDefaultLocals(), {
             pathname: `styleguide/docs/${filename}`

core/paths.js

@@ -6,9 +6,14 @@ const config = require('./discovery/config');
 
 const contentPath = 'content/';
 const corePath = 'core/';
+const absoluteCorePath = __dirname;
 const compiledPath = 'tmp/';
 const distPath = 'dist/';
 
+const styleguideTemplatesPath = path.join(
+  config.styleguide.overrideStyleguideTemplates ? contentPath : absoluteCorePath,
+  'templates/_styleguide');
+
 module.exports = {
   content: {
     path: contentPath,
@@ -60,20 +65,20 @@ module.exports = {
   core: {
     path: corePath,
     js: {
-      entryFile: path.join(corePath, 'js/index.js'),
-      allFiles: path.join(corePath, 'js/**/*.js')
+      entryFile: path.join(absoluteCorePath, 'js/index.js'),
+      allFiles: path.join(absoluteCorePath, 'js/**/*.js')
     },
     scss: {
       all: path.join(corePath, 'scss/**/*.scss'),
-      prism: path.join(corePath, 'scss/prism-styleguide.scss'),
-      prototype: path.join(corePath, 'scss/prototype.scss')
+      prism: path.join(absoluteCorePath, 'scss/prism-styleguide.scss'),
+      prototype: path.join(absoluteCorePath, 'scss/prototype.scss')
     },
     templates: {
       styleguide: {
-        index: path.join(corePath, 'templates/styleguide/index.pug'),
-        doc: path.join(corePath, 'templates/styleguide/doc.pug'),
-        colors: path.join(corePath, 'templates/styleguide/colors.pug'),
-        componentGroup: path.join(corePath, 'templates/styleguide/component-group.pug')
+        index: path.join(styleguideTemplatesPath, 'index.pug'),
+        doc: path.join(styleguideTemplatesPath, 'doc.pug'),
+        colors: path.join(styleguideTemplatesPath, 'colors.pug'),
+        componentGroup: path.join(styleguideTemplatesPath, 'component-group.pug')
       }
     }
   },
@@ -102,6 +107,7 @@ module.exports = {
     },
     styleguide: path.join(distPath, config.styleguide.url),
     docs: path.join(distPath, config.styleguide.url+'/docs/'),
+    partials: path.join(distPath, 'styleguide/partials/'),
     assets: {
       images: path.join(distPath, 'images/'),
       fonts: path.join(distPath, 'fonts/'),