♻️ Use minHeight option rather than minimumHeight

The config and all public facing docs specify min-height, but the API expects minimum-height. This confusion caused minHeight to not be accounted for since all methods dealing with the API were looking for minimumHeight.
percy · Aug 20, 2020 · 6b9cf5d · 6b9cf5d
1 parent 5be796e
commit 6b9cf5d
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 13 deletions.
diff --git a/packages/cli-upload/src/commands/upload.js b/packages/cli-upload/src/commands/upload.js
@@ -102,7 +102,7 @@ export class Upload extends Command {
       await this.client.sendSnapshot({
         // width and height is clamped to API min and max
         widths: [Math.max(10, Math.min(width, 2000))],
-        minimumHeight: Math.max(10, Math.min(height, 2000)),
+        minHeight: Math.max(10, Math.min(height, 2000)),
         resources: createImageResources(name, buffer, width, height),
         name
       });

diff --git a/packages/client/README.md b/packages/client/README.md
@@ -27,7 +27,7 @@ await client.createBuild()
 await client.sendSnapshot({
   name,
   widths,
-  minimumHeight,
+  minHeight,
   enableJavaScript,
   clientInfo,
   environmentInfo,

diff --git a/packages/client/src/client.js b/packages/client/src/client.js
@@ -286,7 +286,7 @@ export default class PercyClient {
   async createSnapshot({
     name,
     widths,
-    minimumHeight,
+    minHeight,
     enableJavaScript,
     clientInfo,
     environmentInfo,
@@ -305,7 +305,7 @@ export default class PercyClient {
         attributes: {
           name: name || null,
           widths: widths || null,
-          'minimum-height': minimumHeight || null,
+          'minimum-height': minHeight || null,
           'enable-javascript': enableJavaScript || null
         },
         relationships: {

diff --git a/packages/client/test/client.test.js b/packages/client/test/client.test.js
@@ -447,7 +447,7 @@ describe('PercyClient', () => {
           .createSnapshot({
             name: 'snapfoo',
             widths: [1000],
-            minimumHeight: 1000,
+            minHeight: 1000,
             enableJavaScript: true,
             clientInfo: 'sdk/info',
             environmentInfo: 'sdk/env',

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -65,7 +65,7 @@ percy.snapshot({
   url: 'http://localhost:3000',  // required url
   domSnapshot: domSnapshot,      // required DOM string
   widths: [500, 1280],           // widths to discover resources
-  minimumHeight: 1024,           // minimum height used when screenshotting
+  minHeight: 1024,               // minimum height used when screenshotting
   percyCSS: '',                  // percy specific css to inject
   requestHeaders: {},            // asset request headers such as authorization
   clientInfo: '',                // user-agent client info for the SDK

diff --git a/packages/core/src/percy.js b/packages/core/src/percy.js
@@ -167,7 +167,7 @@ export default class Percy {
     name,
     domSnapshot,
     widths,
-    minimumHeight,
+    minHeight,
     percyCSS,
     requestHeaders,
     enableJavaScript,
@@ -188,7 +188,7 @@ export default class Percy {
     // normalize the URL
     url = normalizeURL(url);
     // fallback to instance minimum height
-    minimumHeight = minimumHeight ?? this.config.snapshot.minimumHeight;
+    minHeight = minHeight ?? this.config.snapshot.minHeight;
     // combine snapshot Percy CSS with instance Percy CSS
     percyCSS = [this.config.snapshot.percyCSS, percyCSS].filter(Boolean).join('\n');
     // combine snapshot request headers with instance request headers
@@ -248,7 +248,7 @@ export default class Percy {
       this.#snapshots.push(() => this.client.sendSnapshot({
         name,
         widths,
-        minimumHeight,
+        minHeight,
         enableJavaScript,
         clientInfo,
         environmentInfo,

diff --git a/packages/core/types/index.d.ts b/packages/core/types/index.d.ts
@@ -6,7 +6,7 @@ interface Pojo { [x: string]: any; }
 
 export interface SnapshotOptions {
   widths?: number[];
-  minimumHeight?: number;
+  minHeight?: number;
   percyCSS?: string;
   requestHeaders?: Pojo;
   enableJavaScript?: boolean;

diff --git a/packages/core/types/index.test-d.ts b/packages/core/types/index.test-d.ts
@@ -13,7 +13,7 @@ const percyOptions: PercyOptions = {
   config: '.percy.yml',
   snapshot: {
     widths: [1280],
-    minimumHeight: 1024,
+    minHeight: 1024,
     percyCSS: '.percy { color: purple; }',
     requestHeaders: { Authorization: 'foobar' },
     enableJavaScript: false
@@ -60,7 +60,7 @@ expectType<void>(await percy.snapshot({
   url: 'http://localhost:3000',
   domSnapshot: '...',
   widths: [1000],
-  minimumHeight: 1000,
+  minHeight: 1000,
   percyCSS: '.foo { font-weight: 900; }',
   requestHeaders: { 'x-testing': 'test' },
   enableJavaScript: true
@@ -101,7 +101,7 @@ expectType<void>(await percy.capture({
     execute: async page => {}
   }],
   widths: [1000],
-  minimumHeight: 1000,
+  minHeight: 1000,
   percyCSS: '.foo { font-weight: 900; }',
   requestHeaders: { 'x-testing': 'test' },
   enableJavaScript: true