updated package and asset names from hats to a11y (#247)

* updated package and asset names from hats to a11y * bump package number * minor updates of name * Update README.md with go.gov.sg link shortener * Update INSTALLATION.md * Update INSTALLATION.md * changes hats to a11y on integration.md (#249) * changes hats to a11y on integration.md --------- Co-authored-by: Chen Xinyi <[email protected]> * change to ph reference in integration.md * change to ph reference in integration.md * changes to with repo rename (#250) * changes to with repo rename * bump package number * fix for custom 1 await prettier --------- Co-authored-by: younglim <[email protected]> Co-authored-by: xinyicxy <[email protected]> Co-authored-by: Chen Xinyi <[email protected]>
GovTechSG · Dec 8, 2023 · 6bc35ca · 6bc35ca
1 parent ac55ba7
commit 6bc35ca
Show file tree

Hide file tree

Showing 27 changed files with 242 additions and 239 deletions.
diff --git a/.github/workflows/image.yml b/.github/workflows/image.yml
@@ -13,13 +13,13 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v3
         with:
-          path: purple-hats
+          path: purple-a11y
 
       - name: Copy scripts to parent directory
         run: |
-          cp ${{github.workspace}}/purple-hats/scripts/*.ps1 ${{github.workspace}}
-          cp ${{github.workspace}}/purple-hats/scripts/*.cmd ${{github.workspace}}      
-          cp ${{github.workspace}}/purple-hats/scripts/*.xml ${{github.workspace}}  
+          cp ${{github.workspace}}/purple-a11y/scripts/*.ps1 ${{github.workspace}}
+          cp ${{github.workspace}}/purple-a11y/scripts/*.cmd ${{github.workspace}}      
+          cp ${{github.workspace}}/purple-a11y/scripts/*.xml ${{github.workspace}}  
           
       - name: Install Purple dependencies for Windows
         shell: pwsh
@@ -28,20 +28,20 @@ jobs:
 
       - name: Zip entire Purple folder (Windows)
         shell: pwsh
-        run: Compress-Archive -Path ${{github.workspace}}/* -DestinationPath purple-hats-portable-windows.zip
+        run: Compress-Archive -Path ${{github.workspace}}/* -DestinationPath purple-a11y-portable-windows.zip
 
       - name: Upload Windows artifact
         uses: actions/upload-artifact@v3
         with:
-          name: purple-hats-portable-windows
-          path: ./purple-hats-portable-windows.zip
+          name: purple-a11y-portable-windows
+          path: ./purple-a11y-portable-windows.zip
 
       - name: Release Windows artifact
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            purple-hats-portable-windows.zip
+            purple-a11y-portable-windows.zip
             
   mac-install-purple:
     runs-on: self-hosted
@@ -56,15 +56,15 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v3
         with:
-          path: purple-hats
+          path: purple-a11y
 
       - name: Grant execute permissions for user
         run: chmod ugo+rwx ./scripts/*.command ./scripts/*.sh
-        working-directory: purple-hats
+        working-directory: purple-a11y
 
       - name: Copy scripts to parent directory
         run: |
-          cp ./purple-hats/scripts/{*.command,*.sh,*.xml}  ${{ github.workspace }}
+          cp ./purple-a11y/scripts/{*.command,*.sh,*.xml}  ${{ github.workspace }}
 
       - name: Install Purple dependencies for MacOS
         run: |
@@ -77,8 +77,8 @@ jobs:
           
           # Paths to the binaries you want to sign
           BINARIES=(
-            "./purple-hats/node_modules/playwright/node_modules/fsevents/fsevents.node"
-            "./purple-hats/node_modules/fsevents/fsevents.node"
+            "./purple-a11y/node_modules/playwright/node_modules/fsevents/fsevents.node"
+            "./purple-a11y/node_modules/fsevents/fsevents.node"
           )
 
           # Loop through the binary paths and sign each one with a secure timestamp
@@ -93,17 +93,17 @@ jobs:
         
       - name: Zip entire Purple folder (Mac)
         run: |
-          zip purple-hats-portable-mac.zip -y -r ./
+          zip purple-a11y-portable-mac.zip -y -r ./
       
       - name: Upload Mac artifact
         uses: actions/upload-artifact@v3
         with:
-          name: purple-hats-portable-mac
-          path: ./purple-hats-portable-mac.zip
+          name: purple-a11y-portable-mac
+          path: ./purple-a11y-portable-mac.zip
 
       - name: Release Mac artifact
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            purple-hats-portable-mac.zip
+            purple-a11y-portable-mac.zip
diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,7 @@
 # Use Node LTS alpine distribution
 FROM node:lts-alpine
 
-# Installation of packages for purple-hats and chromium
+# Installation of packages for purple-a11y and chromium
 RUN apk add build-base gcompat g++ make python3 zip bash git chromium openjdk11-jre
 
 # Installation of VeraPDF
@@ -28,7 +28,7 @@ RUN latest_version=$(ls -d /opt/verapdf-greenfield-* | sort -V | tail -n 1) && [
     "$latest_version/verapdf-install" "/opt/verapdf-auto-install-docker.xml"
 RUN rm -rf /opt/verapdf-installer.zip /opt/verapdf-greenfield-*
 
-# Set purple-hats directory
+# Set purple-a11y directory
 WORKDIR /app
 
 # Copy package.json to working directory, perform npm install before copying the remaining files

diff --git a/INSTALLATION.md b/INSTALLATION.md
@@ -1,61 +1,61 @@
 ## Installation Guide
 
-Purple hats is provided as a portable distribution which minimises installation steps required for Windows and Mac.
+Purple A11y is provided as a portable distribution which minimises installation steps required for Windows and Mac.
 
-### About Purple hats
-Purple hats is a customisable, automated accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.
+### About Purple A11y
+Purple A11y is a customisable, automated accessibility testing tool that allows software development teams to find and fix accessibility problems to improve persons with disabilities (PWDs) access to digital services.
 
 ### System Requirements
-* Purple HATS can run on MacOS Big Sur or above, and a [supported](https://learn.microsoft.com/en-us/windows/release-health/supported-versions-windows-client) version of Windows 10 (64-bit) or Windows 11.
+* Purple A11y can run on MacOS Big Sur or above, and a [supported](https://learn.microsoft.com/en-us/windows/release-health/supported-versions-windows-client) version of Windows 10 (64-bit) or Windows 11.
 * Google Chrome browser is [installed](https://www.google.com/chrome).
-* One-time Internet access is needed to download and install Purple HATS Desktop.
-* You are recommended to be logged on to an admin user to run Purple HATS Desktop.
+* One-time Internet access is needed to download and install Purple A11y Desktop.
+* You are recommended to be logged on to an admin user to run Purple A11y Desktop.
 
 ### Windows
 <details>
   <summary>Click here for Windows setup instructions</summary>
 
 #### Download Portable Copy
-* Download and extract latest [purple-hats-portable-windows.zip](https://github.com/GovTechSG/purple-hats/releases/latest/download/purple-hats-portable-windows.zip).
+* Download and extract latest [purple-a11y-portable-windows.zip](https://github.com/GovTechSG/purple-a11y/releases/latest/download/purple-a11y-portable-windows.zip).
 * Tip: To extract files, right-click the Compressed zip file and click "Extract All…" in the context menu.
 
-#### Run Purple hats
- * Navigate to the folder containing purple-hats-portable.
- * Double-click `hats_shell.cmd` (Windows Command Script file).
-  <img width="480" alt="Screenshot of Windows Explorer with hats_shell.cmd selected" src="https://user-images.githubusercontent.com/2021525/225506018-9f7a6684-ac14-4a69-a4f2-4d1a67a068c4.png">
+#### Run Purple A11y
+ * Navigate to the folder containing purple-a11y-portable-windows.
+ * Double-click `a11y_shell.cmd` (Windows Command Script file).
+  <img width="480" alt="Screenshot of Windows Explorer with a11y_shell.cmd selected" src="https://github.com/GovTechSG/purple-a11y/assets/50561219/872c9fce-0d7f-405d-b6b6-c8a196c3e81a">
 
- * A Windows Command Prompt window should open with contents as illustrated below. `hats_shell` will automatically prepare your system to run Purple hats.
+ * A Windows Command Prompt window should open with contents as illustrated below. `a11y_shell` will automatically prepare your system to run Purple a11y.
 ```
-hats Shell - Created By younglim - NO WARRANTY PROVIDED
+a11y Shell - Created By younglim - NO WARRANTY PROVIDED
 ================================================================
 
-INFO: Stored current working directory at C:\Users\a11y\Downloads\purple-hats-portable-windows
+INFO: Stored current working directory at C:\Users\a11y\Downloads\purple-a11y-portable-windows
 INFO: Set path to node for this session
 INFO: Set path to node_modules for this session
 INFO: Set path to npm-global for this session
 INFO: Set path to Playwright cache for this session
 INFO: Set path to ImageMagick for this session
-INFO: Set path to purple-hats for this session
+INFO: Set path to purple-a11y for this session
 
 
-PS C:\Users\username\Downloads\purple-hats-portable-windows>
+PS C:\Users\username\Downloads\purple-a11y-portable-windows>
 ```
 
 
- * Type in the following commands into the window.  The following commands will navigate your Command Prompt window to the `purple-hats` sub-directory and initiate a scan
+ * Type in the following commands into the window.  The following commands will navigate your Command Prompt window to the `purple-a11y` sub-directory and initiate a scan
 ```
-cd purple-hats
+cd purple-a11y
 node index
 ```
  * If a Windows Firewall prompt appears, click "Allow access"
-<img width="261" alt="Windows Firewall prompt for Allow access" src="https://user-images.githubusercontent.com/2021525/208462360-ae9e1e3d-beca-4b78-af40-4126719432f0.png">
+<img width="261" alt="Windows Firewall prompt for Allow access" src="https://github.com/GovTechSG/purple-a11y/assets/50561219/4ece401b-1195-4a90-a327-243c081690b9">
 
  * You should then see your Windows Command Prompt window updated with the following contents
 ```
-PS C:\Users\username\Downloads\purple-hats-portable-windows> cd purple-hats
-PS C:\Users\username\Downloads\purple-hats-portable-windows\purple-hats> node index
+PS C:\Users\username\Downloads\purple-a11y-portable-windows> cd purple-a11y
+PS C:\Users\username\Downloads\purple-a11y-portable-windows\purple-a11y> node index
 ┌────────────────────────────────────────────────────────────┐
-│ Welcome to HATS Accessibility Testing Tool!                │
+│ Welcome to A11y Accessibility Testing Tool!                │
 │ We recommend using Chrome browser for the best experience. │
 │                                                            │
 │ Version: ░░░░░░                                            │
@@ -66,7 +66,7 @@ PS C:\Users\username\Downloads\purple-hats-portable-windows\purple-hats> node in
   custom flow
 ```
 
- * Follow the steps at [Features](https://github.com/GovTechSG/purple-hats#features) for more information on how to run a scan.
+ * Follow the steps at [Features](https://github.com/GovTechSG/purple-a11y#features) for more information on how to run a scan.
 
   </details>
 
@@ -75,23 +75,23 @@ PS C:\Users\username\Downloads\purple-hats-portable-windows\purple-hats> node in
   <summary>Click here for MacOS setup instructions</summary>
 
 #### Download Portable Copy
- * Download and extract [purple-hats-portable-mac.zip](https://github.com/GovTechSG/purple-hats/releases/latest/download/purple-hats-portable-mac.zip) version.
- * Tip: To extract files in Mac, double-click on `purple-hats-portable-mac.zip` file, usually located at your Downloads folder. A new folder with the name `purple-hats-mac` will appear in Finder.
+ * Download and extract [purple-a11y-portable-mac.zip](https://github.com/GovTechSG/purple-a11y/releases/latest/download/purple-a11y-portable-mac.zip) version.
+ * Tip: To extract files in Mac, double-click on `purple-a11y-portable-mac.zip` file, usually located at your Downloads folder. A new folder with the name `purple-a11y-portable-mac` will appear in Finder.
 
-#### Run Purple hats
- * Navigate to the folder `purple-hats-mac`, usually located at your Downloads folder.
- * Right-click `hats_shell.command`. Then click `Open` in the context menu.
-  <img width="480" alt="Screenshot of right-click hats_shell.command and Open" src="https://user-images.githubusercontent.com/2021525/225501586-2df8ba37-f58a-4d1f-b28c-e06865fec2b0.png">
+#### Run Purple A11y
+ * Navigate to the folder `purple-a11y-portable-mac`, usually located at your Downloads folder.
+ * Right-click `a11y_shell.command`. Then click `Open` in the context menu.
+  <img width="480" alt="Screenshot of right-click a11y_shell.command and Open" src="https://github.com/GovTechSG/purple-a11y/assets/152410523/15a0f577-c8c4-43e2-9c9d-ca4b960b8874">
 
  * A prompt as follows will appear like below. Click `Open`.
- <img width="240" alt="MacOS prompt for unidentified developer" src="https://user-images.githubusercontent.com/2021525/208457749-3a0a573d-5a6d-4905-b11e-c957d2073979.png">
+ <img width="240" alt="MacOS prompt for unidentified developer" src="https://github.com/GovTechSG/purple-a11y/assets/152410523/85eb0d58-8dd9-477c-916a-b759cfb1afd6">
 
- * A Terminal window should open with contents as illustrated below. `hats_shell` will automatically prepare your system to run Purple hats.
+ * A Terminal window should open with contents as illustrated below. `a11y_shell` will automatically prepare your system to run Purple A11y.
 ```
 Last login: Thu Mar 16 10:48:05 on ttys002
-/Users/username/Downloads/purple-hats-portable-mac/hats_shell.command ; exit;
-username@hostname ~ % /Users/username/Downloads/purple-hats-portable-mac/hats_shell.command ; exit;
-hats Shell - Created By younglim - NO WARRANTY PROVIDED
+/Users/username/Downloads/purple-a11y-portable-mac/a11y_shell.command ; exit;
+username@hostname ~ % /Users/username/Downloads/purple-a11y-portable-mac/a11y_shell.command ; exit;
+a11y Shell - Created By younglim - NO WARRANTY PROVIDED
 ================================================================
 
 INFO: Setting path to node for this session
@@ -100,21 +100,21 @@ INFO: Set path to Playwright cache for this session
 INFO: Set symbolic link to ImageMagick
 INFO: Set path to ImageMagick binaries
 INFO: Removing com.apple.quarantine attributes for required binaries to run
-username@hostname purple-hats-portable-mac %
+username@hostname purple-a11y-portable-mac %
 ```
 
- * Type in the following commands into the window.  The following commands will navigate your Terminal window to the `purple-hats` sub-directory and initiate a scan
+ * Type in the following commands into the window.  The following commands will navigate your Terminal window to the `purple-a11y` sub-directory and initiate a scan
  ```
-cd purple-hats
+cd purple-a11y
 node index
 ```
 
  * You should then see your Terminal window updated with the following contents
 ```
-username@hostname purple-hats-portable-mac % cd purple-hats
-username@hostname purple-hats % node index
+username@hostname purple-a11y-portable-mac % cd purple-a11y
+username@hostname purple-a11y % node index
 ┌────────────────────────────────────────────────────────────┐
-│ Welcome to HATS Accessibility Testing Tool!                │
+│ Welcome to A11y Accessibility Testing Tool!                │
 │ We recommend using Chrome browser for the best experience. │
 │                                                            │
 │ Version: ░░░░░░                                            │
@@ -125,5 +125,5 @@ username@hostname purple-hats % node index
   custom flow
 ```
 
- * Follow the steps at [Features](https://github.com/GovTechSG/purple-hats#features) for more information on how to run a scan.
+ * Follow the steps at [Features](https://github.com/GovTechSG/purple-a11y#features) for more information on how to run a scan.
 </details>