Run prettier on all Explorer files (#1267)

## High Level Overview of Change

This PR runs `prettier` on all Explorer files (it seems that it wasn't
properly run on non-JS/TS files before). It also configures CI and CLI
scripts to check `prettier` as well, and sets up some basic pre-commit
settings.

This PR does not make any code changes, only linting changes.

### Context of Change

General repo cleanup

### Type of Change

- [x] Chore

### Codebase Modernization

N/A

## Before / After

<!--
If just refactoring / back-end changes, this can be just an in-English
description of the change at a technical level.
If a UI change, screenshots should be included.
-->

## Test Plan

Works locally. CI passes.

Author: mvadari

.github/dependabot.yml

@@ -1,8 +1,8 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-    time: "15:00"
-  open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: monthly
+      time: '15:00'
+    open-pull-requests-limit: 10

.github/workflows/nodejs.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
@@ -37,13 +37,17 @@ jobs:
         if: steps.cache-nodemodules.outputs.cache-hit != 'true'
         run: npm ci
 
-      - run: npm run lint:ci
+      - run: |
+          npm run lint:ci
+
+      # This runs the pre-commit hooks defined in .pre-commit-config.yaml
+      - uses: pre-commit/action@v3.0.1
 
   test:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
@@ -80,7 +84,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
@@ -109,7 +113,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-illegal-windows-names
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: forbid-submodules
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: 5ba47274f9b181bce26a5150a725577f3c336011 # frozen: v3.6.2
+    hooks:
+      - id: prettier
+        args: [--no-semi]

.prettierignore

@@ -1,4 +1,3 @@
 build/
 coverage/
 node_modules/
-src/**/*.{css}

.vscode/extensions.json

@@ -1,8 +1,8 @@
 {
-    "recommendations": [
-      "dbaeumer.vscode-eslint",
-      "esbenp.prettier-vscode",
-      "stylelint.vscode-stylelint",
-      "vespa-dev-works.jestrunit",
-    ]
-  }
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "stylelint.vscode-stylelint",
+    "vespa-dev-works.jestrunit"
+  ]
+}

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of behavior that does not contribute to creating a positive environment include:
 
-* Using sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- Using sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

docs/routing.md

@@ -9,6 +9,7 @@ The explorer uses some enhancements to `react-router` to provide type checking t
 In the future these objects can provide a common way to support legacy routes.
 
 ex.
+
 ```
 export const ACCOUNT_ROUTE: RouteDefinition<{
     id?: string
@@ -21,7 +22,7 @@ export const ACCOUNT_ROUTE: RouteDefinition<{
 
 ### `useRouteParams`
 
-A new hook which takes a `RouteDefinition` and wraps `react-router`'s `useRouteParams`.  This will derive the type of the params from the definition.
+A new hook which takes a `RouteDefinition` and wraps `react-router`'s `useRouteParams`. This will derive the type of the params from the definition.
 
 ex. `const { id = '', assetType = 'issued' } = useRouteParams(ACCOUNT_ROUTE)`
 

docs/translating.md

@@ -5,7 +5,7 @@
 1. Add the new language code and language name to the map `supportedLanguages` in [/src/i18n/baseConfig.ts](../src/i18n/baseConfig.ts)
 2. Create a folder in [/public/locales/](../public/locales) with the language code as its name.
 3. Add a new file, `translations.json`, to the new folder.
-4. Translate all the entries.  If you prefer to use the English version just set the value to `null`.
+4. Translate all the entries. If you prefer to use the English version just set the value to `null`.
 
    Example file: [/public/locales/ja-JP/translations.json](../public/locales/ja-JP/translations.json)
 
@@ -14,12 +14,13 @@
 When making changes to the base (English) language file follow the guide based on the type and scope of the change.
 
 ### New Entry
+
 1. Create entry in `en-US/translations.json`
 2. Add an entry to all other `translation.json` files. Set the value to be `null` (which means it will default to using the English version).
 
 ## Existing Entry
+
 1. Update the entry in `en-US/translations.json`
 2. If the meaning does **NOT** change materially, you can leave them as is. Ex. "Please check your transaction hash" => "Please check your transaction hash or CTID."
 3. If the entry has a new meaning than before, set the value to `null` in all other `translation.json` files.
-     
-  *Note that changing a translation to `null` causes it to fall back to the English version, and is a signal to language contributors that they may want to provide a fresh localization.*
+   _Note that changing a translation to `null` causes it to fall back to the English version, and is a signal to language contributors that they may want to provide a fresh localization._

package.json

@@ -126,10 +126,12 @@
     "build-ts": "tsc --build",
     "dev-client": "vite serve",
     "dev-server": "NODE_ENV=development PORT=5001 nodemon --watch server --watch build server|bunyan || true",
-    "lint": "run-s \"lint:js -- --fix\" \"lint:css -- --fix\"",
-    "lint:ci": "run-s lint:js lint:css",
+    "lint": "run-s \"lint:js -- --fix\" \"lint:css -- --fix\" \"format -- --log-level error\"",
+    "lint:ci": "run-s lint:js lint:css \"format:check -- --log-level error\"",
     "lint:css": "node_modules/.bin/stylelint src/**/*.scss",
     "lint:js": "node_modules/.bin/eslint --ext=js --ext=jsx --ext=ts --ext=tsx --color --max-warnings 0 .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "precommit": "lint-staged",
     "prod-server": "node server|bunyan",
     "start": "run-p dev-server dev-client",

public/.htaccess

@@ -1,4 +1,4 @@
 Options -MultiViews
 RewriteEngine On
 RewriteCond %{REQUEST_FILENAME} !-f
-RewriteRule ^ index.html [QSA,L]
+RewriteRule ^ index.html [QSA,L]