percy - npm Package Compare versions

Comparing version 0.15.2 to 0.16.0

.oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"0.15.2","commands":{"exec":{"id":"exec","description":"Start and stop Percy around a supplied command.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy exec -- echo \"percy is running around this echo command\"","$ percy exec -- bash -c \"echo foo && echo bar\""],"flags":{"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"finalize":{"id":"finalize","description":"Finalize a build. Commonly used for parallelized builds, especially when the number of parallelized processes is unknown.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy finalize --all\n[percy] Finalized parallel build."],"flags":{"all":{"name":"all","type":"boolean","char":"a","required":true,"allowNo":false}},"args":[]},"health-check":{"id":"health-check","description":"Determines if the Percy Agent process is currently running","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy healthcheck","$ percy healthcheck --port 6884"],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"percy-command":{"id":"percy-command","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[]},"snapshot":{"id":"snapshot","description":"Snapshot a directory containing a pre-built static website.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy snapshot _site/","$ percy snapshot _site/ --base-url \"/blog/\"","$ percy snapshot _site/ --ignore-files \"/blog/drafts/**\""],"flags":{"snapshot-files":{"name":"snapshot-files","type":"option","char":"s","description":"Glob or comma-seperated string of globs for matching the files and directories to snapshot.","default":"**/*.html,**/*.htm"},"ignore-files":{"name":"ignore-files","type":"option","char":"i","description":"Glob or comma-seperated string of globs for matching the files and directories to ignore.","default":""},"base-url":{"name":"base-url","type":"option","char":"b","description":"If your static files will be hosted in a subdirectory, instead \nof the webserver's root path, set that subdirectory with this flag.","default":"/"},"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"Asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"Port","default":5338}},"args":[{"name":"snapshotDirectory","description":"A path to the directory you would like to snapshot","required":true}]},"start":{"id":"start","description":"Starts the percy process.","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy start\ninfo: percy has started on port 5338."],"flags":{"detached":{"name":"detached","type":"boolean","char":"d","description":"start as a detached process","allowNo":false},"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"stop":{"id":"stop","description":"Stops the percy process.","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy stop\ninfo: percy has stopped."],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]}}}
+{"version":"0.16.0","commands":{"exec":{"id":"exec","description":"Start and stop Percy around a supplied command.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy exec -- echo \"percy is running around this echo command\"","$ percy exec -- bash -c \"echo foo && echo bar\""],"flags":{"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"finalize":{"id":"finalize","description":"Finalize a build. Commonly used for parallelized builds, especially when the number of parallelized processes is unknown.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy finalize --all\n[percy] Finalized parallel build."],"flags":{"all":{"name":"all","type":"boolean","char":"a","required":true,"allowNo":false}},"args":[]},"health-check":{"id":"health-check","description":"Determines if the Percy Agent process is currently running","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy healthcheck","$ percy healthcheck --port 6884"],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"percy-command":{"id":"percy-command","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[]},"snapshot":{"id":"snapshot","description":"Snapshot a directory containing a pre-built static website.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy snapshot _site/","$ percy snapshot _site/ --base-url \"/blog/\"","$ percy snapshot _site/ --ignore-files \"/blog/drafts/**\""],"flags":{"snapshot-files":{"name":"snapshot-files","type":"option","char":"s","description":"Glob or comma-seperated string of globs for matching the files and directories to snapshot.","default":"**/*.html,**/*.htm"},"ignore-files":{"name":"ignore-files","type":"option","char":"i","description":"Glob or comma-seperated string of globs for matching the files and directories to ignore.","default":""},"base-url":{"name":"base-url","type":"option","char":"b","description":"If your static files will be hosted in a subdirectory, instead \nof the webserver's root path, set that subdirectory with this flag.","default":"/"},"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"Asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"Port","default":5338}},"args":[{"name":"snapshotDirectory","description":"A path to the directory you would like to snapshot","required":true}]},"start":{"id":"start","description":"Starts the percy process.","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy start\ninfo: percy has started on port 5338."],"flags":{"detached":{"name":"detached","type":"boolean","char":"d","description":"start as a detached process","allowNo":false},"allowed-hostname":{"name":"allowed-hostname","type":"option","char":"h","description":"Allowable hostname(s) to capture assets from"},"network-idle-timeout":{"name":"network-idle-timeout","type":"option","char":"t","description":"asset discovery network idle timeout (in milliseconds)","default":50},"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"stop":{"id":"stop","description":"Stops the percy process.","pluginName":"percy","pluginType":"core","hidden":true,"aliases":[],"examples":["$ percy stop\ninfo: percy has stopped."],"flags":{"port":{"name":"port","type":"option","char":"p","description":"port","default":5338}},"args":[]},"upload":{"id":"upload","description":"Upload a directory containing static snapshot images.","pluginName":"percy","pluginType":"core","hidden":false,"aliases":[],"examples":["$ percy upload _images/","$ percy upload _images/ --files **/*.png"],"flags":{"files":{"name":"files","type":"option","char":"f","description":"Glob or comma-seperated string of globs for matching the files and directories to snapshot.","default":"**/*.png,**/*.jpg,**/*.jpeg"},"ignore":{"name":"ignore","type":"option","char":"i","description":"Glob or comma-seperated string of globs for matching the files and directories to ignore.","default":""}},"args":[{"name":"uploadDirectory","description":"A path to the directory containing static snapshot images","required":true}]}}}

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [0.16.0](https://github.com/percy/percy-agent/compare/v0.15.2...v0.16.0) (2019-09-25)
+
+
+### Features
+
+* ✨ Add ability to snapshot a directory of static images ([#353](https://github.com/percy/percy-agent/issues/353)) ([96f1ed5](https://github.com/percy/percy-agent/commit/96f1ed5))
+
 ## [0.15.2](https://github.com/percy/percy-agent/compare/v0.15.1...v0.15.2) (2019-09-24)
@@ -2,0 +9,0 @@

dist/configuration/configuration.d.ts

 import { AgentConfiguration } from './agent-configuration';
+import { ImageSnapshotsConfiguration } from './image-snapshots-configuration';
 import { SnapshotConfiguration } from './snapshot-configuration';
@@ -8,4 +9,5 @@ import { StaticSnapshotsConfiguration } from './static-snapshots-configuration';
     'static-snapshots': StaticSnapshotsConfiguration;
+    'image-snapshots': ImageSnapshotsConfiguration;
     agent: AgentConfiguration;
 }
 export declare const DEFAULT_CONFIGURATION: Configuration;

dist/configuration/configuration.js

@@ -27,2 +27,7 @@ "use strict";
     },
+    'image-snapshots': {
+        path: '.',
+        files: '**/*.png,**/*.jpg,**/*.jpeg',
+        ignore: '',
+    },
 };

dist/services/configuration-service.js

@@ -50,2 +50,8 @@ "use strict";
         }
+        if (flags.files) {
+            this.configuration['image-snapshots'].files = flags.files;
+        }
+        if (flags.ignore) {
+            this.configuration['image-snapshots'].ignore = flags.ignore;
+        }
         return this.configuration;
@@ -57,2 +63,5 @@ }
         }
