@depup/sharp-cli 5.2.0-depup.0

package/cmd/output.js

@@ -0,0 +1,125 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Mark van Seventer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.pixelplumbing.com/api-output#tile
+
+// Strict mode.
+'use strict'
+
+// Package modules.
+const pick = require('lodash.pick')
+
+// Local modules.
+const constants = require('../lib/constants')
+const queue = require('../lib/queue')
+
+// Configure.
+const positionals = {
+  size: {
+    desc: 'Tile size in pixels',
+    defaultDescription: 256,
+    type: 'number'
+  }
+}
+
+const options = {
+  angle: {
+    choices: [0, 90, 180, 270],
+    defaultDescription: '0',
+    desc: 'Tile angle of rotation'
+  },
+  background: {
+    defaultDescription: 'rgb(255, 255, 255, 1)',
+    desc: 'Background colour, parsed by the color module',
+    type: 'string'
+  },
+  basename: {
+    desc: 'The name of the directory within the zip file',
+    type: 'string'
+  },
+  center: {
+    alias: 'centre',
+    desc: 'Center images in tile',
+    type: 'boolean'
+  },
+  container: {
+    choices: constants.CONTAINER,
+    defaultDescription: 'fs',
+    desc: 'Tile container'
+  },
+  depth: {
+    choices: constants.DEPTH,
+    defaultDescription: 'auto',
+    desc: 'Pyramid depth'
+  },
+  id: {
+    defaultDescription: 'https://example.com/iiif',
+    desc: 'Set the @id/id attribute of info.json',
+    type: 'string'
+  },
+  layout: {
+    choices: constants.LAYOUT,
+    defaultDescription: 'dz',
+    desc: 'Filesystem layout'
+  },
+  overlap: {
+    desc: 'Tile overlap in pixels',
+    defaultDescription: '0',
+    type: 'number'
+  },
+  skipBlanks: {
+    defaultDescription: -1,
+    desc: 'Threshold to skip tile generation',
+    type: 'number'
+  }
+}
+const optionNames = Object.keys(options)
+
+// Command builder.
+const builder = (yargs) => {
+  return yargs
+    .strict()
+    .example('$0 tile 512', 'output.dz is the Deep Zoom XML definition, output_files contains 512×512 tiles grouped by zoom level')
+    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-output#tile')
+    .positional('size', positionals.size)
+    .options(options)
+    .group(optionNames, 'Command Options')
+}
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(['tile', (sharp) => {
+    return sharp.tile({
+      size: args.size,
+      ...pick(args, optionNames)
+    })
+  }])
+}
+
+// Exports.
+module.exports = {
+  command: 'tile [size]',
+  describe: 'Use tile-based deep zoom (image pyramid) output',
+  builder,
+  handler
+}

package/cmd/resizing/extend.js

@@ -0,0 +1,102 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Mark van Seventer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.dimens.io/api-resize#extend
+
+// Strict mode.
+'use strict'
+
+// Package modules.
+const pick = require('lodash.pick')
+
+// Local modules.
+const constants = require('../../lib/constants')
+const queue = require('../../lib/queue')
+
+// Configure.
+const positionals = {
+  bottom: {
+    desc: 'Pixel count to add to the bottom edge',
+    type: 'number'
+  },
+  left: {
+    desc: 'Pixel count to add to the left edge',
+    type: 'number'
+  },
+  right: {
+    desc: 'Pixel count to add to the right edge',
+    type: 'number'
+  },
+  top: {
+    desc: 'Pixel count to add to the top edge',
+    type: 'number'
+  }
+}
+
+const options = {
+  background: {
+    defaultDescription: 'rgba(0, 0, 0, 1)',
+    desc: 'Background colour, parsed by the color module',
+    type: 'string'
+  },
+  extendWith: {
+    choices: constants.EXTEND_WITH,
+    default: 'background',
+    desc: 'Populate new pixels using this method'
+  }
+}
+
+// Command builder.
+const builder = (yargs) => {
+  const optionNames = Object.keys(options)
+  return yargs
+    .strict()
+    .example('$0 extend 10 20 10 10 --background rgba(0,0,0,0)', 'Add 10 transparent pixels to the top, left, and right edges, and 20 to the bottom edge')
+    .example('$0 extend 0 10 0 0 --background red', 'Add 10 red pixels to the bottom edge.')
+    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#extend')
+    .positional('top', positionals.top)
+    .positional('bottom', positionals.bottom)
+    .positional('left', positionals.left)
+    .positional('right', positionals.right)
+    .options(options)
+    .group(optionNames, 'Command Options')
+}
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(['extend', (sharp) => {
+    return sharp.extend({
+      background: args.background,
+      extendWith: args.extendWith,
+      ...pick(args, Object.keys(positionals))
+    })
+  }])
+}
+
+// Exports.
+module.exports = {
+  command: 'extend <top> <bottom> <left> <right>',
+  describe: 'Extends/pads the edges of the image with the provided background colour',
+  builder,
+  handler
+}

