@percy/report 0.0.3 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +23 -3
  2. package/bin/cli.js +2 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  ```sh
7
7
 
8
- npm install https://github.com/browserstackce/percy-report.git -g
8
+ npm install @percy/report
9
9
 
10
10
  ```
11
11
 
@@ -22,7 +22,7 @@ export PERCY_TOKEN=<read-only | full-access>
22
22
  <h3>Generate Report - Per Build</h3>
23
23
 
24
24
  ```sh
25
- percy-report generate <buildId> [options]
25
+ npx percy-report generate <buildId> [options]
26
26
  ```
27
27
  Note: Build ID can be found in the URL of the Percy Dashboard as well as the REST API data.
28
28
  Example Build URL: `https://percy.io/<projectId>/PercyReporting/builds/<buildId>`
@@ -53,7 +53,7 @@ npx percy-report generate $BUILD_ID
53
53
  <h3>Generate Project Summary</h3>
54
54
 
55
55
  ```sh
56
- percy-report summary <project-slug> [options]
56
+ npx percy-report summary <project-slug> [options]
57
57
  ```
58
58
 
59
59
  Note: Project Slug is equal to Project Name on your percy dashboard
@@ -68,3 +68,23 @@ Note: Project Slug is equal to Project Name on your percy dashboard
68
68
  ```
69
69
 
70
70
  *Note: Interval between start date and end date should not exceed 30 days.*
71
+
72
+ # Examples
73
+
74
+ ## Web Percy
75
+
76
+ #### Build Report
77
+ ![percy_web_build_report](example/screenshots/percy_build_report_web.png)
78
+ #### Summary Report
79
+ ![percy_web_summary_report](example/screenshots/percy_summary_report_web.png)
80
+
81
+ ## App Percy
82
+
83
+ #### Build Report
84
+ ![percy_app_build_report](example/screenshots/percy_build_report_app.png)
85
+
86
+ #### Summary Report
87
+ ![percy_app_summary_report](example/screenshots/percy_summary_report_app.png)
88
+
89
+
90
+
package/bin/cli.js CHANGED
@@ -5,10 +5,11 @@ const { ar } = require('date-fns/locale');
5
5
  const { Generate,Summary } = require('../src');
6
6
  const program = new Command();
7
7
  const {endOfDay,startOfDay} = require('date-fns')
8
+ const {version} = require('../package.json')
8
9
 
9
10
  program.name('percy-report')
10
11
  .description('Generate Percy Reports & Download Images Locally')
11
- .version('0.0.2')
12
+ .version(version)
12
13
 
13
14
  program.command('generate')
14
15
  .description('Genetate Report')
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@percy/report",
3
3
  "description": "Package to generate a build report and project summary report for Percy, BrowserStack's visual testing platform",
4
- "version": "0.0.3",
4
+ "version": "0.0.5",
5
5
  "main": "src/index.js",
6
6
  "license": "MIT",
7
7
  "author": "BrowserStack Pvt Ltd",
@@ -51,4 +51,4 @@
51
51
  "chai": "^4.3.7",
52
52
  "mocha": "^10.2.0"
53
53
  }
54
- }
54
+ }