Merge pull request #69 from DSACMS/k8/refactors-for-consistency

File renaming for consistency

app/[locale]/job/IncomeFormJob.tsx → app/[locale]/job/FormJob.tsx

@@ -13,27 +13,27 @@ import {
 import { SubmitHandler, useForm } from "react-hook-form"
 import { useTranslation } from "react-i18next"
 
-export interface IncomeFormJobProps {
-  onSubmit: SubmitHandler<IncomeFormJobData>
+export interface FormJobProps {
+  onSubmit: SubmitHandler<FormJobData>
   item?: JobItem
 }
 
-export type IncomeFormJobData = {
+export type FormJobData = {
   description: string
   business: string
   taxesFiled: boolean
   payments: []
 }
 
-export default function IncomeFormJob(params: IncomeFormJobProps) {
+export default function FormJob(params: FormJobProps) {
   const { t } = useTranslation()
 
   const {
     register,
     setValue,
     formState: { errors },
     handleSubmit
-  } = useForm<IncomeFormJobData>()
+  } = useForm<FormJobData>()
 
   return (
     <Form onSubmit={handleSubmit(params.onSubmit)}>

app/[locale]/job/IncomeFormPayment.tsx → app/[locale]/job/FormPayment.tsx

@@ -8,27 +8,27 @@ import { Button, DatePicker, Form, FormGroup, Label, RequiredMarker } from "@tru
 import { Controller, SubmitHandler, useForm } from "react-hook-form"
 import { useTranslation } from "react-i18next"
 
-export interface IncomeFormPaymentProps {
-    onSubmit: SubmitHandler<IncomeFormPaymentData>
+export interface FormPaymentProps {
+    onSubmit: SubmitHandler<FormPaymentData>
     item?: PaymentItem
 }
 
-export type IncomeFormPaymentData = {
+export type FormPaymentData = {
     job: string
     amount: number
     date: string
     payer: string
 }
 
-export default function IncomeFormPayment(params: IncomeFormPaymentProps) {
+export default function FormPayment(params: FormPaymentProps) {
     const { t } = useTranslation()
 
     const {
         register,
         control,
         formState: { errors },
         handleSubmit
-    } = useForm<IncomeFormPaymentData>()
+    } = useForm<FormPaymentData>()
 
     return (
         <Form onSubmit={handleSubmit(params.onSubmit)}>

app/[locale]/job/[idx]/expense/add/page.test.tsx → app/[locale]/job/[jobId]/expense/add/page.test.tsx

@@ -16,7 +16,7 @@ describe('Add Income To Ledger Page', async () => {
         }))
         mockRouter.push('/job/expense/add')
         store = makeStore()
-        render (<Provider store={store}><Page params={{idx: '0'}} /></Provider>)
+        render (<Provider store={store}><Page params={{jobId: '0'}} /></Provider>)
     })
     afterEach(cleanup)
 

app/[locale]/job/[idx]/expense/add/page.tsx → app/[locale]/job/[jobId]/expense/add/page.tsx

@@ -9,12 +9,12 @@ import FormExpense, { ExpenseFormPaymentData } from '../FormExpense'
 import { createUuid } from '@/lib/store'
 
 
-export default function Page({ params }: { params: { idx: string } }) {
+export default function Page({ params }: { params: { jobId: string } }) {
     const { t } = useTranslation()
     const dispatch = useAppDispatch()
     const router = useRouter()
 
-    function addExpenseClicked ({job=params.idx, name, expenseType, amount, isMileage=false, date }: ExpenseFormPaymentData) {
+    function addExpenseClicked ({job=params.jobId, name, expenseType, amount, isMileage=false, date }: ExpenseFormPaymentData) {
         const id = createUuid()
 
         const expenseItem: SetExpensePayload = {

app/[locale]/job/[idx]/payment/add/page.test.tsx → app/[locale]/job/[jobId]/payment/add/page.test.tsx

@@ -59,7 +59,7 @@ describe('Add Payments to Jobs Page', async () => {
     mockRouter.push('/job/0/payment/add')
     store = makeStore()
     store.dispatch(addJob(item1))
-    render (<TestWrapper store={store}><Page params={{idx: '0'}} /></TestWrapper>)
+    render (<TestWrapper store={store}><Page params={{jobId: '0'}} /></TestWrapper>)
   })
   afterEach(cleanup)
 

app/[locale]/job/[idx]/payment/add/page.tsx → app/[locale]/job/[jobId]/payment/add/page.tsx

@@ -6,18 +6,18 @@ import { selectJobItemAt } from "@/lib/features/job/jobSlice"
 import { addPayment, SetPaymentPayload } from '@/lib/features/job/payment/paymentSlice'
 import { useRouter } from "next/navigation"
 import VerifyNav from "@/app/components/VerifyNav"
-import IncomeFormPayment, { IncomeFormPaymentData } from '@/app/[locale]/job/IncomeFormPayment'
+import FormPayment, { FormPaymentData } from '@/app/[locale]/job/FormPayment'
 import { createUuid } from '@/lib/store'
 
-export default function Page({ params }: { params: { idx: string } }) {
+export default function Page({ params }: { params: { jobId: string } }) {
     const { t } = useTranslation()
     const dispatch = useAppDispatch()
     const router = useRouter()
 
-    const job = useAppSelector(state => selectJobItemAt(state, params.idx))
+    const job = useAppSelector(state => selectJobItemAt(state, params.jobId))
     const jobDescription = job ? job.description : 'your job'
 
-    function addPaymentClicked({job=params.idx, amount, date, payer}: IncomeFormPaymentData) {
+    function addPaymentClicked({job=params.jobId, amount, date, payer}: FormPaymentData) {
         const id = createUuid()
 
         const paymentItem: SetPaymentPayload = {
@@ -41,7 +41,7 @@ export default function Page({ params }: { params: { idx: string } }) {
                     <Grid row gap>
                         <main className="usa-layout-docs">
                             <h3>{t('add_income_payment_header', {description: jobDescription })}</h3>
-                            <IncomeFormPayment onSubmit={addPaymentClicked} />
+                            <FormPayment onSubmit={addPaymentClicked} />
                          </main>
                     </Grid>
                 </GridContainer>

app/[locale]/job/add/page.tsx

@@ -5,7 +5,7 @@ import { useAppDispatch, useAppSelector } from "@/lib/hooks"
 import { addJob, SetJobPayload, selectJobCount, JobItem } from "@/lib/features/job/jobSlice"
 import { useRouter } from "next/navigation"
 import VerifyNav from "@/app/components/VerifyNav"
-import IncomeFormJob, { IncomeFormJobData } from '@/app/[locale]/job/IncomeFormJob'
+import FormJob, { FormJobData } from '@/app/[locale]/job/FormJob'
 import { createUuid } from '@/lib/store'
 
 export default function Page() {
@@ -14,7 +14,7 @@ export default function Page() {
     const router = useRouter()
     const jobCount = useAppSelector(state => selectJobCount(state))
 
-    function addIncomeClicked({description, business, taxesFiled}: IncomeFormJobData) {
+    function addIncomeClicked({description, business, taxesFiled}: FormJobData) {
         const id = createUuid()
         const jobPayload: SetJobPayload = {
             id, 
@@ -41,7 +41,7 @@ export default function Page() {
                                 'add_income_header', 
                                 {'nth': jobCount === 0 ? 'first': 'next'}
                             )}</h3>
-                            <IncomeFormJob onSubmit={addIncomeClicked} />
+                            <FormJob onSubmit={addIncomeClicked} />
                          </main>
                     </Grid>
                 </GridContainer>

app/[locale]/job/edit/[idx]/page.test.tsx → app/[locale]/job/edit/[jobId]/page.test.tsx

@@ -30,7 +30,7 @@ describe('Edit Income Item Page', async () => {
     })
     beforeEach(() => {
         mockRouter.push(`/job/edit/${id}`)
-        render (<TestWrapper store={store}><Page params={{idx: id}} /></TestWrapper>)
+        render (<TestWrapper store={store}><Page params={{jobId: id}} /></TestWrapper>)
     })
     afterEach(cleanup)
 

app/[locale]/job/edit/[idx]/page.tsx → app/[locale]/job/edit/[jobId]/page.tsx

@@ -4,19 +4,19 @@ import { JobItem, selectJobItemAt, setJobItem } from "@/lib/features/job/jobSlic
 import { useAppSelector } from "@/lib/hooks"
 import { Grid, GridContainer } from "@trussworks/react-uswds"
 import { useTranslation } from "react-i18next"
-import IncomeFormJob, { IncomeFormJobData } from "@/app/[locale]/job/IncomeFormJob"
+import FormJob, { FormJobData } from "@/app/[locale]/job/FormJob"
 import { useDispatch } from "react-redux"
 import { useRouter } from "next/navigation"
 
-export default function EditIncome({ params }: { params: { idx: string } }) {
+export default function EditIncome({ params }: { params: { jobId: string } }) {
     const { t } = useTranslation()
     const dispatch = useDispatch()
     const router = useRouter()
-    const item = useAppSelector(state => selectJobItemAt(state, params.idx))
+    const item = useAppSelector(state => selectJobItemAt(state, params.jobId))
 
-    function editIncomeClicked({description, business, taxesFiled}: IncomeFormJobData) {
+    function editIncomeClicked({description, business, taxesFiled}: FormJobData) {
         dispatch(setJobItem({
-            id: params.idx,
+            id: params.jobId,
             item: {
                 description,
                 business,
@@ -35,7 +35,7 @@ export default function EditIncome({ params }: { params: { idx: string } }) {
                     <Grid row gap>
                         <main className="usa-layout-docs">
                             <h3>{t('edit_income_header')}</h3>
-                            <IncomeFormJob onSubmit={editIncomeClicked} item={item} />
+                            <FormJob onSubmit={editIncomeClicked} item={item} />
                          </main>
                     </Grid>
                 </GridContainer>

app/api/sitemap/route.ts

@@ -6,7 +6,7 @@ export async function GET(req: Request) {
     const files = await readdir(pathToFileURL('app'), { recursive: true })
     const locs = files
         .filter(file => file.endsWith('page.tsx'))
-        .filter(file => file.indexOf('[idx]') === -1)
+        .filter(file => file.indexOf('[jobId]') === -1)
         .map((file) => {
           let name = file.substring(0, file.indexOf('page.tsx'))
           if (name.indexOf('[locale]') === -1) {

app/components/ExpenseListItem.tsx

@@ -24,7 +24,7 @@ export default function ExpenseListItem({ item, index }: ItemProps) {
     const dispatch = useAppDispatch()
     const router = useRouter()
     const expenses = useAppSelector(state => selectExpensesByJob(state, index)).map((expense: ExpenseItem) => {
-        return (<li key="expense.idx}">{expense.date} ${expense.amount} {expense.name} ({expense.expenseType})</li>)
+        return (<li key="expense.jobId}">{expense.date} ${expense.amount} {expense.name} ({expense.expenseType})</li>)
     })
 
     function onDeleteClicked() {

app/components/IncomeListItem.tsx

@@ -19,10 +19,10 @@ export default function IncomeListItem({ item, index }: ItemProps) {
     const dispatch = useAppDispatch()
     const router = useRouter()
     const payments = useAppSelector(state => selectPaymentsByJob(state, index)).map((payment: PaymentItem) => {
-        return (<li key="{payment.idx}">{payment.date} ${payment.amount} {t('list_income_by')} {payment.payer}</li>)
+        return (<li key="{payment.jobId}">{payment.date} ${payment.amount} {t('list_income_by')} {payment.payer}</li>)
     })
     const expenses = useAppSelector(state => selectExpensesByJob(state, index)).map((expense: ExpenseItem) => {
-        return (<li key="expense.idx}">{expense.date} ${expense.amount} {expense.name} ({expense.expenseType})</li>)
+        return (<li key="expense.jobId}">{expense.date} ${expense.amount} {expense.name} ({expense.expenseType})</li>)
     })
 
     function onDeleteClicked() {

scripts/compare_coverage.js

@@ -30,11 +30,11 @@ module.exports = ({github, context, mainWorkflowRunSha, coverageFilePath, prNumb
             const mainCoverage = coverageForFile(mainCoverageData[fileName].s)
 
             if (prCoverage != mainCoverage) {
-                let idx = fileName.indexOf("iv-verify")
-                if (idx === -1) {
-                    idx = fileName.indexOf('verify-nextjs') // old repo name
+                let jobId = fileName.indexOf("iv-verify")
+                if (jobId === -1) {
+                    jobId = fileName.indexOf('verify-nextjs') // old repo name
                 }
-                let prettyFileName = fileName.slice(idx)
+                let prettyFileName = fileName.slice(jobId)
                 message += `- ${prettyFileName} went from ${mainCoverage}% to ${prCoverage}%<br />`
             }
         }

vitest.config.ts

@@ -18,7 +18,7 @@ export default defineConfig({
         // excluding a directory where there is no page to test
         exclude: [
             ...configDefaults.exclude,
-            'app/[locale]/job/[idx]/payment/*',
+            'app/[locale]/job/[jobId]/payment/*',
         ]
     }
 })