{"id":24884,"library":"adfab-gulp-boilerplate","title":"Adfab Gulp Boilerplate","description":"A Gulp-based boilerplate for kick-starting front-end projects quickly, version 2.4.0. It integrates Browsersync for live reloading, supports SASS/LESS compilation, Babel transpilation, image minification, fonticon and SVG sprite generation, and includes linting for JS/SASS/LESS. Designed for teams needing a consistent, configurable build pipeline with JSON-based task configuration. Released under ISC license, with maintenance via GitHub issues and a SemVer release cycle. Alternatives include custom Gulp setups or modern build tools like Webpack/Vite.","status":"active","version":"2.4.0","language":"javascript","source_language":"en","source_url":"ssh://git@github.com/AdFabConnect/adfab-gulp-boilerplate","tags":["javascript","gulp","boilerplate","starter","front-end","build","sass","less","postcss"],"install":[{"cmd":"npm install adfab-gulp-boilerplate","lang":"bash","label":"npm"},{"cmd":"yarn add adfab-gulp-boilerplate","lang":"bash","label":"yarn"},{"cmd":"pnpm add adfab-gulp-boilerplate","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core build system dependency","package":"gulp","optional":false},{"reason":"Browsersync integration for live reloading","package":"browser-sync","optional":false},{"reason":"Babel transpilation for ES6+ support","package":"gulp-babel","optional":true},{"reason":"SASS compilation","package":"gulp-sass","optional":true},{"reason":"LESS compilation","package":"gulp-less","optional":true}],"imports":[{"note":"Uses CommonJS; no ES module wrapper, so require() is required.","wrong":"import gulp from 'gulp';","symbol":"default","correct":"const gulp = require('gulp');"},{"note":"The package generates gulpfile.js and gulp-config.json automatically. Do not create them manually.","wrong":"Manually creating gulpfile.js from scratch","symbol":"gulpfile.js","correct":"No import required; the boilerplate auto-generates a gulpfile.js on install."},{"note":"Configuration is read from the project root's gulp-config.json, not from installed package.","wrong":"Editing node_modules files","symbol":"gulp-config.json","correct":"Edit gulp-config.json after installation to configure tasks."}],"quickstart":{"code":"npm install adfab-gulp-boilerplate --save\n# After installation, gulpfile.js and gulp-config.json are created in project root.\n# Edit gulp-config.json to set vhost (local URL), sourceRoot, destinationRoot, and tasks.\n# Example:\n# {\n#   \"vhost\": \"http://mysite.local\",\n#   \"sourceRoot\": \"./src\",\n#   \"destinationRoot\": \"./dist\",\n#   \"tasks\": {\n#     \"styles\": {\n#       \"task\": \"sass\",\n#       \"source\": \"scss/main.scss\",\n#       \"destination\": \"css\"\n#     },\n#     \"scripts\": {\n#       \"task\": \"js\",\n#       \"source\": \"js/**/*.js\",\n#       \"destination\": \"js\"\n#     }\n#   }\n# }\n# Then run:\ngulp serve\n# This starts Browsersync with live reloading.","lang":"javascript","description":"Installs the boilerplate, auto-generates gulpfile.js and gulp-config.json, configures tasks for SASS and JS, and runs serve with Browsersync."},"warnings":[{"fix":"Ensure Gulp v4 is installed: npm install gulp@4 --save-dev","message":"gulp v4 is required – gulp v3 is not supported and will cause errors.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Remove trailing slashes from source and destination paths in gulp-config.json","message":"The 'source' and 'destination' fields in gulp-config.json must not end with a trailing slash, otherwise paths break.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Always specify the 'task' property, e.g., \"task\": \"copy\".","message":"The 'task' property is required for each task in gulp-config.json; if omitted, the task name is used but may conflict with internal Gulp tasks.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Set destination to a separate directory (e.g., dist/fonts) rather than the source folder.","message":"When using the 'copy' task, ensure the destination folder is different from source to avoid infinite loops.","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Upgrade Node.js to version >=10.","message":"Node.js <= 8 is no longer supported; newer versions may fail due to dependency updates.","severity":"breaking","affected_versions":">=2.4.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use require() instead of import: const gulp = require('gulp');","cause":"Using ES6 import syntax (import) with a CommonJS-only package.","error":"Error: 'default' is not exported by ..."},{"fix":"Install gulp-sass: npm install gulp-sass --save-dev, and ensure gulpfile.js includes the boilerplate tasks by requiring 'adfab-gulp-boilerplate'.","cause":"The 'sass' task is not registered because gulp-sass is not installed or configured properly.","error":"Error: Task 'sass' is not defined in your gulpfile."},{"fix":"Install Gulp v4 and require it in the global gulpfile: npm install gulp@4 --save-dev","cause":"gulp is not installed or not required in the gulpfile.","error":"ReferenceError: gulp is not defined"},{"fix":"Install browser-sync: npm install browser-sync --save-dev","cause":"browser-sync is missing; it's a required peer dependency.","error":"Module not found: Can't resolve 'browser-sync'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}