Gatsby-plugin-exifremove NPM

gatsby-plugin-exifremove

A Gatsby plugin for removing EXIF data from JPEG files at build time.

With this plugin, you can strip the EXIF data out of every JPEG file (.jpg or .jpeg) in the public directory of your gatsby project at build time.

NOTE: This plugin only processes images when run in production mode! To test it against your images, run: gatsby build && gatsby serve.

Installation

Install with yarn:

yarn add gatsby-plugin-exifremove

Or install with npm:

npm install --save gatsby-plugin-exifremove

Usage

After installing gatsby-plugin-exifremove you need to add it to the plugins array in your gatsby-config.js file:

module.exports = {
  plugins: ['gatsby-plugin-exifremove']
};

Options

This plugin takes the following options:

Name	Type	Default	Description
`debug`	`boolean`	`false`	Tells the plugin to generate debug output.
`matchPattern`	`string`	`"*/.{jpg,jpeg}"`	The pattern to use when searching for files under the `public` folder. The string `'public/'` will be added to this as a prefix.
`exifremoveConfig`	`Object`	(See below)	Configuration options to pass to exifremove. See below.

exifremove Configration

This plugin uses exifremove under the covers. To pass options to exifremove, add them to the exifremoveConfig: { } object in your gatsby-config.js entry.

The default configuration options are:

Name	Type	Default	Description
`verbose`	`boolean`	`false`	Tells exifremove to print verbose messages
`keepMarker`	`boolean`	`false`	Tells exifremove to keeps the APP1 marker in the JPEG

Example

gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: 'gatsby-plugin-exifremove',
      options: {
        debug: true, // debug optional, default false
        matchPattern: "**/*.{jpg,jpeg}", // optional, this is the default value
        exifremoveConfig: {
          verbose: false,
          keepMarker: false,
        }
      }
    }
  ]
};

Credits

gatsby-plugin-minify-html

This plugin is modeled after gatsby-plugin-minify-html and borrows significantly from that project.

exifremove

This plugin uses exifremove under the covers to process the JPEG files.

Disclaimer

I threw this plugin together very quickly, so use at your own risk! See the license for more info.

License

Licensed under MIT.

gatsby gatsby-plugin exif remove jpeg

exifremove glob

1.0.0

1 year ago

gatsby-plugin-exifremove v1.0.0