How to add tests

[yaten2302]

Hi @rickstaa, @qwerty541,

I was having a doubt that how should the test be added? Like for this PR - card width of gist card, how should I add the tests for this?

[rickstaa]

@yaten2302, thanks for contributing to GRS 🎉. The tests of the gist card are found in the tests/renderGistCard.test.js file. We use jest as our testing provider. You can check out the CONTRIBUTING.md to see how to run and debug tests.

For your specific use case since the card_width parameter is already present in the stats card, you can use the tests defined there:

github-readme-stats/tests/renderStatsCard.test.js

Lines 78 to 122 in b0bb994

	it("should render with custom width set", () => {
	document.body.innerHTML = renderStatsCard(stats);
	expect(document.querySelector("svg")).toHaveAttribute("width", "495");
	document.body.innerHTML = renderStatsCard(stats, { card_width: 400 });
	expect(document.querySelector("svg")).toHaveAttribute("width", "400");
	});
	it("should render with custom width set and limit minimum width", () => {
	document.body.innerHTML = renderStatsCard(stats, { card_width: 1 });
	expect(document.querySelector("svg")).toHaveAttribute("width", "340");
	document.body.innerHTML = renderStatsCard(stats, {
	card_width: 1,
	hide_rank: true,
	});
	expect(document.querySelector("svg")).toHaveAttribute(
	"width",
	"305.81250000000006",
	);
	document.body.innerHTML = renderStatsCard(stats, {
	card_width: 1,
	hide_rank: true,
	show_icons: true,
	});
	expect(document.querySelector("svg")).toHaveAttribute(
	"width",
	"305.81250000000006",
	);
	document.body.innerHTML = renderStatsCard(stats, {
	card_width: 1,
	hide_rank: false,
	show_icons: true,
	});
	expect(document.querySelector("svg")).toHaveAttribute("width", "356");
	document.body.innerHTML = renderStatsCard(stats, {
	card_width: 1,
	hide_rank: false,
	show_icons: false,
	});
	expect(document.querySelector("svg")).toHaveAttribute("width", "340");
	});

[yaten2302]

@rickstaa, can I simply copy these tests to the tests/renderGistCard.test.js file, after changing the renderStatsCard to renderGistCard?

[rickstaa]

Thats correct. You might, however, need to change the width values to make them pass.