package/cmd/resizing/extract.js

@@ -0,0 +1,79 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Mark van Seventer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.dimens.io/api-resize#extract
+
+// Strict mode.
+'use strict'
+
+// Package modules.
+const pick = require('lodash.pick')
+
+// Local modules.
+const queue = require('../../lib/queue')
+
+// Configure.
+const positionals = {
+  height: {
+    desc: 'Height of region to extract',
+    type: 'number'
+  },
+  left: {
+    desc: 'Zero-indexed offset from left edge',
+    type: 'number'
+  },
+  top: {
+    desc: 'Zero-indexed offset from top edge',
+    type: 'number'
+  },
+  width: {
+    desc: 'Width of region to extract',
+    type: 'number'
+  }
+}
+
+// Command builder.
+const builder = (yargs) => {
+  return yargs
+    .strict()
+    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#extract')
+    .positional('top', positionals.top)
+    .positional('left', positionals.left)
+    .positional('width', positionals.width)
+    .positional('height', positionals.height)
+}
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(['extract', (sharp) => {
+    return sharp.extract(pick(args, Object.keys(positionals)))
+  }])
+}
+
+// Exports.
+module.exports = {
+  command: 'extract <top> <left> <width> <height>',
+  describe: 'Extract a region of the image',
+  builder,
+  handler
+}

package/cmd/resizing/resize.js

