Include non html files with Panini build

I’m using the Foundation Panini library with Foundation for Sites. I’m wondering how to include non-html files in the build when you compile your files. I know I need to probably edit the gulp file. I have a mostly static site with mostly all html files, but a few .cfm pages. I know I can just add includes with the cfm files but since I have mostly html files, I just want to use the same navigation, header, footer, etc “includes”.

But as of right now, only the html files get compiled into the dist folder. How to I get it to compile the cfm files as well?

Please provide the gulpfile that you use. Depending on your gulp tasks, gulp plugins and gulp.src there might be different solutions.

The easiest is a gulp.src + gulp.dest as some copy task.

@DanielRuf What I did actually works, but I’m wondering if there is a better way, because it builds a pages folder inside my dist folder with all duplicate pages in it. So I’m doing something wrong. I tried taking out “pages” in the path name but I didn’t work.

gulp file:
‘use strict’;

import plugins       from 'gulp-load-plugins';
import yargs         from 'yargs';
import browser       from 'browser-sync';
import gulp          from 'gulp';
import panini        from 'panini';
import rimraf        from 'rimraf';
import sherpa        from 'style-sherpa';
import yaml          from 'js-yaml';
import fs            from 'fs';
import webpackStream from 'webpack-stream';
import webpack2      from 'webpack';
import named         from 'vinyl-named';
import uncss         from 'uncss';
import autoprefixer  from 'autoprefixer';

// Load all Gulp plugins into one variable
const $ = plugins();

// Check for --production flag
const PRODUCTION = !!(yargs.argv.production);

// Load settings from settings.yml
const { PORT, UNCSS_OPTIONS, PATHS } = loadConfig();
function loadConfig() {
  let ymlFile = fs.readFileSync('config.yml', 'utf8');
  return yaml.load(ymlFile);
}

// Build the "dist" folder by running all of the below tasks
// Sass must be run later so UnCSS can search for used classes in the others assets.
gulp.task('build',

 gulp.series(clean, gulp.parallel(pages, javascript, images, copy, copyAudio, copyPDF, copySitemaps, copyPages), sass, styleGuide)); // took out , copyPages

// Build the site, run the server, and watch for file changes

gulp.task('default',

  gulp.series('build', server, watch));

// Delete the "dist" folder

// This happens every time a build starts

function clean(done) {

  rimraf(PATHS.dist, done);

}

// Copy files out of the assets folder

// This task skips over the "img", "js", and "scss" folders, which are parsed separately

function copy() {

  return gulp.src(PATHS.assets)

    .pipe(gulp.dest(PATHS.dist + '/assets'));

}

function copyAudio() {

  return gulp.src('src/audio/*')

    .pipe(gulp.dest(PATHS.dist + '/audio'));

}

function copyPDF() {

  return gulp.src('src/pdfs/*')

    .pipe(gulp.dest(PATHS.dist + '/pdfs'));

}

function copySitemaps() {

  return gulp.src('src/sitemaps/*')

    .pipe(gulp.dest(PATHS.dist + '/sitemaps'));

}

function copyPages() {

 return gulp.src(['src/pages/*'])

   .pipe(gulp.dest(PATHS.dist + '/pages'));

}

// Copy page templates into finished HTML files

function pages() {

  return gulp.src('src/pages/**/*.{html,hbs,handlebars,cfm}')

    .pipe(panini({

      root: 'src/pages/',

      layouts: 'src/layouts/',

      partials: 'src/partials/',

      data: 'src/data/',

      helpers: 'src/helpers/'

    }))

    .pipe(gulp.dest(PATHS.dist));

}

// Load updated HTML templates and partials into Panini

function resetPages(done) {

  panini.refresh();

  done();

}

// Generate a style guide from the Markdown content and HTML template in styleguide/

function styleGuide(done) {

  sherpa('src/styleguide/index.md', {

    output: PATHS.dist + '/styleguide.html',

    template: 'src/styleguide/template.html'

  }, done);

}