+        if (args.uploadDirectory) {
+            this.configuration['image-snapshots'].path = args.uploadDirectory;
+        }
         return this.configuration;
@@ -59,0 +68,0 @@ }

package.json

 {
   "name": "percy",
   "description": "An agent process for integrating with Percy.",
-  "version": "0.15.2",
+  "version": "0.16.0",
   "author": "Perceptual Inc",
@@ -35,2 +35,3 @@ "bin": {
     "globby": "^10.0.1",
+    "image-size": "^0.8.2",
     "js-yaml": "^3.13.1",
@@ -148,3 +149,4 @@ "percy-client": "^3.0.3",
     "test-integration": "yarn build-client && node ./bin/run exec -h *.localtest.me -- mocha test/integration/**/*.test.ts",
-    "test-snapshot-command": "./bin/run snapshot test/integration/test-static-site -b /dummy-base-url -i '(red-keep)' -c '\\.(html)$'",
+    "test-snapshot-command": "./bin/run snapshot test/integration/test-static-site -b /dummy-base-url -i '(red-keep)' -s '\\.(html)$'",
+    "test-upload-command": "./bin/run upload test/integration/test-static-images",
     "version": "oclif-dev readme && git add README.md",
@@ -151,0 +153,0 @@ "watch": "npm-watch"

README.md

@@ -24,3 +24,3 @@ @percy/agent
 $ percy (-v|--version|version)
-percy/0.15.2 linux-x64 node-v10.16.3
+percy/0.16.0 linux-x64 node-v10.16.3
 $ percy --help [COMMAND]
@@ -38,2 +38,3 @@ USAGE
 * [`percy snapshot SNAPSHOTDIRECTORY`](#percy-snapshot-snapshotdirectory)
+* [`percy upload UPLOADDIRECTORY`](#percy-upload-uploaddirectory)
 
@@ -58,3 +59,3 @@ ## `percy exec`
 
-_See code: [dist/commands/exec.ts](https://github.com/percy/percy-agent/blob/v0.15.2/dist/commands/exec.ts)_
+_See code: [dist/commands/exec.ts](https://github.com/percy/percy-agent/blob/v0.16.0/dist/commands/exec.ts)_
 
@@ -77,3 +78,3 @@ ## `percy finalize`
 
-_See code: [dist/commands/finalize.ts](https://github.com/percy/percy-agent/blob/v0.15.2/dist/commands/finalize.ts)_
+_See code: [dist/commands/finalize.ts](https://github.com/percy/percy-agent/blob/v0.16.0/dist/commands/finalize.ts)_
 
@@ -131,3 +132,27 @@ ## `percy help [COMMAND]`
 
-_See code: [dist/commands/snapshot.ts](https://github.com/percy/percy-agent/blob/v0.15.2/dist/commands/snapshot.ts)_
+_See code: [dist/commands/snapshot.ts](https://github.com/percy/percy-agent/blob/v0.16.0/dist/commands/snapshot.ts)_
+
+## `percy upload UPLOADDIRECTORY`
+
+Upload a directory containing static snapshot images.
+
+```
+USAGE
+  $ percy upload UPLOADDIRECTORY
+
+ARGUMENTS
+  UPLOADDIRECTORY  A path to the directory containing static snapshot images
+
+OPTIONS
+  -f, --files=files    [default: **/*.png,**/*.jpg,**/*.jpeg] Glob or comma-seperated string of globs for matching the
+                       files and directories to snapshot.
+
+  -i, --ignore=ignore  Glob or comma-seperated string of globs for matching the files and directories to ignore.
+
+EXAMPLES
+  $ percy upload _images/
+  $ percy upload _images/ --files **/*.png
+```
+
+_See code: [dist/commands/upload.ts](https://github.com/percy/percy-agent/blob/v0.16.0/dist/commands/upload.ts)_
 <!-- commandsstop -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

135209

increased by9.15%

Number of package files

86

increased by7.5%

Lines of code

2428

increased by10.46%

Number of lines in readme file

154

increased by19.38%

Worsened metrics

Dependency count

20

increased by5.26%

Number of low supply chain risk alerts

14

increased by16.67%

Dependency changes

• + Addedimage-size@^0.8.2

• + Addedhas-symbols@1.0.3(transitive)

• + Addedimage-size@0.8.3(transitive)

• + Addedpsl@1.14.0(transitive)

• + Addedqueue@6.0.1(transitive)

• - Removedhas-symbols@1.1.0(transitive)

• - Removedpsl@1.15.0(transitive)