Skip to content

Commit 1ea43a4

Browse files
Porting over my Personal SFCC DevOps Projects to New SFCC DevOps GitHub Org
1 parent 3655269 commit 1ea43a4

File tree

16 files changed

+77
-72
lines changed

16 files changed

+77
-72
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Thank you for Contributing
55

66
We want to make it as easy as possible to contribute changes.
77

8-
Follow the requirements below for __[Creating Issues](https://github.com/redvanworkshop/accessibility-tester/issues/new)__ and __[Pull Requests](https://github.com/redvanworkshop/accessibility-tester/pull/new)__, to keep everything simple for everyone :)
8+
Follow the requirements below for __[Creating Issues](https://github.com/sfccdevops/accessibility-tester/issues/new)__ and __[Pull Requests](https://github.com/sfccdevops/accessibility-tester/pull/new)__, to keep everything simple for everyone :)
99

1010
<img src="https://octodex.github.com/images/dinotocat.png" width="400" />
1111

@@ -24,4 +24,4 @@ Before you can submit a PR, you will need to:
2424
2. Commit & Push your New Branch, with a comment like `Fixes #3` to auto trigger a status change for that issue
2525
3. Make your Pull Request into the `master`
2626
4. Set `Reviewers` and `Assignees` to `Peter Schmalfeldt` ( or other project administrator )
27-
5. Choose an appropriate label from the `Labels`
27+
5. Choose an appropriate label from the `Labels`

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Red Van Workshop
3+
Copyright (c) 2019 SFCC DevOps
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
![Logo](docs/img/logo.png "Logo")
1+
![Logo](https://sfccdevops.s3.amazonaws.com/logo-128.png "Logo")
22

33
Accessibility Tester
44
---
55

6-
> Command Line Interface for Automated Accessibility Testing RVW Client Websites
6+
> Command Line Interface for Automated Accessibility Testing Salesforce Commerce Cloud Websites
77
8-
![markdown](https://rvw-a11y.s3.amazonaws.com/markdown.gif?v=1.0.0)
8+
![markdown](https://sfcc-a11y.s3.amazonaws.com/markdown.gif?v=1.0.0)
99

1010
Introduction
1111
---
@@ -24,9 +24,9 @@ Developer Overview
2424

2525
#### Commands
2626

27-
* [`rvw-a11y`](docs/cmd-a11y.md) - Detailed Examples of `rvw-ally` Usage
28-
* [`rvw-a11y auth`](docs/cmd-auth.md) - Generate HTTP Authentication Tokens
29-
* [`rvw-a11y help`](docs/cmd-help.md) - Get Help when you need it
27+
* [`sfcc-a11y`](docs/cmd-a11y.md) - Detailed Examples of `sfcc-ally` Usage
28+
* [`sfcc-a11y auth`](docs/cmd-auth.md) - Generate HTTP Authentication Tokens
29+
* [`sfcc-a11y help`](docs/cmd-help.md) - Get Help when you need it
3030

3131
#### Additional Information
3232

@@ -44,18 +44,18 @@ Install
4444
#### `npm install`
4545

4646
```bash
47-
npm install -g rvw-accessibility-tester
48-
rvw-a11y help
47+
npm install -g sfcc-accessibility-tester
48+
sfcc-a11y help
4949
```
5050

5151
#### `git clone`
5252

5353
```bash
5454
cd ~
55-
git clone https://github.com/redvanworkshop/accessibility-tester.git
55+
git clone https://github.com/sfccdevops/accessibility-tester.git
5656
cd accessibility-tester
5757
npm install -g
58-
rvw-a11y help
58+
sfcc-a11y help
5959
```
6060

6161
Report Samples
@@ -65,15 +65,20 @@ We worked extensively to make the most helpful reports possible. Whether you ar
6565

6666
Since this is a CLI tool, the default output is in a terminal window.
6767

68-
![sample-report](https://rvw-a11y.s3.amazonaws.com/sample-report/cli.jpg?v=1.0.0)
68+
![sample-report](https://sfcc-a11y.s3.amazonaws.com/sample-report/cli.jpg?v=1.0.0)
6969

7070
#### Below are reports generated in our other supported formats.
7171

7272
* [sample-report.csv](https://gist.github.com/manifestinteractive/fab5fc8cceac093cbe9fb5a5c2ad1b96)
73-
* [sample-report.html](https://rvw-a11y.s3.amazonaws.com/sample-report/a11y_20190804_221047.html)
73+
* [sample-report.html](https://sfcc-a11y.s3.amazonaws.com/sample-report/a11y_20190804_221047.html)
7474
* [sample-report.jira](https://gist.github.com/manifestinteractive/52a25c431d8280166e005f5c82b5d34e)
7575
* [sample-report.json](https://gist.github.com/manifestinteractive/dbe2909776bd27a1242cc6afbc7d93d9)
7676
* [sample-report.md](https://gist.github.com/manifestinteractive/f2c87d567ff052acc766ce14387e915b)
7777
* [sample-report.xml](https://gist.github.com/manifestinteractive/bca0ee98f455e2cfe67a8d3f1f31b6ad)
7878

79-
_Built using [pa11y](https://github.com/pa11y/pa11y). Customized for RVW Developers & Clients._
79+
_Built using [pa11y](https://github.com/pa11y/pa11y). Customized for Salesforce Commerce Cloud Developers & Clients._
80+
81+
Disclaimer
82+
---
83+
84+
> The trademarks and product names of Salesforce®, including the mark Salesforce®, are the property of Salesforce.com. SFCC DevOps is not affiliated with Salesforce.com, nor does Salesforce.com sponsor or endorse the SFCC DevOps products or website. The use of the Salesforce® trademark on this project does not indicate an endorsement, recommendation, or business relationship between Salesforce.com and SFCC DevOps.

bin/cli.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const path = require('path')
44
const yargs = require('yargs')
55

66
const argv = yargs
7-
.usage('\nAutomated Accessibility Tester\n\nUsage: rvw-a11y --options')
7+
.usage('\nAutomated Accessibility Tester\n\nUsage: sfcc-a11y --options')
88
.options({
99
actions: {
1010
alias: 'a',
@@ -103,7 +103,7 @@ const argv = yargs
103103
.example('a11y https://mywebsite.com --open', 'Run Test on URL')
104104
.example(' ', ' ')
105105
.example('----------------------------------', '------------------------------------------')
106-
.example('NEED MORE HELP ?', 'https://bit.ly/rvw-a11y-help')
106+
.example('NEED MORE HELP ?', 'https://bit.ly/sfcc-a11y-help')
107107
.example('----------------------------------', '------------------------------------------')
108108
.help()
109109
.version().argv

commands/a11y.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ const runTest = test => {
5555
const testResults = {
5656
generated: {
5757
date: moment().format('LLLL'),
58-
label: 'Red Van Workshop - Accessibility Tester',
59-
url: 'https://github.com/redvanworkshop/accessibility-tester'
58+
label: 'SFCC DevOps - Accessibility Tester',
59+
url: 'https://github.com/sfccdevops/accessibility-tester'
6060
},
6161
settings: {},
6262
total: {

docs/actions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Example: `/path/to/config.json`
1717
"compress": true,
1818
"notices": false,
1919
"warnings": false,
20-
"output": "/Users/rvw/Desktop/report-sample",
20+
"output": "/Users/sfcc/Desktop/report-sample",
2121
"open": true,
2222
"screenCapture": true,
2323
"timeout": 100000,
@@ -46,11 +46,11 @@ Example: `/path/to/config.json`
4646
}
4747
```
4848

49-
Here's another example using CLI `action` paramater:
49+
Here's another example using CLI `action` parameter:
5050

5151
```bash
52-
rvw-a11y https://mywebsite.com --actions='set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
53-
rvw-a11y https://mywebsite.com -a 'set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
52+
sfcc-a11y https://mywebsite.com --actions='set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
53+
sfcc-a11y https://mywebsite.com -a 'set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
5454
```
5555

5656
Below is a reference of all the available actions and what they do on the page. Some of these take time to complete so you may need to increase the `timeout` option if you have a large set of actions.
@@ -154,4 +154,4 @@ This action allows you to navigate to a new URL if, for example, the URL is inac
154154
"actions": [
155155
"navigate to http://another-example.com"
156156
]
157-
```
157+
```

docs/cmd-a11y.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
**[↤ Developer Overview](../README.md#developer-overview)**
44

5-
`rvw-a11y`
5+
`sfcc-a11y`
66
---
77

88
> Examples of how to use our CLI tool
99
10-
![markdown](https://rvw-a11y.s3.amazonaws.com/markdown.gif?v=1.0.0)
10+
![markdown](https://sfcc-a11y.s3.amazonaws.com/markdown.gif?v=1.0.0)
1111

1212

1313
Options:
@@ -38,48 +38,48 @@ Examples using CLI Params:
3838
Test a Website and Output Report to Terminal Window:
3939

4040
```bash
41-
rvw-a11y https://mywebsite.com
41+
sfcc-a11y https://mywebsite.com
4242
```
4343

4444
Test more than once website at a time:
4545

4646
```bash
47-
rvw-a11y https://mywebsite.com https://myotherwebsite.com
47+
sfcc-a11y https://mywebsite.com https://myotherwebsite.com
4848
```
4949

5050
Output Report with Screen Capture as Markdown and Open Report:
5151

5252
```bash
53-
rvw-a11y https://mywebsite.com --format=md --output=/path/to/folder --screen-capture --open
54-
rvw-a11y https://mywebsite.com -f md -o /path/to/folder -S -O
53+
sfcc-a11y https://mywebsite.com --format=md --output=/path/to/folder --screen-capture --open
54+
sfcc-a11y https://mywebsite.com -f md -o /path/to/folder -S -O
5555
```
5656

5757
Run report without Notices or Warnings:
5858

5959
```bash
60-
rvw-a11y https://mywebsite.com --no-notices --no-warnings
61-
rvw-a11y https://mywebsite.com -n false -w false
60+
sfcc-a11y https://mywebsite.com --no-notices --no-warnings
61+
sfcc-a11y https://mywebsite.com -n false -w false
6262
```
6363

6464
Wait for Report until 500 milliseconds has passed:
6565

6666
```bash
67-
rvw-a11y https://mywebsite.com --wait=500
68-
rvw-a11y https://mywebsite.com -W 500
67+
sfcc-a11y https://mywebsite.com --wait=500
68+
sfcc-a11y https://mywebsite.com -W 500
6969
```
7070

7171
Prevent Timeout Warning by extending timeout:
7272

7373
```bash
74-
rvw-a11y https://mywebsite.com --timeout=100000
75-
rvw-a11y https://mywebsite.com -t 100000
74+
sfcc-a11y https://mywebsite.com --timeout=100000
75+
sfcc-a11y https://mywebsite.com -t 100000
7676
```
7777

7878
Add Test Actions: ( [Learn More about Actions](actions.md) )
7979

8080
```bash
81-
rvw-a11y https://mywebsite.com --actions='set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
82-
rvw-a11y https://mywebsite.com -a 'set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
81+
sfcc-a11y https://mywebsite.com --actions='set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
82+
sfcc-a11y https://mywebsite.com -a 'set field #username to [email protected]' 'set field #password to abc123' 'click element #submit'
8383
```
8484

8585

@@ -96,7 +96,7 @@ Example: `/path/to/config.json`
9696
"compress": true,
9797
"notices": false,
9898
"warnings": false,
99-
"output": "/Users/rvw/Desktop/report-sample",
99+
"output": "/Users/sfcc/Desktop/report-sample",
100100
"open": true,
101101
"screenCapture": true,
102102
"standard": "WCAG2AA",
@@ -143,17 +143,17 @@ If you want to set a config option on a specific test, or overwrite your default
143143
Once you have the config files saved, you can trigger the test via CLI like this:
144144

145145
```bash
146-
rvw-a11y --config=/path/to/config.json
147-
rvw-a11y -c /path/to/config.json
146+
sfcc-a11y --config=/path/to/config.json
147+
sfcc-a11y -c /path/to/config.json
148148
```
149149

150150
#### Overwriting Config Options via CLI
151151

152152
It's possible to overload settings in your `config` file by passing in CLI params:
153153

154154
```bash
155-
rvw-a11y --config=/path/to/config.json --output=/path/to/other/folder
156-
rvw-a11y -c /path/to/config.json -o /path/to/other/folder
155+
sfcc-a11y --config=/path/to/config.json --output=/path/to/other/folder
156+
sfcc-a11y -c /path/to/config.json -o /path/to/other/folder
157157
```
158158

159159

@@ -165,4 +165,4 @@ Size | Width | Height
165165
`desktop` | 1366 | 768
166166
`tablet-landscape` | 1024 | 768
167167
`tablet-portrait` | 768 | 1024
168-
`mobile` | 360 | 640
168+
`mobile` | 360 | 640

docs/cmd-auth.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
**[↤ Developer Overview](../README.md#developer-overview)**
44

5-
`rvw-a11y auth`
5+
`sfcc-a11y auth`
66
---
77

88
> Generate Basic HTTP Authentication Tokens
99
10-
![demo](https://rvw-a11y.s3.amazonaws.com/auth.gif?v=1.0.0)
10+
![demo](https://sfcc-a11y.s3.amazonaws.com/auth.gif?v=1.0.0)
1111

1212
Some websites are protected from viewing by Basic HTTP Authentication. In order to run accessibility tests on these protected websites, you will need to configure tests with authentication data.
1313

1414
However, you might not want to put a `username` and `password` in your config file. Use this command to generate a token that will keep your info secure.
1515

1616
```bash
17-
rvw-a11y auth
17+
sfcc-a11y auth
1818
```
1919

2020
This command will generate a token that looks like this: `bWVAZW1haWwuY29tOmFiYzEyMw==`. Below are two different ways to add authentication data.
@@ -59,4 +59,4 @@ Sample Usage: `/path/to/my/config.json`
5959
}
6060
]
6161
}
62-
```
62+
```

docs/cmd-help.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
**[↤ Developer Overview](../README.md#developer-overview)**
44

5-
`rvw-a11y help`
5+
`sfcc-a11y help`
66
---
77

88
> Get Help when you need it
99
10-
![demo](https://rvw-a11y.s3.amazonaws.com/help.gif?v=1.0.0)
10+
![demo](https://sfcc-a11y.s3.amazonaws.com/help.gif?v=1.0.0)
1111

1212
You can get help at any time by running:
1313

1414
```bash
15-
rvw-a11y help
15+
sfcc-a11y help
1616
```
1717

1818
You can get help on a specific command by just adding `help` to the end of the command:
1919

2020
```bash
21-
rvw-a11y auth help
22-
```
21+
sfcc-a11y auth help
22+
```

lib/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports = async options => {
2424
warnings: true,
2525
output: process ? process.cwd() : null,
2626
standard: 'WCAG2AA',
27-
userAgent: 'Red Van Workshop - Accessibility Tester',
27+
userAgent: 'SFCC DevOps - Accessibility Tester',
2828
timeout: 100000,
2929
wait: 0
3030
}

0 commit comments

Comments
 (0)