// Compile Sass into CSS

// In production, the CSS is compressed

function sass() {

  const postCssPlugins = [

    // Autoprefixer

    autoprefixer(),

    // UnCSS - Uncomment to remove unused styles in production

    // PRODUCTION && uncss.postcssPlugin(UNCSS_OPTIONS),

  ].filter(Boolean);

  return gulp.src('src/assets/scss/app.scss')

    .pipe($.sourcemaps.init())

    .pipe($.sass({

      includePaths: PATHS.sass

    })

      .on('error', $.sass.logError))

    .pipe($.postcss(postCssPlugins))

    .pipe($.if(PRODUCTION, $.cleanCss({ compatibility: 'ie9' })))

    .pipe($.if(!PRODUCTION, $.sourcemaps.write()))

    .pipe(gulp.dest(PATHS.dist + '/assets/css'))

    .pipe(browser.reload({ stream: true }));

}

let webpackConfig = {

  mode: (PRODUCTION ? 'production' : 'development'),

  module: {

    rules: [

      {

        test: /\.js$/,

        use: {

          loader: 'babel-loader',

          options: {

            presets: [ "@babel/preset-env" ],

            compact: false

          }

        }

      }

    ]

  },

  devtool: !PRODUCTION && 'source-map'

}

// Combine JavaScript into one file

// In production, the file is minified

function javascript() {

  return gulp.src(PATHS.entries)

    .pipe(named())

    .pipe($.sourcemaps.init())

    .pipe(webpackStream(webpackConfig, webpack2))

    .pipe($.if(PRODUCTION, $.uglify()

      .on('error', e => { console.log(e); })

    ))

    .pipe($.if(!PRODUCTION, $.sourcemaps.write()))

    .pipe(gulp.dest(PATHS.dist + '/assets/js'));

}

// Copy images to the "dist" folder

// In production, the images are compressed

function images() {

  return gulp.src('src/assets/img/**/*')

    .pipe($.if(PRODUCTION, $.imagemin([

      $.imagemin.jpegtran({ progressive: true }),

    ])))

    .pipe(gulp.dest(PATHS.dist + '/assets/img'));

}

// Start a server with BrowserSync to preview the site in

function server(done) {

  browser.init({

    server: PATHS.dist, port: PORT

  }, done);

}

// Reload the browser with BrowserSync

function reload(done) {

  browser.reload();

  done();

}

// Watch for changes to static assets, pages, Sass, and JavaScript

function watch() {

  gulp.watch(PATHS.assets, copy);

  gulp.watch('src/audio/*', copyAudio);

  gulp.watch('src/pdfs/*', copyPDF);

  gulp.watch('src/sitemaps/*', copySitemaps);

  gulp.watch('src/pages/*.cfm', copyPages);

  gulp.watch('src/pages/**/*.html').on('all', gulp.series(pages, browser.reload));

  gulp.watch('src/{layouts,partials}/**/*.html').on('all', gulp.series(resetPages, pages, browser.reload));

  gulp.watch('src/data/**/*.{js,json,yml}').on('all', gulp.series(resetPages, pages, browser.reload));

  gulp.watch('src/helpers/**/*.js').on('all', gulp.series(resetPages, pages, browser.reload));

  gulp.watch('src/assets/scss/**/*.scss').on('all', sass);

  gulp.watch('src/assets/js/**/*.js').on('all', gulp.series(javascript, browser.reload));

  gulp.watch('src/assets/img/**/*').on('all', gulp.series(images, browser.reload));

  gulp.watch('src/styleguide/**').on('all', gulp.series(styleGuide, browser.reload));

}

@DanielRuf I posted my code for the gulp file. Just wondering if you could take a look and see if I’m doing it right, or is there a better way to get .cfm files into my build?

Please keep in mind that we had holidays. No, I had not yet the time to take a closer look / test it.

Yes, sorry. Waited to check til after holidays. I know you’re super busy too. No problem.