Merge pull request #773 from bcgov/anton/cats-prettier

chore: CATS FE - format with `prettier`, add formatting CI step

Author: bolny

.github/workflows/prettier-format.yaml

@@ -0,0 +1,31 @@
+name: Prettier Format
+
+on:
+  pull_request:
+    branches: [dev]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: cats-frontend
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+          persist-credentials: false
+
+      - name: CATS-Frontend Prettify code
+        uses: creyD/prettier_action@v4.3
+        with:
+          prettier_options: --check ./cats-frontend/src/**/*.{js,ts,jsx,tsx,json,css} --ignore-path ./cats-frontend/.prettierignore --config ./cats-frontend/.prettierrc
+          only_changed: True
+          dry: True
+      
+      - name: Formatting issues found
+        if: failure()
+        run: echo "::warning::Code formatting check failed. Try running npm run format in the project that caused the error and commit your changes"

cats-frontend/.prettierignore

@@ -0,0 +1 @@
+**/generated.ts

cats-frontend/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "auto"
+}

cats-frontend/babel.config.js

@@ -1,12 +1,12 @@
 module.exports = {
   presets: [
-    "@babel/preset-typescript",
-    "@babel/preset-env",
-    ["@babel/preset-react", { runtime: "automatic" }],
+    '@babel/preset-typescript',
+    '@babel/preset-env',
+    ['@babel/preset-react', { runtime: 'automatic' }],
   ],
   env: {
     test: {
-      plugins: ["babel-plugin-transform-import-meta"],
+      plugins: ['babel-plugin-transform-import-meta'],
     },
   },
 };

cats-frontend/package-lock.json

@@ -54,7 +54,8 @@
     "serve": "vite preview",
     "test": "vitest",
     "test:cov": "npm test -- --coverage",
-    "codegen": "graphql-codegen"
+    "codegen": "graphql-codegen",
+    "format": "prettier --write \"./src/**/*.{js,ts,jsx,tsx,json,css}\""
   },
   "eslintConfig": {
     "extends": [

cats-frontend/package.json

@@ -43,7 +43,7 @@
 }
 
 * {
-  font-family: "BC Sans", "Helvetica Neue", Arial, sans-serif;
+  font-family: 'BC Sans', 'Helvetica Neue', Arial, sans-serif;
 }
 
 @media screen and (max-width: 768px) {
@@ -165,8 +165,8 @@
   --typography-color-link: #255a90;
   --typography-color-disabled: #9f9d9c;
 
-  --box-shadow-small: 0 0.6px 1.8px 0 rgba(0, 0, 0, 0.1),
-    0 3.2px 7.2px 0 rgba(0, 0, 0, 0.13);
+  --box-shadow-small:
+    0 0.6px 1.8px 0 rgba(0, 0, 0, 0.1), 0 3.2px 7.2px 0 rgba(0, 0, 0, 0.13);
 
   --map-button-height-large: 64px;
   --map-button-height-medium: 40px;

cats-frontend/src/App.css

@@ -1,14 +1,14 @@
-import "./App.css";
-import Header from "./app/components/navigation/Header";
-import { Outlet } from "react-router-dom";
-import { ToastContainer } from "react-toastify";
-import SideBar from "./app/components/navigation/SideBar";
-import { useState } from "react";
-import { useAutoSignin } from "./hooks/useAutoSignIn";
+import './App.css';
+import Header from './app/components/navigation/Header';
+import { Outlet } from 'react-router-dom';
+import { ToastContainer } from 'react-toastify';
+import SideBar from './app/components/navigation/SideBar';
+import { useState } from 'react';
+import { useAutoSignin } from './hooks/useAutoSignIn';
 
-import "react-toastify/dist/ReactToastify.css";
-import "@bcgov/design-tokens/css/variables.css";
-import "@bcgov/bc-sans/css/BC_Sans.css";
+import 'react-toastify/dist/ReactToastify.css';
+import '@bcgov/design-tokens/css/variables.css';
+import '@bcgov/bc-sans/css/BC_Sans.css';
 
 function App() {
   const [isSidebarExpanded, setIsSidebarExpanded] = useState(false);
@@ -29,14 +29,14 @@ function App() {
       <Header />
       <div className="container m-0 p-0">
         <div
-          className={`sidebar-container display-from-medium ${isSidebarExpanded ? "expanded" : ""}`}
+          className={`sidebar-container display-from-medium ${isSidebarExpanded ? 'expanded' : ''}`}
           onMouseEnter={handleSidebarToggle}
           onMouseLeave={handleSidebarToggle}
         >
           <SideBar />
         </div>
         <div
-          className={`p-0 main-content-container ${isSidebarExpanded ? "shifted" : ""}`}
+          className={`p-0 main-content-container ${isSidebarExpanded ? 'shifted' : ''}`}
         >
           <Outlet />
         </div>

cats-frontend/src/App.tsx

@@ -1,7 +1,7 @@
-import { configureStore } from "@reduxjs/toolkit";
-import commonDataReducer from "./features/common/CommonDataSlice";
-import dashboardReducer from "./features/dashboard/DashboardSlice";
-import peopleReducer from "./features/people/dto/PeopleSlice";
+import { configureStore } from '@reduxjs/toolkit';
+import commonDataReducer from './features/common/CommonDataSlice';
+import dashboardReducer from './features/dashboard/DashboardSlice';
+import peopleReducer from './features/people/dto/PeopleSlice';
 
 export const store = configureStore({
   reducer: {

cats-frontend/src/app/Store.ts

@@ -1,4 +1,4 @@
-import { UserManagerSettings } from "oidc-client-ts";
+import { UserManagerSettings } from 'oidc-client-ts';
 
 export function getClientSettings(): UserManagerSettings {
   return {
@@ -9,8 +9,8 @@ export function getClientSettings(): UserManagerSettings {
     response_type: import.meta.env.VITE_AUTH_RESPONSE_TYPE,
     scope: import.meta.env.VITE_AUTH_SCOPE,
     filterProtocolClaims:
-      import.meta.env.VITE_AUTH_FILTER_PROTOCOL_CLAIMS === "true",
-    loadUserInfo: import.meta.env.VITE_AUTH_AUTHORITY === "true",
-    revokeTokensOnSignout: import.meta.env.VITE_AUTH_AUTHORITY === "true",
+      import.meta.env.VITE_AUTH_FILTER_PROTOCOL_CLAIMS === 'true',
+    loadUserInfo: import.meta.env.VITE_AUTH_AUTHORITY === 'true',
+    revokeTokensOnSignout: import.meta.env.VITE_AUTH_AUTHORITY === 'true',
   };
 }