Add some docs about TDD

[kasir-barati]

Please add some doc about how to mock it and how to use it while following TDD.

[ai]

I know TDD but do not understand what do you need from API.

The simplest mock is just calling store.set(mockData)

Do you have some examples of other state manager, how they explain usage in TDD?

[ai]

Moved to #182

[kasir-barati]

I know TDD but do not understand what do you need from API.

The simplest mock is just calling store.set(mockData)

Do you have some examples of other state manager, how they explain usage in TDD?

I already do it like this:

import { AxiosInstance, AxiosResponse } from 'axios';
import { allTasks, cleanStores, keepMount } from 'nanostores';
import {
    afterEach,
    beforeEach,
    describe,
    expect,
    it,
    vi,
} from 'vitest';
import { SummariesStateStore } from './Summaries.store';
import summaries from './summaries.dummy-data.json';

describe('SummariesStateStore', () => {
    const { states, actions } = SummariesStateStore;
    const mockedAxiosInstance: AxiosInstance =
        {} as Partial<AxiosInstance> as AxiosInstance;

    afterEach(() => {
        cleanStores(states.accordionIndex, states.summaries);
        states.accordionIndex.set(undefined);
        states.summaries.set([]);
    });

    describe('accordionIndexState', () => {
        beforeEach(() => {
            keepMount(states.accordionIndex);
        });

        it('should return 1 ', async () => {
            actions.setAccordionIndex(1);
            await allTasks();

            expect(states.accordionIndex.get()).toBe(1);
        });
    });

    describe('summaries', () => {
        it('should fetch summaries', async () => {
            mockedAxiosInstance.get = vi.fn().mockResolvedValueOnce({
                data: summaries,
            } as AxiosResponse);
            await actions.fetchSummaries(mockedAxiosInstance);
            await allTasks();

            expect(states.summaries.get()).toBe(summaries);
        });
    });
});

Ref: https://github.com/kasir-barati/open-ai-summaries/blob/main/apps/chrome/src/components/Summaries/Summaries.store.spec.ts

But not sure if i this is the best way or not.