Flexible sharp integration for Metalsmith.
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.babelrc
.eslintrc.js
.gitignore
CONTRIBUTING.md
README.md
circle.yml
package.json

README.md

metalsmith-sharp

A fully flexible sharp implementation for Metalsmith

MIT License js-standard-style Build Status CodeCov Badge bitHound Code semantic-release Commitizen friendly

Install

npm install --save metalsmith-sharp

Usage

Just use it as regular Metalsmith plugin. If your environment does not support the import syntax, see further below.

import Metalsmith from 'metalsmith'
import sharp from 'metalsmith-sharp'

Metalsmith('/path/to/project')
  .use(sharp({
    methods: [
      {
        name: 'resize',
        args: [ 200, 200 ]
      },
      { name: 'max' },
      {
        name: 'toFormat',
        args: [ 'jpeg' ]
      }
    ]
  }))
  .build()

You can also do multiple image manipulations in one call:

import Metalsmith from 'metalsmith'
import sharp from 'metalsmith-sharp'

Metalsmith('/path/to/project')
  .use(sharp([
    {
      namingPattern: '{dir}{name}-version-1{ext}',
      methods: [
        { name: 'normalize' },
        { name: 'flop' },
        {
          name: 'trim',
          args: 15
        }
      ]
    },
    {
      namingPattern: '{dir}{name}-version-2{ext}',
      methods: [
        { name: 'normalize' },
        {
          name: 'trim',
          args: 30
        }
      ]
    }
  ]))
  .build()

Node 6

const sharp = require('metalsmith-sharp')

Node 4

A version for the LTS version of node is also supplied. You can require it like this:

const sharp = require('metalsmith-sharp/dist/node4')

For further examples can be found in the test directory.

Options

Default options:

{
  src: '**/*.jpg',
  namingPattern: '{dir}{base}',
  methods: [],
  moveFile: false
}

methods

Array of method objects that will trigger the corresponding sharp method. They will be called with the passed arguments and in the given order.

Check the sharp API documentation for a full list of supported methods.

{
  methods: [
    {
      name: 'anySharpMethod',
      args: [ 400, 300 ]
    }
  ]
}

args

args can be specified as an array that will be passed directly into the method or as a callback function.

The callback function will be provided with the image metadata and should return an array.

{
  method: [
    {
      name: 'resize',
      args: (metadata) => ([
        Math.round(metadata.width * 0.5),
        Math.round(metadata.height * 0.5)
      ])
    }
  ]
}

src

Glob for matching source files. All minimatch features are supported.

{
  src: '**/*.jpg'
}

namingPattern

Renaming pattern for the resulting file. By default, the input file will be overwritten.

Supported placeholders:

  • {dir}: Directory of file followed by slash
  • {base}: Full filename with extension
  • {name}: Filename without extension
  • {ext}: File extension with leading dot
{
  namingPattern: '{dir}/{name}-thumb{ext}'
}

moveFile

If the resulting file has a different name, the default behavior is to create a new file and keep the input file. Set this option to true to delete the input file.

{
  moveFile: true
}

Development

This project follows the standard coding and the conventional changelog commit message style. Also it is configured to never decrease the code coverage of its tests.

Also make sure you check out all available npm scripts via npm run.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. But before doing anything, please read the CONTRIBUTING.md guidelines.