jsdoczoom 0.4.11 → 0.4.13

package/dist/test/eslint-plugin.test.js

@@ -1,291 +0,0 @@
-import { Linter } from "eslint";
-import { describe, expect, it } from "vitest";
-import plugin from "../src/eslint-plugin.js";
-
-/**
- * Tests for the custom jsdoczoom ESLint plugin rules that validate
- * file-level JSDoc presence, @summary tags, and descriptions.
- *
- * @summary Tests for custom jsdoczoom ESLint plugin rules
- */
-const linter = new Linter();
-const config = {
-	plugins: { jsdoczoom: plugin },
-	rules: {
-		"jsdoczoom/require-file-jsdoc": "error",
-		"jsdoczoom/require-file-summary": "error",
-		"jsdoczoom/require-file-description": "error",
-		"jsdoczoom/require-file-ordering": "warn",
-	},
-	languageOptions: {
-		ecmaVersion: "latest",
-		sourceType: "module",
-	},
-};
-function verify(code) {
-	return linter.verify(code, config);
-}
-function ruleIds(messages) {
-	return messages.filter((m) => m.ruleId !== null).map((m) => m.ruleId);
-}
-function messageIds(messages) {
-	return messages
-		.filter((m) => m.messageId !== undefined)
-		.map((m) => m.messageId);
-}
-// ---------------------------------------------------------------------------
-// require-file-jsdoc
-// ---------------------------------------------------------------------------
-describe("jsdoczoom/require-file-jsdoc", () => {
-	it("valid file passes all rules", () => {
-		const code = [
-			"/** Description.",
-			" * @summary Summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(messages).toHaveLength(0);
-	});
-	it("missing JSDoc fails require-file-jsdoc", () => {
-		const code = "export const x = 1;";
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-jsdoc");
-		expect(messageIds(messages)).toContain("missingFileJsdoc");
-	});
-	it("JSDoc after imports is valid", () => {
-		const code = [
-			'import { x } from "y";',
-			"/** Desc",
-			" * @summary S */",
-			"export const z = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(messages).toHaveLength(0);
-	});
-	it("file with only imports and JSDoc passes", () => {
-		const code = [
-			"/** Desc",
-			" * @summary S */",
-			'import { x } from "y";',
-		].join("\n");
-		const messages = verify(code);
-		expect(messages).toHaveLength(0);
-	});
-	it("/*** triple-asterisk block is ignored", () => {
-		const code = ["/*** Desc", " * @summary S */", "export const x = 1;"].join(
-			"\n",
-		);
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-jsdoc");
-		expect(messageIds(messages)).toContain("missingFileJsdoc");
-	});
-});
-// ---------------------------------------------------------------------------
-// require-file-summary
-// ---------------------------------------------------------------------------
-describe("jsdoczoom/require-file-summary", () => {
-	it("missing @summary fails require-file-summary", () => {
-		const code = ["/** Description only */", "export const x = 1;"].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-summary");
-		expect(messageIds(messages)).toContain("missingSummary");
-	});
-	it("multiple @summary fails require-file-summary", () => {
-		const code = [
-			"/** Desc",
-			" * @summary First",
-			" * @summary Second */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-summary");
-		expect(messageIds(messages)).toContain("multipleSummary");
-	});
-	it("whitespace-only @summary is skipped", () => {
-		const code = [
-			"/** Desc",
-			" * @summary   ",
-			" * @summary Real summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		// Only one non-whitespace @summary, so should pass (no multipleSummary)
-		const summaryMessages = messages.filter(
-			(m) => m.ruleId === "jsdoczoom/require-file-summary",
-		);
-		expect(summaryMessages).toHaveLength(0);
-	});
-	it("case-sensitive @summary enforcement — @Summary not recognized", () => {
-		const code = [
-			"/** Desc",
-			" * @Summary Not recognized */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-summary");
-		expect(messageIds(messages)).toContain("missingSummary");
-	});
-	it("multi-line @summary content is joined — counts as one summary", () => {
-		const code = [
-			"/** Desc.",
-			" * @summary Multi",
-			" * line summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		// One @summary with multi-line content — should pass
-		const summaryMessages = messages.filter(
-			(m) => m.ruleId === "jsdoczoom/require-file-summary",
-		);
-		expect(summaryMessages).toHaveLength(0);
-	});
-	it("no report when file-level JSDoc is missing (rule 1 handles that)", () => {
-		const code = "export const x = 1;";
-		const messages = verify(code);
-		// require-file-summary should NOT report — only require-file-jsdoc reports
-		expect(ruleIds(messages)).not.toContain("jsdoczoom/require-file-summary");
-	});
-});
-// ---------------------------------------------------------------------------
-// require-file-description
-// ---------------------------------------------------------------------------
-describe("jsdoczoom/require-file-description", () => {
-	it("missing description fails require-file-description", () => {
-		const code = ["/** @summary Summary only */", "export const x = 1;"].join(
-			"\n",
-		);
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-description");
-		expect(messageIds(messages)).toContain("missingDescription");
-	});
-	it("@desc tag counts as description", () => {
-		const code = [
-			"/** @desc Description here",
-			" * @summary Summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-	it("@description tag counts as description", () => {
-		const code = [
-			"/** @description Desc",
-			" * @summary S */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-	it("@file tag counts as description", () => {
-		const code = [
-			"/** @file Desc",
-			" * @summary S */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-	it("@fileoverview tag counts as description (case-insensitive)", () => {
-		const code = [
-			"/** @fileoverview Desc",
-			" * @summary S */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-	it("free-text before @tags counts as description", () => {
-		const code = [
-			"/** This is a description.",
-			" * @summary Summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-	it("no report when file-level JSDoc is missing (rule 1 handles that)", () => {
-		const code = "export const x = 1;";
-		const messages = verify(code);
-		// require-file-description should NOT report
-		expect(ruleIds(messages)).not.toContain(
-			"jsdoczoom/require-file-description",
-		);
-	});
-});
-// ---------------------------------------------------------------------------
-// require-file-ordering
-// ---------------------------------------------------------------------------
-describe("jsdoczoom/require-file-ordering", () => {
-	it("valid: description before tags produces no ordering messages", () => {
-		const code = [
-			"/** Description here.",
-			" * @summary Summary */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		const orderingMessages = messages.filter(
-			(m) => m.ruleId === "jsdoczoom/require-file-ordering",
-		);
-		expect(orderingMessages).toHaveLength(0);
-	});
-	it("invalid: description after tags produces descriptionAfterTags", () => {
-		const code = [
-			"/** @summary Summary",
-			" * Description after tag */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-ordering");
-		expect(messageIds(messages)).toContain("descriptionAfterTags");
-	});
-	it("invalid: duplicate file-level JSDoc blocks produces duplicateFileJsdoc", () => {
-		const code = [
-			"/** First block.",
-			" * @summary S1 */",
-			"/** Second block.",
-			" * @summary S2 */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		expect(ruleIds(messages)).toContain("jsdoczoom/require-file-ordering");
-		expect(messageIds(messages)).toContain("duplicateFileJsdoc");
-	});
-	it("valid: tag continuation lines are not false positives", () => {
-		const code = [
-			"/** Description.",
-			" * @summary Multi-line",
-			" * summary continuation */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		const orderingMessages = messages.filter(
-			(m) => m.ruleId === "jsdoczoom/require-file-ordering",
-		);
-		expect(orderingMessages).toHaveLength(0);
-	});
-	it("valid: single JSDoc block with correct ordering produces no messages", () => {
-		const code = [
-			"/** This file does something important.",
-			" *",
-			" * It has multiple description lines.",
-			" *",
-			" * @summary Important file */",
-			"export const x = 1;",
-		].join("\n");
-		const messages = verify(code);
-		const orderingMessages = messages.filter(
-			(m) => m.ruleId === "jsdoczoom/require-file-ordering",
-		);
-		expect(orderingMessages).toHaveLength(0);
-	});
-});

package/dist/test/file-discovery.test.js

@@ -1,72 +0,0 @@
-import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { describe, expect, it } from "vitest";
-import { JsdocError } from "../src/errors.js";
-import { discoverFiles } from "../src/file-discovery.js";
-
-/**
- * Verifies glob matching, .d.ts exclusion, single-path resolution, and
- * FILE_NOT_FOUND error behavior for the file discovery module.
- *
- * @summary Tests for file discovery via glob patterns and direct paths
- */
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const fixturesDir = resolve(__dirname, "fixtures");
-const leafFilesDir = resolve(fixturesDir, "leaf-files");
-describe("discoverFiles", () => {
-	it("glob matches .ts and .tsx files", () => {
-		const results = discoverFiles("**/*.ts", leafFilesDir);
-		expect(results.length).toBeGreaterThan(0);
-		for (const f of results) {
-			expect(f).toMatch(/\.ts$/);
-		}
-	});
-	it("glob excludes .d.ts files", () => {
-		// Create a temp directory with .ts, .tsx, and .d.ts files
-		const tmpDir = mkdtempSync(resolve(tmpdir(), "jsdoczoom-test-"));
-		try {
-			writeFileSync(resolve(tmpDir, "real.ts"), "export const a = 1;");
-			writeFileSync(resolve(tmpDir, "component.tsx"), "export const b = 2;");
-			writeFileSync(resolve(tmpDir, "real.d.ts"), "declare const a: number;");
-			const results = discoverFiles("**/*.ts", tmpDir);
-			expect(results).toHaveLength(1);
-			expect(results[0]).toMatch(/real\.ts$/);
-			expect(results[0]).not.toMatch(/\.d\.ts$/);
-			// Also check .tsx is matched with its own pattern
-			const tsxResults = discoverFiles("**/*.tsx", tmpDir);
-			expect(tsxResults).toHaveLength(1);
-			expect(tsxResults[0]).toMatch(/component\.tsx$/);
-		} finally {
-			rmSync(tmpDir, { recursive: true });
-		}
-	});
-	it("glob returns empty array when no matches", () => {
-		const results = discoverFiles("nonexistent/**/*.ts", leafFilesDir);
-		expect(results).toEqual([]);
-	});
-	it("path resolves to single-element array", () => {
-		const filePath = "one-summary.ts";
-		const results = discoverFiles(filePath, leafFilesDir);
-		expect(results).toHaveLength(1);
-		expect(results[0]).toBe(resolve(leafFilesDir, filePath));
-	});
-	it("directory path returns discovered .ts/.tsx files within it", () => {
-		const dirResults = discoverFiles(leafFilesDir, "/");
-		const globResults = discoverFiles(`${leafFilesDir}/**`, "/");
-		expect(dirResults.length).toBeGreaterThan(0);
-		expect(dirResults).toEqual(globResults);
-	});
-	it("path throws FILE_NOT_FOUND for missing file", () => {
-		expect(() => discoverFiles("does-not-exist.ts", leafFilesDir)).toThrow(
-			JsdocError,
-		);
-		try {
-			discoverFiles("does-not-exist.ts", leafFilesDir);
-		} catch (error) {
-			expect(error).toBeInstanceOf(JsdocError);
-			expect(error.code).toBe("FILE_NOT_FOUND");
-		}
-	});
-});