Merge branch 'main' into master

Author: jwagner

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/typescript-node/.devcontainer/base.Dockerfile
+
+# [Choice] Node.js version: 16, 14, 12
+ARG VARIANT="16-buster"
+FROM mcr.microsoft.com/vscode/devcontainers/typescript-node:0-${VARIANT}
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment if you want to install an additional version of node using nvm
+# ARG EXTRA_NODE_VERSION=10
+# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"
+
+# [Optional] Uncomment if you want to install more global node packages
+# RUN su node -c "npm install -g <your-package-list -here>"

.devcontainer/devcontainer.json

@@ -0,0 +1,24 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.183.0/containers/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	"build": {
+		"dockerfile": "Dockerfile",
+		// Update 'VARIANT' to pick a Node version: 12, 14, 16
+		"args": {
+			"VARIANT": "16"
+		}
+	},
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"dbaeumer.vscode-eslint"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	// "remoteUser": "node"
+}

.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: 'https://registry.npmjs.org'  
+      - run: npm ci
+      - run: npm publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ '*' ]
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

.travis.yml

@@ -1,6 +1,6 @@
 # smartcrop-sharp
 
-[![Build Status](https://travis-ci.org/jwagner/smartcrop-sharp.svg?branch=master)](https://travis-ci.org/jwagner/smartcrop-sharp)
+[![Tests](https://github.com/jwagner/smartcrop-sharp/actions/workflows/tests.yml/badge.svg)](https://github.com/jwagner/smartcrop-sharp/actions/workflows/tests.yml)
 
 This is an adapter module for using [smartcrop.js](https://github.com/jwagner/smartcrop.js)
 with node.js using [sharp](https://github.com/lovell/sharp) for image decoding.

README.md

@@ -1,43 +1,6 @@
-/**
- * Describes a region to boost. A usage example of this is to take into account 
- * faces in the image. See `smartcrop-cli` for an example on how to integrate 
- * face detection in Node.js using ImageMagick with `smartcrop-gm`.
- * @see {@link https://github.com/jwagner/smartcrop.js#boost}
- * @see {@link https://github.com/jwagner/smartcrop-cli}
- */
-export interface Boost {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-  weight: number;
-}
-
-/**
- * All of the documented crop options. Note that there are many more (for now 
- * undocumented) options available. Check the source and be advised that they 
- * might change in the future.
- * @see {@link https://github.com/jwagner/smartcrop.js#cropoptions}
- * @see {@link https://github.com/jwagner/smartcrop.js/blob/master/smartcrop.js#L32}
- */
-export interface CropOptions {
-  minScale?: number;
-  width: number;
-  height: number;
-  boost?: Boost[];
-  ruleOfThirds?: boolean;
-  debug?: boolean;
-}
+/// <reference types="smartcrop" />
 
-/**
- * Result of the promise returned by `smartcrop.crop`. Contains a single 
- * individual crop that can then be used by `sharp` to extract your image.
- * @see {@link https://github.com/jwagner/smartcrop.js#cropresult}
- * @see {@link https://github.com/jwagner/smartcrop.js#crop}
- */
-export interface CropResult {
-  topCrop: { x: number; y: number; width: number; height: number; };
-}
+import { CropOptions, CropResult } from "smartcrop";
 
 /**
  * Find the best crop for *image* using *options*.
@@ -47,3 +10,4 @@ export interface CropResult {
  * used by `sharp` to extract your final image.
  */
 export function crop(image: Buffer | string, cropOptions: CropOptions): Promise<CropResult>;
+