CHANGELOG.md

Changelog

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v11.3.0

January 27, 2023

Changed

• config.img.optimiseGIFs which allows more granular control over whether GIFs get optimised or not.
• config.img.optimiseJPEGs which allows more granular control over whether JPEGs get optimised or not.
• config.img.optimisePNGs which allows more granular control over whether PNGs get optimised or not.

v11.2.0

December 22, 2022

Changed

• config.img.optimiseSVGs which allows more granular control over whether SVGs get minified or not.

v11.1.0

December 22, 2022

Changed

• gulp-svgmin package updated to latest.
• Some other minor dependency updates.

v11.0.1

October 4, 2022

Fixed

• Assorted security updates via dependabot.

v11.0.0

August 1, 2022

Removed

• eyeglass package. Consuming applications will need to specify the path to modules correctly.
  • e.g 'import fozzie' > '@use @justeat/fozzie/src/scss/fozzie'

v10.6.0

July 26, 2022

Changed

• Upgraded the version of gulp-sass from 4.0.2 to 5.1.0

v10.5.1

May 27, 2022

Fixed

• Variable name

v10.5.0

May 25, 2022

Added

• customTasks property to JavaScript config.
  • This allows tasks (provided by the consuming application) to be run as part of the gulp:scripts command, in parallel with scripts:bundle.

v10.4.0

May 23, 2022

Fixed

• Failing images tasks.
• Character warnings, e.g., ❯❯ -> >>.

Changed

• Re-enable optimiseImages and spriteSvgs by default now that they're working again.

Removed

• Some unnecessary callbacks (they were showing as <anonymous> in the output).

v10.3.0

May 19, 2022

Changed

• Use circleci instead of Travis for CI

Fixed

• Use of spread operator for tasks:
  • service-worker
  • images:optimise
  • copy:img:docs
  • images:svg-sprite

v10.2.1

May 6, 2020

Fixed

• watch tasks so they work with Gulp v4.

v10.2.0

May 5, 2020

Changed

• Adapted the default task so that it works with Gulp v4.

v10.1.0

March 10, 2020

Changed

• Turns out there were more changes needed for Gulp v4 😆 Specifically, regarding runSequence (which no longer works in Gulp v4). Have converted these tasks to use gulp.series and gulp.parallel instead. This ahs been tested with how HomeWeb uses its default task – this is likely to need more specific testing/updates if/when we migrate this into other applications that use this package).

v10.0.0

March 6, 2020

Changed

