bmarshall511/gulp_starter

Rapidly setup gulp with pre-built tasks that help enforce coding standards, provide backwards compatibility, generates documentation & helps boost performance.

dev-master 2021-10-12 21:42 UTC

README

Rapidly setup gulp with pre-built tasks that help enforce coding standards, provide backwards compatibility, generates documentation & helps boost performance.

  • CMS agnostic for maximum flexibility
  • Supports ECMAScript 2015+ code using Babel
  • Uses Sass to compile CSS & cssnano to compress files
  • Automatically adds CSS vendor prefixes using autoprefixer
  • Self-documents SCSS files using sassdoc
  • Helps keep SCSS & CSS consistant using best practices using stylelint
  • Lints JS files using eslint, auto formats using Prettier & minifies using gulp-minify
  • Generates source maps using gulp-sourcemaps
  • Minifies images using imagemin, including webp conversions
  • Parses and outputs TODOs and FIXMEs from code comments to a TODO.md file using gulp-todo

Project setup

npm install

Compiles for development

npm run compile

Compiles for development & watches for file changes

npm run watch

Compiles & minifies for production

npm run build