CHANGELOG.md

Changelog

1.1.1

• Fix for webpack 4 pre-4.40 not having compilation.emitAsset

1.1

• Plugin source is now TypeScript and type declaration files are included when installed from npm

1.0

• First stable release! 🎉
• Plugin now accepts a single options object to match the webpack convention.
• Added schema validation for plugin configuration.
• Dropped support for deprecated camel-cased option names. "changefreq", "filename", "lastmod", and "skipgzip" must now be lowercase.
• To upgrade from 0.x: 1) change the plugin arguments to a single object as detailed below, and 2) downcase any camel-cased option names as mentioned in the previous bullet.

// Before:
{
  // snip
  plugins: [
    new SitemapPlugin(
      'https://mysite.com',
      [
        {
          path: '/foo/',
          lastMod: '2015-01-04',
          priority: '0.8',
          changeFreq: 'daily'
        },
        {
          path: '/bar/',
        }
      ],
      {
        fileName: 'map.xml',
        lastMod: true,
        changeFreq: 'monthly',
        priority: '0.4'
      }
    )
  ]
}

// After:
{
  // snip
  plugins: [
    new SitemapPlugin({
      base: 'https://mysite.com',
      paths: [
        {
          path: '/foo/',
          lastmod: '2015-01-04',
          priority: 0.8,
          changefreq: 'daily'
        },
        {
          path: '/bar/',
        }
      ],
      options: {
        filename: 'map.xml',
        lastmod: true,
        changefreq: 'monthly',
        priority: 0.4
      }
    })
  ]
}

0.9.0

• Use new API on webpack 5 to remove deprecation warning.

0.8.1

• Use native new Date().toISOString() to generate dates, rather than a more complicated custom date function. This prevents an error in certain locales.

0.8.0

• If more than 50,000 paths are provided, automatically split up into multiple sitemap files linked by a sitemap index

0.7.1

• Updated and expanded README documentation
• Standardize on non-camel-cased configuration values for consistency with underlying sitemap package (camel-cased values are still supported for backwards compatibility)
• Allow providing a top-level date string for lastmod (if a boolean true is provided, the current date will still be used for backwards compatibility)

0.7.0

• Switched to sitemap package for generating sitemaps under the hood, which provides more configuration options

0.6.0

• Upgrade for compatibility with webpack 4 (breaks compatibility with webpack <=3)

0.5.1

• Fix bug where gzip error would hang compilation rather than reporting and continuing

0.5.0

• Add optional formatter configuration

0.4.0

• Convert plugin source to ES6

0.3.0

• Emit gzipped sitemap alongside the unzipped file (skippable with skipGzip configuration)

0.2.2

• Ignore various development files

0.2.1

• Fix size function in emitted asset (bug where wrong variable name was used)

0.2.0

• Change API to accept base, paths, options as arguments
• Add fileName configuration option
• Allow passing an array of path objects in addition to strings
• Misc other improvements

0.1.2

• Update lastmod date string format to match W3C spec

0.1.1

• Add global option properties for lastMod, priority, and changeFreq

0.1.0

• Initial release