Skip to content

A local-first personal finance app

[AI] Make TypeScript work in test files across packages (#7642)

Matiss Janis Aboltins4a5ee9c2dc0f
diff --git a/.oxlintrc.json b/.oxlintrc.json
index 20ad0812cd..0a57484653 100644
--- a/.oxlintrc.json
+++ b/.oxlintrc.json
@@ -370,7 +370,8 @@
"files": ["**/*.test.{js,ts,jsx,tsx}", "packages/docs/**/*"],
"rules": {
"actual/no-untranslated-strings": "off",
- "actual/prefer-logger-over-console": "off"
+ "actual/prefer-logger-over-console": "off",
+ "typescript/unbound-method": "off"
}
},
{
diff --git a/packages/api/methods.test.ts b/packages/api/methods.test.ts
index 043184faff..e8b0f5a76f 100644
--- a/packages/api/methods.test.ts
+++ b/packages/api/methods.test.ts
@@ -6,6 +6,11 @@ import { vi } from 'vitest';
import * as api from './index';
+declare global {
+ var IS_TESTING: boolean;
+ var currentMonth: string | null;
+}
+
// In tests we run from source; loot-core's API fs uses __dirname (for the built dist/).
// Mock the fs so path constants point at loot-core package root where migrations live.
vi.mock(
diff --git a/packages/api/package.json b/packages/api/package.json
index bb313f1e35..4bb8b1418f 100644
--- a/packages/api/package.json
+++ b/packages/api/package.json
@@ -10,7 +10,9 @@
},
"files": [
"@types",
- "dist"
+ "dist",
+ "!@types/**/*.test.d.ts",
+ "!@types/**/*.test.d.ts.map"
],
"main": "dist/index.js",
"types": "@types/index.d.ts",
diff --git a/packages/api/tsconfig.json b/packages/api/tsconfig.json
index e299e45638..15caf1b278 100644
--- a/packages/api/tsconfig.json
+++ b/packages/api/tsconfig.json
@@ -35,7 +35,6 @@
"**/node_modules/*",
"dist",
"@types",
- "*.test.ts",
"*.config.ts",
"*.config.mts"
]
diff --git a/packages/crdt/package.json b/packages/crdt/package.json
index 065ad2ffc5..642cb114d1 100644
--- a/packages/crdt/package.json
+++ b/packages/crdt/package.json
@@ -4,7 +4,11 @@
"description": "CRDT layer of Actual",
"license": "MIT",
"files": [
- "dist"
+ "dist",
+ "!dist/**/*.test.d.ts",
+ "!dist/**/*.test.d.ts.map",
+ "!dist/**/*.spec.d.ts",
+ "!dist/**/*.spec.d.ts.map"
],
"main": "dist/index.js",
"types": "dist/index.d.ts",
@@ -26,7 +30,7 @@
"scripts": {
"build:node": "vite build",
"proto:generate": "./bin/generate-proto",
- "build": "yarn run build:node && tsgo -p tsconfig.build.json --emitDeclarationOnly",
+ "build": "yarn run build:node && tsgo -b",
"test": "vitest --run",
"typecheck": "tsgo -b"
},
diff --git a/packages/crdt/tsconfig.build.json b/packages/crdt/tsconfig.build.json
deleted file mode 100644
index 42ff5319aa..0000000000
--- a/packages/crdt/tsconfig.build.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "extends": "./tsconfig.json",
- "compilerOptions": {
- "composite": false,
- "emitDeclarationOnly": false
- },
- "exclude": ["**/*.test.ts", "**/*.spec.ts"]
-}
diff --git a/packages/desktop-client/e2e/fixtures.ts b/packages/desktop-client/e2e/fixtures.ts
index 619791482e..bb4018b797 100644
--- a/packages/desktop-client/e2e/fixtures.ts
+++ b/packages/desktop-client/e2e/fixtures.ts
@@ -1,5 +1,5 @@
import { test as base, expect as baseExpect } from '@playwright/test';
-import type { Browser, Locator } from '@playwright/test';
+import type { Browser, Locator, Page } from '@playwright/test';
/**
* Disable CSS transitions and animations globally in e2e (non-VRT) runs.
@@ -51,7 +51,7 @@ export const test = process.env.VRT
});
export const expect = baseExpect.extend({
- async toMatchThemeScreenshots(locator: Locator) {
+ async toMatchThemeScreenshots(target: Locator | Page) {
// Disable screenshot assertions in regular e2e tests;
// only enable them when doing VRT tests
if (!process.env.VRT) {
@@ -62,38 +62,33 @@ export const expect = baseExpect.extend({
}
const config = {
- mask: [locator.locator('[data-vrt-mask="true"]')],
+ mask: [target.locator('[data-vrt-mask="true"]')],
maxDiffPixels: 5,
};
- // Get the data-theme attribute from page.
- // If there is a page() function, it means that the locator
- // is not a page object but a locator object.
- const dataThemeLocator =
- typeof locator.page === 'function'
- ? locator.page().locator('[data-theme]')
- : locator.locator('[data-theme]');
+ const page: Page = 'page' in target ? target.page() : target;
+ const dataThemeLocator = page.locator('[data-theme]');
// Check lightmode
- await locator.evaluate(() => window.Actual.setTheme('auto'));
+ await page.evaluate(() => window.Actual.setTheme('auto'));
await baseExpect(dataThemeLocator).toHaveAttribute('data-theme', 'auto');
- await baseExpect(locator).toHaveScreenshot(config);
+ await baseExpect(target).toHaveScreenshot(config);
// Switch to darkmode and check
- await locator.evaluate(() => window.Actual.setTheme('dark'));
+ await page.evaluate(() => window.Actual.setTheme('dark'));
await baseExpect(dataThemeLocator).toHaveAttribute('data-theme', 'dark');
- await baseExpect(locator).toHaveScreenshot(config);
+ await baseExpect(target).toHaveScreenshot(config);
// Switch to midnight theme and check
- await locator.evaluate(() => window.Actual.setTheme('midnight'));
+ await page.evaluate(() => window.Actual.setTheme('midnight'));
await baseExpect(dataThemeLocator).toHaveAttribute(
'data-theme',
'midnight',
);
- await baseExpect(locator).toHaveScreenshot(config);
+ await baseExpect(target).toHaveScreenshot(config);
// Switch back to lightmode
- await locator.evaluate(() => window.Actual.setTheme('auto'));
+ await page.evaluate(() => window.Actual.setTheme('auto'));
return {
message: () => 'pass',
pass: true,
diff --git a/packages/desktop-client/e2e/tsconfig.json b/packages/desktop-client/e2e/tsconfig.json
new file mode 100644
index 0000000000..b76d2b2010
--- /dev/null
+++ b/packages/desktop-client/e2e/tsconfig.json
@@ -0,0 +1,9 @@
+{
+ "extends": "../../../tsconfig.json",
+ "compilerOptions": {
+ "composite": false,
+ "noEmit": true,
+ "types": ["@playwright/test", "node"]
+ },
+ "include": ["./**/*.ts", "./**/*.tsx", "../../loot-core/typings/window.ts"]
+}
diff --git a/packages/desktop-client/src/components/accounts/Balance.test.tsx b/packages/desktop-client/src/components/accounts/Balance.test.tsx
index 0b6fdfb8ce..40d1a355a9 100644
--- a/packages/desktop-client/src/components/accounts/Balance.test.tsx
+++ b/packages/desktop-client/src/components/accounts/Balance.test.tsx
@@ -44,13 +44,19 @@ function makeSchedule(
} satisfies ScheduleEntity;
}
+function mockedSchedules(schedules: ScheduleEntity[]) {
+ return {
+ isLoading: false,
+ schedules,
+ statuses: new Map(),
+ statusLabels: new Map(),
+ };
+}
+
describe('SelectedBalance – normal transactions', () => {
beforeEach(() => {
vi.clearAllMocks();
- vi.mocked(useCachedSchedules).mockReturnValue({
- isLoading: false,
- schedules: [],
- });
+ vi.mocked(useCachedSchedules).mockReturnValue(mockedSchedules([]));
});
test('shows balance for selected normal transactions', () => {
@@ -93,10 +99,9 @@ describe('SelectedBalance – preview (scheduled) transactions', () => {
vi.mocked(useSelectedItems).mockReturnValue(
new Set([`preview/${scheduleId}/2026-03-24`]),
);
- vi.mocked(useCachedSchedules).mockReturnValue({
- isLoading: false,
- schedules: [makeSchedule(scheduleId, -5000, 'account-1')],
- });
+ vi.mocked(useCachedSchedules).mockReturnValue(
+ mockedSchedules([makeSchedule(scheduleId, -5000, 'account-1')]),
+ );
render(
<TestProviders>
@@ -116,10 +121,9 @@ describe('SelectedBalance – preview (scheduled) transactions', () => {
const selectedItems = new Set([previewId1, previewId2]);
vi.mocked(useSelectedItems).mockReturnValue(selectedItems);
- vi.mocked(useCachedSchedules).mockReturnValue({
- isLoading: false,
- schedules: [makeSchedule(scheduleId, -5000, 'account-1')],
- });
+ vi.mocked(useCachedSchedules).mockReturnValue(
+ mockedSchedules([makeSchedule(scheduleId, -5000, 'account-1')]),
+ );
render(
<TestProviders>
diff --git a/packages/desktop-client/src/components/settings/ThemeInstaller.test.tsx b/packages/desktop-client/src/components/settings/ThemeInstaller.test.tsx
index 004eac41be..03b65e3f47 100644
--- a/packages/desktop-client/src/components/settings/ThemeInstaller.test.tsx
+++ b/packages/desktop-client/src/components/settings/ThemeInstaller.test.tsx
@@ -9,11 +9,16 @@ import {
generateThemeId,
validateThemeCss,
} from '#style/customThemes';
+import type { CatalogTheme } from '#style/customThemes';
import { ThemeInstaller } from './ThemeInstaller';
-const render: typeof rtlRender = (ui, options) =>
- rtlRender(ui, { wrapper: TestProviders, ...options });
+function render(
+ ui: Parameters<typeof rtlRender>[0],
+ options?: Parameters<typeof rtlRender>[1],
+) {
+ return rtlRender(ui, { wrapper: TestProviders, ...options });
+}
vi.mock('#style/customThemes', async () => {
const actual = await vi.importActual('#style/customThemes');
@@ -59,10 +64,11 @@ describe('ThemeInstaller', () => {
--color-secondary: #6c757d;
}`;
- const mockCatalog = [
+ const mockCatalog: CatalogTheme[] = [
{
name: 'Demo Theme',
repo: 'actualbudget/demo-theme',
+ mode: 'dark',
colors: [
'#1a1a2e',
'#16213e',
@@ -75,6 +81,7 @@ describe('ThemeInstaller', () => {
{
name: 'Ocean Blue',
repo: 'actualbudget/ocean-theme',
+ mode: 'light',
colors: [
'#0d47a1',
'#1565c0',
@@ -87,6 +94,7 @@ describe('ThemeInstaller', () => {
{
name: 'Forest Green',
repo: 'actualbudget/forest-theme',
+ mode: 'light',
colors: [
'#1b5e20',
'#2e7d32',
diff --git a/packages/desktop-client/src/hooks/useOnVisible.test.ts b/packages/desktop-client/src/hooks/useOnVisible.test.ts
index c28e810937..7651f5b35e 100644
--- a/packages/desktop-client/src/hooks/useOnVisible.test.ts
+++ b/packages/desktop-client/src/hooks/useOnVisible.test.ts
@@ -1,3 +1,4 @@
+// @ts-strict-ignore
import { renderHook } from '@testing-library/react';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
diff --git a/packages/desktop-client/src/shared-browser-server-core.test.ts b/packages/desktop-client/src/shared-browser-server-core.test.ts
index 4915bfe4ee..8d6cb15dc3 100644
--- a/packages/desktop-client/src/shared-browser-server-core.test.ts
+++ b/packages/desktop-client/src/shared-browser-server-core.test.ts
@@ -1,3 +1,4 @@
+// @ts-strict-ignore
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import type { Mock } from 'vitest';
diff --git a/packages/desktop-client/tsconfig.json b/packages/desktop-client/tsconfig.json
index 9285906bae..2656c33675 100644
--- a/packages/desktop-client/tsconfig.json
+++ b/packages/desktop-client/tsconfig.json
@@ -30,13 +30,5 @@
}
],
"include": ["**/*.ts", "src/**/*.tsx", "src/**/*.js"],
- "exclude": [
- "node_modules",
- "build",
- "**/service-worker/**",
- "e2e",
- "**/*.test.ts",
- "**/*.test.tsx",
- "**/setupTests.ts"
- ]
+ "exclude": ["node_modules", "build", "**/service-worker/**", "e2e"]
}
diff --git a/packages/desktop-electron/e2e/tsconfig.json b/packages/desktop-electron/e2e/tsconfig.json
new file mode 100644
index 0000000000..1a05922153
--- /dev/null
+++ b/packages/desktop-electron/e2e/tsconfig.json
@@ -0,0 +1,9 @@
+{
+ "extends": "../../../tsconfig.json",
+ "compilerOptions": {
+ "composite": false,
+ "noEmit": true,
+ "types": ["@playwright/test", "node"]
+ },
+ "include": ["./**/*.ts"]
+}
diff --git a/packages/desktop-electron/tsconfig.json b/packages/desktop-electron/tsconfig.json
index 9b3930d22a..9f292504bf 100644
--- a/packages/desktop-electron/tsconfig.json
+++ b/packages/desktop-electron/tsconfig.json
@@ -32,11 +32,5 @@
}
],
"include": ["."],
- "exclude": [
- "**/node_modules/*",
- "build/**/*",
- "e2e/**/*",
- "**/*.test.ts",
- "**/*.spec.ts"
- ]
+ "exclude": ["**/node_modules/*", "build/**/*", "e2e/**/*"]
}
diff --git a/packages/loot-core/package.json b/packages/loot-core/package.json
index 3499988afe..d12aa4acb8 100644
--- a/packages/loot-core/package.json
+++ b/packages/loot-core/package.json
@@ -17,7 +17,11 @@
"!src/**/*.test.ts",
"!src/**/__tests__/**",
"!src/**/__snapshots__/**",
- "!src/**/__mocks__/**"
+ "!src/**/__mocks__/**",
+ "!@types/**/*.test.d.ts",
+ "!@types/**/*.test.d.ts.map",
+ "!@types/**/__tests__/**",
+ "!@types/**/__mocks__/**"
],
"imports": {
"#platform/server/asyncStorage": {
diff --git a/packages/loot-core/src/server/accounts/app-bank-sync.test.ts b/packages/loot-core/src/server/accounts/app-bank-sync.test.ts
index 7265ae40ed..3e389efd7a 100644
--- a/packages/loot-core/src/server/accounts/app-bank-sync.test.ts
+++ b/packages/loot-core/src/server/accounts/app-bank-sync.test.ts
@@ -1,3 +1,4 @@
+// @ts-strict-ignore
import * as db from '#server/db';
import { loadMappings } from '#server/db/mappings';
diff --git a/packages/loot-core/src/server/budget/actions.test.ts b/packages/loot-core/src/server/budget/actions.test.ts
index 929518da48..79c15ec5ea 100644
--- a/packages/loot-core/src/server/budget/actions.test.ts
+++ b/packages/loot-core/src/server/budget/actions.test.ts
@@ -1,3 +1,4 @@
+// @ts-strict-ignore
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import * as db from '#server/db';
diff --git a/packages/loot-core/src/server/budget/category-template-context.test.ts b/packages/loot-core/src/server/budget/category-template-context.test.ts
index 5615ee76ff..a10625a83a 100644
--- a/packages/loot-core/src/server/budget/category-template-context.test.ts
+++ b/packages/loot-core/src/server/budget/category-template-context.test.ts
@@ -2,6 +2,7 @@ import { vi } from 'vitest';
import * as aql from '#server/aql';
import * as db from '#server/db';
+import type { DbCategory } from '#server/db';
import { amountToInteger } from '#shared/util';
import type { CategoryEntity } from '#types/models';
import type { Template } from '#types/models/templates';
@@ -1810,7 +1811,15 @@ describe('CategoryTemplateContext', () => {
[] as Awaited<ReturnType<typeof statements.getActiveSchedules>>,
);
vi.mocked(db.getCategories).mockResolvedValue([
- { id: 'inc-1', name: 'Salary', is_income: true } as CategoryEntity,
+ {
+ id: 'inc-1',
+ name: 'Salary',
+ is_income: 1,
+ cat_group: 'g-income',
+ sort_order: 0,
+ hidden: 0,
+ tombstone: 0,
+ } satisfies DbCategory,
]);
const templates: Template[] = [
{
@@ -1861,7 +1870,7 @@ describe('CategoryTemplateContext', () => {
vi.mocked(statements.getActiveSchedules).mockResolvedValue(
[] as Awaited<ReturnType<typeof statements.getActiveSchedules>>,
);
- vi.mocked(db.getCategories).mockResolvedValue([] as CategoryEntity[]);
+ vi.mocked(db.getCategories).mockResolvedValue([] as DbCategory[]);
const templates: Template[] = [
{
type: 'percentage',
@@ -1972,8 +1981,8 @@ describe('CategoryTemplateContext', () => {
it('throws when more than one #goal directive is defined', () => {
const templates: Template[] = [
- { type: 'goal', amount: 1000, directive: 'goal', priority: null },
- { type: 'goal', amount: 2000, directive: 'goal', priority: null },
+ { type: 'goal', amount: 1000, directive: 'goal' },
+ { type: 'goal', amount: 2000, directive: 'goal' },
];
expect(
() =>
diff --git a/packages/loot-core/src/server/budget/goal-template.test.ts b/packages/loot-core/src/server/budget/goal-template.test.ts
index 056b08ff6c..ebbae38665 100644
--- a/packages/loot-core/src/server/budget/goal-template.test.ts
+++ b/packages/loot-core/src/server/budget/goal-template.test.ts
@@ -2,6 +2,7 @@ import { vi } from 'vitest';
import * as aql from '#server/aql';
import * as db from '#server/db';
+import type { DbCategory } from '#server/db';
import type { CategoryEntity } from '#types/models';
import type { Template } from '#types/models/templates';
@@ -39,7 +40,7 @@ vi.mock('./template-notes', () => ({
storeNoteTemplates: vi.fn(),
}));
-function setupSheetMock(values: Record<string, number | boolean | null>) {
+function setupSheetMock(values: Record<string, number>) {
vi.mocked(actions.getSheetValue).mockImplementation(
async (_sheet: string, key: string) => values[key] ?? 0,
);
@@ -128,7 +129,7 @@ describe('applyMultipleCategoryTemplates', () => {
vi.mocked(statements.getActiveSchedules).mockResolvedValue(
[] as Awaited<ReturnType<typeof statements.getActiveSchedules>>,
);
- vi.mocked(db.getCategories).mockResolvedValue([] as CategoryEntity[]);
+ vi.mocked(db.getCategories).mockResolvedValue([] as DbCategory[]);
});
it('writes per-category budgets and returns a success notification', async () => {
@@ -207,11 +208,15 @@ describe('applyMultipleCategoryTemplates', () => {
const budgetCalls = vi
.mocked(actions.setBudget)
.mock.calls.map(call => call[0]);
- const cat1Budget = budgetCalls.find(c => c.category === cat1.id);
- const cat2Budget = budgetCalls.find(c => c.category === cat2.id);
- expect(cat1Budget?.amount).toBe(10000);
- expect(cat2Budget?.amount).toBe(5000);
- expect((cat1Budget?.amount ?? 0) + (cat2Budget?.amount ?? 0)).toBe(15000);
+ const cat1Amount = Number(
+ budgetCalls.find(c => c.category === cat1.id)?.amount ?? 0,
+ );
+ const cat2Amount = Number(
+ budgetCalls.find(c => c.category === cat2.id)?.amount ?? 0,
+ );
+ expect(cat1Amount).toBe(10000);
+ expect(cat2Amount).toBe(5000);
+ expect(cat1Amount + cat2Amount).toBe(15000);
});
it('returns an error notification when a template fails validation', async () => {
@@ -291,11 +296,15 @@ describe('applyMultipleCategoryTemplates', () => {
const budgetCalls = vi
.mocked(actions.setBudget)
.mock.calls.map(call => call[0]);
- const cat1Budget = budgetCalls.find(c => c.category === cat1.id);
- const cat2Budget = budgetCalls.find(c => c.category === cat2.id);
- expect(cat1Budget?.amount).toBe(15000);
- expect(cat2Budget?.amount).toBe(5000);
- expect((cat1Budget?.amount ?? 0) + (cat2Budget?.amount ?? 0)).toBe(20000);
+ const cat1Amount = Number(
+ budgetCalls.find(c => c.category === cat1.id)?.amount ?? 0,
+ );
+ const cat2Amount = Number(
+ budgetCalls.find(c => c.category === cat2.id)?.amount ?? 0,
+ );
+ expect(cat1Amount).toBe(15000);
+ expect(cat2Amount).toBe(5000);
+ expect(cat1Amount + cat2Amount).toBe(20000);
});
});
@@ -318,7 +327,7 @@ describe('applyTemplate (force=false)', () => {
vi.mocked(statements.getActiveSchedules).mockResolvedValue(
[] as Awaited<ReturnType<typeof statements.getActiveSchedules>>,
);
- vi.mocked(db.getCategories).mockResolvedValue([] as CategoryEntity[]);
+ vi.mocked(db.getCategories).mockResolvedValue([] as DbCategory[]);
});
it('skips categories that already have a non-zero budget', async () => {
diff --git a/packages/loot-core/src/server/budget/schedule-template.test.ts b/packages/loot-core/src/server/budget/schedule-template.test.ts
index e236694881..19b830ef22 100644
--- a/packages/loot-core/src/server/budget/schedule-template.test.ts
+++ b/packages/loot-core/src/server/budget/schedule-template.test.ts
@@ -92,8 +92,8 @@ function mockSchedulesByName(
};
},
);
- vi.mocked(getRuleForSchedule).mockImplementation(async (sid: number) => {
- const name = names.find(n => sidByName[n] === sid) ?? names[0];
+ vi.mocked(getRuleForSchedule).mockImplementation(async id => {
+ const name = names.find(n => sidByName[n] === Number(id)) ?? names[0];
return makeRule(specsByName[name].spec);
});
vi.mocked(isTrackingBudget).mockReturnValue(false);
diff --git a/packages/loot-core/src/server/budget/template-notes.test.ts b/packages/loot-core/src/server/budget/template-notes.test.ts
index 6e9ff632ef..02841a08fd 100644
--- a/packages/loot-core/src/server/budget/template-notes.test.ts
+++ b/packages/loot-core/src/server/budget/template-notes.test.ts
@@ -291,6 +291,7 @@ function mockSchedules(): db.DbSchedule[] {
posts_transaction: 0,
tombstone: 0,
name: 'Mock Schedule 1',
+ custom_upcoming_length: null,
},
{
id: 'mock-schedule-2',
@@ -300,6 +301,7 @@ function mockSchedules(): db.DbSchedule[] {
posts_transaction: 0,
tombstone: 0,
name: 'Mock Schedule 2',
+ custom_upcoming_length: null,
},
];
}
diff --git a/packages/loot-core/tsconfig.json b/packages/loot-core/tsconfig.json
index c4122dc943..f30fd7e22a 100644
--- a/packages/loot-core/tsconfig.json
+++ b/packages/loot-core/tsconfig.json
@@ -26,13 +26,5 @@
"migrations/**/*.js",
"src/server/tests/mockData.json"
],
- "exclude": [
- "node_modules",
- "build",
- "lib-dist",
- "@types",
- "**/*.test.ts",
- "**/__tests__/**",
- "**/__mocks__/**"
- ]
+ "exclude": ["node_modules", "build", "lib-dist", "@types"]
}
diff --git a/upcoming-release-notes/7642.md b/upcoming-release-notes/7642.md
new file mode 100644
index 0000000000..75069ee34f
--- /dev/null
+++ b/upcoming-release-notes/7642.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [MatissJanis]
+---
+
+TypeScript: fix running TS on test files