• Upgrade gulp to v4 (so that it's now compatible with Node v12)

v9.1.0

February 19, 2020

Changed

• Upgrade jest-cli to v25, and use jest package instead to support runCLI command
• Minor package updates
• Destructure some imports

v9.0.1

December 11, 2019

Fixed

• Copy issue where for some reason the gulpif package was incorrectly stopping all images being copied over when gulp.dest was run. Have split out the base copy and the docs copy streams so they don't impact one another.

v9.0.0

November 12, 2019

Changed

• Updating dependencies. ESLint to v6, Eslint config updated to latest, and a host of other smaller dependency changes

v8.5.0

October 25, 2019

Changed

• problematic images:optimise and images:svg-sprite from images task can now be toggled on/off in config. default is off.

Fixed

• Linting in assemble.js.

v8.4.0

February 12, 2019

Fixed

• Adjusted copy:assets task so that it copies the assets over to the relevant docs folder when running in docs mode.

v8.3.0

November 27, 2018

Fixed

• Downgrading event-stream due to security vulnerability

Changed

• Updating package dependencies

v8.2.1

October 12, 2018

Changed

• Updating README with Babel 7 FAQ info

v8.2.0

October 12, 2018

Changed

• Babel 7 config is now added into the gulp-build-fozzie module directly, rther than managing in each separate project package.json. Resolutions for babel 7 bridge and Espree (Eslint fix) also added.

v8.1.1

October 10, 2018

Fixed

• README updated with Babel 7 config changes. Also includes note about adding Espree v3.5.4 as a resolution when adding linting with ESLint v6.

v8.1.0

October 10, 2018

Changed

• Updated f-templates-loader dependency.

v8.0.0

October 3, 2018

Changed

• Package dependency updates. Using the package will now require an upgrade to Babel 7.

v7.26.0

September 1, 2018

Added

• gulp-stylelint plugin replaces postcss for the SCSS compilation so that the task can autofix any issues (as the postcss plugin isn't capable of doing this).

Changed

• Updated eslint-config-fozzie dependency to remove warnings coming from airbnb-base config.
• Update a bunch of minor dependencies.

v7.25.0

August 24, 2018

Changed

• Updated eslint-config-fozzie dependency.

v7.24.0

August 23, 2018

Changed

• Use ES6 compatible uglify component

v7.23.0

August 20, 2018

Added

Can now lint sub-modules Sass (for local development) by using the --lintModules flag.

Changed

• Dependency on gulp-gh-pages removed in favour of our own forked version (as the maintainer had moved it to Gulp 4, which hasn't been released).
• Tests updated in line with config changes to CSS lintPaths

Removed

• Gemnasium removed from README

v7.22.0

August 3, 2018

Changed

• Lots of BAU package updates as well as for f-template-loader to allow importing inline SVGs.

v7.21.0

July 13, 2018

Changed

• Package versions updated (including gulp-gh-pages after contacting package owner).
• Updated to v2 of eslint-config-fozzie
• Quoted glob pattern in scripts lint config, as was picking up package names such as asn1.js incorrectly for linting.

Fixed

• New eslint config updates reflected in --fix of task js files

v7.20.1

July 10, 2018

Fixed

• Added resolutions value for gift, as gulp-gh-pages was using an old version of this package which was stopping the docs:deploy task from running.

v7.20.0

July 6, 2018

Added

• Adding copy:docs task for copying docs sites specific files (such as CNAME records)

v7.19.0

April 11, 2018

Added

• Added copy:img:docs task and documentation.

Changed

• The images:optimise no longer copies images into the docs asset dist folder.
• The images task now copies all of the images in the assets dist folder over to the docs dist folder if running a docs task.

v7.18.0

April 11, 2018

Changed

• Register shared templates as partials rather than helpers.

v7.17.0

April 10, 2018

Changed

• Updated f-templates-loader module.

v7.16.0

April 9, 2018

Added

• Added f-templates-loader module which handles locating and registering shared templates.
• Added config.docs.excludeTemplateDirs property to allow directories to be ignored when adding shared templates.

Changed

• .gitignore updated to exclude yalc config files

v7.15.0

April 3, 2018

Added

• ESLint flag for automatically fixing ESLint rule violations. Will now fix a number of issues in-line when the lint task is run. For more info, check out the fix rule in the ESLint docs and to see a list of the rules this will auto-fix, see the ESLint rule list.

Changed

• .gitignore updated to exclude yalc config files

v7.14.0

March 26, 2018

Added

• Tests added to take coverage to 100%
• Unminified JS files compiled to docs folder
• Lodash clonedeep added for deep cloning objects in tests

Changed

• Split out the tests into more manageable chunks

v7.13.0

March 8, 2018

Changed

• Default gulp tasks so that the logger file is created when gulp is run.
• Updated the pathBuilder jsErrorLoggerDir property to assetDistDir so it outputs in the correct directory.
• Updated pathBuilder unit tests.

v7.12.0

February 16, 2018

Added

• gulp-file to dependencies

Changed

• Add logger-file.js to tasks - this will add the server-side file required for the errorLogger to be inserted into the filesystem
• Add logger paths to config
• Add logger paths to pathbuilder
• Updated unit tests
• Added .idea to gitignore
• Updated config.logger.dir to be js
• Updated config.logger.subDir to be shared
• Updated readme docs

Remove

• Removed jsErrorLoggerDir from pathBuilder.js

v7.11.0

February 7, 2018

Changed

• Javascript task to handle versioning if usePackageVersion is set to true.

v7.10.0

February 7, 2018

Changed

• Changed imagemin config to maintain svg viewBox.

v7.9.0

February 2, 2018

Added

• stripDebug option to config.js to allow the inclusion of console statements in production builds.
• --noStripDebug command line flag.

Changed

• Jest rollback from v22.1.4 to v21.2.1.

v7.8.0

February 1, 2018

Added

• Added the ability to pass environment variables into the SCSS compilation
• Added $isDev, $isProd, $env and $server variables that are now available in Sass
• 🐻 added to fozzie log notification

Changed

• Minor package updates

v7.7.0

January 30, 2018

Added

• Run npm scripts concurrently.

Changed

• Updated eslint module versions.
• Updated jest version.
• Using Object.assign in jest task as object spread is only supported in node v8.6.0 and up.

Remove

• Removed eslint jest module as Jest is already specified within eslint-config-fozzie.

v7.6.0

January 30, 2018

Changed

• Updated f-copy-assets module.

v7.5.0

January 30, 2018

Fixed

• Fix the way that arguments are combined when calling jestTestRun.

v7.4.0

January 30, 2018

Changed

• Set passWithNoTests argument to true for all Jest test runs to prevent error when there are no tests in the project.

v7.3.0

January 30, 2018

Changed

• Set bail argument to true only when run in production.

v7.2.0

January 23, 2018

Changed

• Added usePackageVersion to config file to handle the css versioning, default value is set to false.
• Added packageVersion to config file which returns the current scoped package version.
• Updated config.test tests to cover the above changes.

v7.1.0

January 18, 2018

Changed

• Set bail argument to true for all Jest test runs so that it returns the correct exit code when a test run fails.

v7.0.0

January 17, 2018

Changed

• Whole host of packages updated. Main ones to know about are:
  • stylelint-config-fozzie updated to v2.0.0
  • Babelify and Browserify major version bumps to v8 and v15 respectively
• Updated the Danger config in Travis, as the call is now yarn danger ci to run the checks

v6.5.0

December 4, 2017

Changed

• Output unhashed, minified JS file

v6.4.0

December 4, 2017

Changed

• Move applyRevision variable out of the JS-only config so that it can be used for applying revision identifiers to the CSS files as well.
• Updated readme to reflect new config structure.
• Updated unit tests.

v6.3.0

October 18, 2017

Changed

• Updated dependencies.
• Updated jest.runCLI to match new signature.
• Moved duplicate jest calls out into a single function.
• Updated code formatting in css:bundle task.

v6.2.1

October 4, 2017

Changed

• Changed the log message to display the consuming package name and gulp-build-fozzie version.

v6.2.0

October 3, 2017

Changed

• Updated the CSS task so that it produces map files for both the concatenated and the minified files produced

v6.1.1

September 22, 2017

Changed

• Commit message for docs:deploy updated so that it doesn't clash with commit checks

v6.1.0

September 20, 2017

Changed

• Run cleanupIDs plugin to ensure all IDs are unique inside SVG sprite.

v6.0.0

September 1, 2017

Changed

• copy:assets task has moved from the css task to the images task.
• Changed the order in which the images tasks run — images are now copied, optimised, and then the SVG sprite is created.
• SVG sprite is created from assets found in the dist directory rather than src.

v5.5.3

August 25, 2017

Changed

• Lint task plumber only used in dev (so that it breaks the travis build if it errors)

v5.5.2

August 25, 2017

Added

• Better error handling for JS bundling so that errors in the browserify build don’t break the stream

v5.5.1

August 24, 2017

Changed

• Fixed a bug in copy:assets where the task callback was called too many times.

v5.5.0

August 24, 2017

Added

• Added config.importedAssets.verbose option.
• Added unit tests for config.importedAssets.verbose option.

Changed

• copy:assets task uses the f-copy-assets module rather than npm-assets
• The Readme config.importedAssets section was updated.

v5.4.0

August 22, 2017

Changed

• copy:assets task copies to config.assetDistDir instead of the pathBuilder.importedAssetsDistDir.
• css:bundle task loads the config.DistDir into postcss rather than importedAssetsDistDir
• The Readme copy:assets and config.importedAssets sections were updated.

Removed

• Removed config.importedAssets.importedAssetsDir .
• Removed pathBuilder.importedAssetsDistDir.
• Removed unit tests for above properties.
• Removed clean:assets task.
• The above properties and task were removed from the Readme.

v5.3.1

August 21, 2017

Changed

• License update

v5.3.0

August 18, 2017

Added

• Added the scripts:test:coverage task.

v5.2.0

August 18, 2017

Added

• Added docs:deploy and docs:release tasks.
• Added documentation for the new docs tasks.

Removed

• Removed debug from assemble task.
• Removed copy:fonts task from docs as it's called later in the default task.

Changed

• Renamed the Options section to Config in the README.

v5.1.0

August 16, 2017

Added

• Added browser-sync task along with config settings and tests.
• Added docsAssetsDistDir path to pathBuilder.

v5.0.0

August 16, 2017

Changed

• JavaScript task can now handle multiple files to be bundled via Browserify/Babel. Check the README for updated config changes.
• Updatd copy task error handling

v4.5.0

August 15, 2017

Changed

• test:cover task simplified.
• docs task now copies fonts correctly.
• default task refactored — now using the spread operator to conditionally add the service-worker task to runSequence.

v4.4.0

August 11, 2017

Changed

• Changed config.importedAssets.importedAssetsSrcGlob default option.
• copy:assets task no longer recursively checks dependencies of dependencies.
• Fixed a bug with the callback in copy:assets
• Dangerfile updated – result json couldn’t be accessed, so had to pass in result variable

Removed

• Removed watch:assets task.

v4.3.0

August 10, 2017

Added

• Added config.importedAssets object.
• Added imported assets paths to pathBuilder.
• Added copy:assets task.
• Added clean:assets task.
• Added watch:assets task.
• Unit tests added for new config and pathBuilder properties.
• The Readme Imported Assets config section was added.
• The Readme Imported Assets pathBuilder section was added.
• The Readme was updated to document the new tasks added.

Changed

• Updated clean task comments.
• The css:bundle task loads the importedAssetsDistDir into postcss, so that Fozzie modules can access assets copied there.

v4.2.0

August 8, 2017

Added

• Added config.fonts object.
• Added fonts paths to pathBuilder.
• Added copy.fonts object.
• Added copy:fonts task.
• Unit tests added for new config and pathBuilder properties.
• Unit tests added to test all config.copy properties are updated correctly.
• The Readme Fonts config section was added.
• The Readme Fonts pathBuilder section was added.

Changed

• Updated copy task comments.
• If no dest property is defined in the copy config then it will default to an empty string.
• Improved logging for copy tasks.
• The Readme config.copy and copy tasks sections were updated to include the new font additions.
• Updated copy task comments.

v4.1.1

August 8, 2017

Fixed

• Fixed lint errors in danger.js.

v4.1.0

August 7, 2017

Added

• Danger.js has been added to do basic PR checks. This will leave comments on the PR when the changelog hasn’t been updated, the version needs incrementing or if it thinks the README might need an update.

v4.0.0

August 4, 2017

Changed

• The return value is now an object containing the build, config, and pathBuilder objects instead of the build function.
• Service worker path no longer contains the service worker filename.

Added

• The Readme Setup section was updated to reflect the changes to the default return value.
• The Readme Path Builder section was added.

v3.8.0

August 3, 2017

Added

• Added copy:js, copy:css and copy:img tasks to copy over separate files without bundling. See README for more information.

v3.7.0

August 3, 2017

Added

• Added lint task which uses eslint to lint all of the JavaScript files in the project. The task is run — along with the test task — both BEFORE the package is packed and published, and on local npm install.

Changed

• The for...in loop in assemble.js was throwing eslint errors, in order to fix this we converted the loop to use Object.keys and forEach instead.

v3.6.0

August 2, 2017

Added

• config.docs.helpers object added for passing through helper function for handlebars to use

v3.5.0

August 2, 2017

Changed

• Updating numerous package dependencies in package.json and yarn.lock

v3.4.1

August 2, 2017

Fixed

• Fixed isProduction check for docs base URL.

v3.4.0

August 2, 2017

Changed

• Consistent formatting of gulp-if statements.

Fixed

• CSS sourcemap hack removed as the original issue appears to have been fixed.
• CSS sourcemaps are written to separate files.
• JavaScript sourcemaps are now written correctly.
• watch:docs task now outputs assets correctly.