@@ -0,0 +1,124 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Mark van Seventer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.pixelplumbing.com/api-resize/
+
+// Strict mode.
+'use strict'
+
+// Package modules.
+const pick = require('lodash.pick')
+
+// Local modules.
+const constants = require('../../lib/constants')
+const queue = require('../../lib/queue')
+
+// Configure.
+const positionals = {
+  width: {
+    default: null,
+    desc: 'Pixels wide the resultant image should be',
+    type: 'number'
+  },
+  height: {
+    default: null,
+    desc: 'Pixels high the resultant image should be',
+    type: 'number'
+  }
+}
+
+const options = {
+  background: {
+    defaultDescription: 'rgba(0, 0, 0, 1)',
+    desc: 'Background colour when fit is contain, parsed by the color module.',
+    type: 'string'
+  },
+  fastShrinkOnLoad: {
+    defaultDescription: true,
+    desc: 'Take greater advantage of the JPEG and WebP shrink-on-load feature',
+    type: 'boolean'
+  },
+  fit: {
+    choices: constants.FIT,
+    defaultDescription: 'cover',
+    desc: 'How the image should be resized to fit both provided dimensions'
+  },
+  kernel: {
+    choices: constants.KERNEL,
+    defaultDescription: 'lanczos3',
+    desc: 'The kernel to use for image reduction and the inferred interpolator to use for upsampling'
+  },
+  position: {
+    choices: [...constants.GRAVITY, ...constants.POSITION, ...constants.STRATEGY],
+    defaultDescription: 'centre',
+    desc: 'Position, gravity, or strategy to use when fit is cover or contain'
+  },
+  withoutEnlargement: {
+    desc: 'Do not enlarge if the width or height are already less than the specified dimensions',
+    type: 'boolean'
+  },
+  withoutReduction: {
+    desc: 'Do not reduce if the width or height are already greater than the specified dimensions',
+    type: 'boolean'
+  }
+}
+const optionNames = Object.keys(options)
+
+// Command builder.
+const builder = (yargs) => {
+  return yargs
+    .strict()
+    .example('$0 resize 100', 'The output will be 100 pixels wide, auto-scaled height')
+    .example('$0 resize --height 100', 'The output will be 100 pixels high, auto-scaled width')
+    .example('$0 resize 200 300 --background rgba(255,255,255,0.5) --fit contain --kernel nearest --position "right top"', 'The output will be 200 pixels wide and 300 pixels high containing a nearest-neighbour scaled version contained within the north-east corner of a semi-transparent white canvas')
+    .example('$0 resize 200 200 --fit cover --position entropy', 'The output will be a 200px square auto-cropped image')
+    .example('$0 resize 200 200 --withoutEnlargement', 'The output will be no wider and no higher than 200 pixels, and no larger than the input image')
+    .example('$0 resize 200 200 --withoutReduction', 'The output will be at least 200 pixels wide and 200 pixels high while maintaining aspect ratio, and no smaller than the input image')
+    .epilog('For more information on available options, please visit https://sharp.pixelplumbing.com/api-resize/')
+    .positional('width', positionals.width)
+    .positional('height', positionals.height)
+    .check(argv => {
+      if (argv.width === null && argv.height === null) {
+        throw new Error('Expected at least one of width and height positionals')
+      }
+      return true
+    })
+    .options(options)
+    .group(optionNames, 'Command Options')
+}
+
+// Command handler.
+const handler = (args) => {
+  // @see https://sharp.pixelplumbing.com/api-resize#resize
+  return queue.push(['resize', (sharp) => {
+    return sharp.resize(args.width, args.height, pick(args, optionNames))
+  }])
+}
+
+// Exports.
+module.exports = {
+  command: 'resize [width] [height]',
+  describe: 'Resize image to width, height, or width × height',
+  builder,
+  handler
+}

package/cmd/resizing/trim.js

@@ -0,0 +1,82 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Mark van Seventer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+// @see https://sharp.dimens.io/api-resize#trim
+
+// Strict mode.
+'use strict'
+
+// Local modules.
+const queue = require('../../lib/queue')
+
+// Configure.
+const positionals = {
+  threshold: {
+    desc: 'The allowed difference from the top-left pixel',
+    defaultDescription: 10,
+    type: 'number'
+  }
+}
+
+const options = {
+  background: {
+    defaultDescription: 'top-left pixel',
+    desc: 'Background colour, parsed by the color module',
+    type: 'string'
+  },
+  lineArt: {
+    default: false,
+    desc: 'Does the input more closely resemble line art rather than being photographic',
+    type: 'boolean'
+  }
+}
+
+// Command builder.
+const builder = (yargs) => {
+  const optionNames = Object.keys(options)
+  return yargs
+    .strict()
+    .example('$0 trim', 'Trim pixels with a colour similar to that of the top-left pixel')
+    .example('$0 trim 0', 'Trim pixels with the exact same colour as that of the top-left pixel')
+    .example('$0 trim --background "#FF0000"', 'Trim pixels with a similar colour to red')
+    .example('$0 trim 42 --background yellow', 'Trim all "yellow-ish" pixels')
+    .epilog('For more information on available options, please visit https://sharp.dimens.io/api-resize#trim')
+    .positional('threshold', positionals.threshold)
+    .options(options)
+    .group(optionNames, 'Command Options')
+}
+
+// Command handler.
+const handler = (args) => {
+  return queue.push(['trim', (sharp) => {
+    return sharp.trim({ background: args.background, lineArt: args.lineArt, threshold: args.threshold })
+  }])
+}
+
+// Exports.
+module.exports = {
+  command: 'trim [threshold]',
+  describe: 'Trim pixels from all edges that contain values similar to the given background color, which defaults to that of the top-left pixel',
+  builder,
+  handler
+}