readLogo.test.ts

import { describe, expect, it, vi } from "vitest";

import { readLogo } from "./readLogo.js";

const mockReadLogoSizing = vi.fn().mockResolvedValue({});

vi.mock("./readLogoSizing.js", () => ({
	get readLogoSizing() {
		return mockReadLogoSizing;
	},
}));

describe(readLogo, () => {
	describe("logo", () => {
		it("resolves undefined when an image cannot be found", async () => {
			const logo = await readLogo(() => Promise.resolve(`nothing.`));

			expect(logo).toBeUndefined();
		});

		it("resolves undefined when the found image has no src", async () => {
			const logo = await readLogo(() => Promise.resolve(`\n<img src=""/>`));

			expect(logo).toBeUndefined();
		});

		it("resolves undefined when the found image is an All Contributors badge", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(
					`\n<img alt="All Contributors: 1" src="https://img.shields.io/badge/all_contributors-1-21bb42.svg" />`,
				),
			);

			expect(logo).toBeUndefined();
		});

		it("resolves undefined when the found image is a shields.io badge", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(
					`\n<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />`,
				),
			);

			expect(logo).toBeUndefined();
		});

		it("parses when found in an unquoted string", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<img src=abc/def.jpg/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo",
				src: "abc/def.jpg",
			});
		});

		it("parses when found in a single quoted string", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<img src='abc/def.jpg'/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo",
				src: "abc/def.jpg",
			});
		});

		it("parses when found in a double quoted string", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<img src="abc/def.jpg"/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo",
				src: "abc/def.jpg",
			});
		});

		it("includes alt text when it exists in double quotes", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<img alt="Project logo: a fancy circle" src="abc/def.jpg"/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo: a fancy circle",
				src: "abc/def.jpg",
			});
		});

		it("includes alt text when it exists in single quotes", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<img alt='Project logo: a fancy circle' src='abc/def.jpg'/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo: a fancy circle",
				src: "abc/def.jpg",
			});
		});

		it("includes sizing when readLogoSizing returns sizing", async () => {
			const sizing = { height: 117, width: 128 };

			mockReadLogoSizing.mockReturnValueOnce(sizing);

			const logo = await readLogo(() =>
				Promise.resolve(`
<img alt='Project logo: a fancy circle' height='117px' src='abc/def.jpg' width=' 117px'/>`),
			);

			expect(logo).toEqual({
				alt: "Project logo: a fancy circle",
				src: "abc/def.jpg",
				...sizing,
			});
		});

		it("parses when found after a badge image", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
		<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 48" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-48-21bb42.svg" /></a>
<img src=abc/def.jpg/>
`),
			);

			expect(logo).toEqual({
				alt: "Project logo",
				src: "abc/def.jpg",
			});
		});

		it("parses when found after an h1 and many badge images", async () => {
			const logo = await readLogo(() =>
				Promise.resolve(`
<h1 align="center">Create TypeScript App</h1>

<p align="center">Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 🎁</p>

<p align="center">
	<!-- prettier-ignore-start -->
	<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
	<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 48" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-48-21bb42.svg" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
	<!-- prettier-ignore-end -->
	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="🤝 Code of Conduct: Kept" src="https://img.shields.io/badge/%F0%9F%A4%9D_code_of_conduct-kept-21bb42" /></a>
	<a href="https://codecov.io/gh/JoshuaKGoldberg/create-typescript-app" target="_blank"><img alt="🧪 Coverage" src="https://img.shields.io/codecov/c/github/JoshuaKGoldberg/create-typescript-app?label=%F0%9F%A7%AA%20coverage" /></a>
	<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/LICENSE.md" target="_blank"><img alt="📝 License: MIT" src="https://img.shields.io/badge/%F0%9F%93%9D_license-MIT-21bb42.svg"></a>
	<a href="http://npmjs.com/package/create-typescript-app"><img alt="📦 npm version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42&label=%F0%9F%93%A6%20npm" /></a>
	<img alt="💪 TypeScript: Strict" src="https://img.shields.io/badge/%F0%9F%92%AA_typescript-strict-21bb42.svg" />
</p>

<img align="right" alt="Project logo: the TypeScript blue square with rounded corners, but a plus sign instead of 'TS'" src="./docs/create-typescript-app.png">
`),
			);

			expect(logo).toEqual({
				alt: "Project logo: the TypeScript blue square with rounded corners, but a plus sign instead of 'TS'",
				src: "./docs/create-typescript-app.png",
			});
		});
	});
});