Skip to content

test: prepare for additional utils #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GalacticHypernova wants to merge 2 commits into
base: main
Choose a base branch
from
Open

test: prepare for additional utils #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb40933
test: prepare for additional utils
GalacticHypernova Jan 25, 2024
8653f12
fix: typo
GalacticHypernova Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 21 additions & 19 deletions test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,26 @@ import { expect, it, describe } from "vitest";
import { extractJSDoc } from "../src";

describe("unjsdoc", () => {
it("should extract jsdoc", () => {
const jsdoc = extractJSDoc("../playground", "hasJSDoc");
expect(jsdoc[0]).toMatchSnapshot(`
/**
* Test function with JSDoc
* @param test
* @param test2
* @returns {number}
*/`);
});
it("should return null for non-existent jsdoc", () => {
const jsdoc = extractJSDoc("../playground", "noJSDoc");
// eslint-disable-next-line unicorn/no-null
expect(jsdoc).toEqual(null);
});
it("should return null for non-existent function", () => {
const jsdoc = extractJSDoc("../playground", "noFunction");
// eslint-disable-next-line unicorn/no-null
expect(jsdoc).toEqual(null);
describe("extractJSDoc", () => {
it("should extract jsdoc", () => {
const jsdoc = extractJSDoc("../playground", "hasJSDoc");
expect(jsdoc[0]).toMatchSnapshot(`
/**
* Test function with JSDoc
* @param test
* @param test2
* @returns {number}
*/`);
});
it("should return null for non-existent jsdoc", () => {
const jsdoc = extractJSDoc("../playground", "noJSDoc");
// eslint-disable-next-line unicorn/no-null
expect(jsdoc).toEqual(null);
});
it("should return null for non-existent function", () => {
const jsdoc = extractJSDoc("../playground", "noFunction");
// eslint-disable-next-line unicorn/no-null
expect(jsdoc).toEqual(null);
});
});
});