Skip to content

Commit

Permalink
format code
Browse files Browse the repository at this point in the history
  • Loading branch information
@vishvamsinh28
vishvamsinh28 committed Dec 8, 2024
1 parent dc7e215 commit f8e7dfd
Showing 1 changed file with 77 additions and 29 deletions.
106 changes: 77 additions & 29 deletions tests/build-post-list.test.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
const fs = require('fs-extra');
const { resolve, join } = require('path');
const { TEST_CONTENT } = require("../tests/fixtures/buildPostListData");
const { TEST_CONTENT } = require('../tests/fixtures/buildPostListData');
const { buildPostList, slugifyToC } = require('../scripts/build-post-list');

describe('buildPostList', () => {
Expand All @@ -9,7 +9,10 @@ describe('buildPostList', () => {
let postDirectories;

beforeEach(async () => {
tempDir = resolve(__dirname, `test-config-${Date.now()}-${Math.random().toString(36).slice(2)}`);
tempDir = resolve(
__dirname,
`test-config-${Date.now()}-${Math.random().toString(36).slice(2)}`,
);
writeFilePath = resolve(tempDir, 'posts.json');
postDirectories = [
[join(tempDir, 'blog'), '/blog'],
Expand All @@ -20,21 +23,23 @@ describe('buildPostList', () => {
await fs.ensureDir(join(tempDir, TEST_CONTENT.blog.dir));
await fs.writeFile(
join(tempDir, TEST_CONTENT.blog.dir, TEST_CONTENT.blog.file),
TEST_CONTENT.blog.content
TEST_CONTENT.blog.content,
);

await fs.ensureDir(join(tempDir, TEST_CONTENT.docs.dir));
await fs.writeFile(
join(tempDir, TEST_CONTENT.docs.dir, TEST_CONTENT.docs.file),
TEST_CONTENT.docs.content
TEST_CONTENT.docs.content,
);

await fs.ensureDir(join(tempDir, TEST_CONTENT.docs.dir, TEST_CONTENT.docs.subDir));
await fs.ensureDir(
join(tempDir, TEST_CONTENT.docs.dir, TEST_CONTENT.docs.subDir),
);

await fs.ensureDir(join(tempDir, TEST_CONTENT.about.dir));
await fs.writeFile(
join(tempDir, TEST_CONTENT.about.dir, TEST_CONTENT.about.file),
TEST_CONTENT.about.content
TEST_CONTENT.about.content,
);
});

Expand Down Expand Up @@ -66,7 +71,7 @@ describe('buildPostList', () => {
slug: '/docs/reference/specification',
isSection: true,
}),
])
]),
);

expect(output.blog).toEqual(
Expand All @@ -75,7 +80,7 @@ describe('buildPostList', () => {
title: 'Release Notes 2.1.0',
slug: '/blog/release-notes-2.1.0',
}),
])
]),
);

expect(output.about).toEqual(
Expand All @@ -84,41 +89,53 @@ describe('buildPostList', () => {
title: 'About Us',
slug: '/about',
}),
])
]),
);

expect(output.docsTree).toBeDefined();

const blogEntry = output.blog.find(item => item.slug === '/blog/release-notes-2.1.0');
const blogEntry = output.blog.find(
(item) => item.slug === '/blog/release-notes-2.1.0',
);
expect(blogEntry).toBeDefined();
expect(blogEntry.title).toBe('Release Notes 2.1.0');
});

it('handles a directory with only section files', async () => {
await fs.ensureDir(join(tempDir, 'docs', 'section1'));
await fs.writeFile(join(tempDir, 'docs', 'section1', '_section.mdx'), '---\ntitle: Section 1\n---\nThis is section 1.');
await fs.writeFile(
join(tempDir, 'docs', 'section1', '_section.mdx'),
'---\ntitle: Section 1\n---\nThis is section 1.',
);

await buildPostList(postDirectories, tempDir, writeFilePath);

const output = JSON.parse(await fs.readFile(writeFilePath, 'utf-8'));

const sectionEntry = output.docs.find(item => item.title === 'Section 1');
const sectionEntry = output.docs.find((item) => item.title === 'Section 1');
expect(sectionEntry).toMatchObject({
title: 'Section 1',
slug: expect.stringContaining('/docs/section1'),
isSection: true
isSection: true,
});
});

it('handles multiple release notes correctly', async () => {
await fs.writeFile(join(tempDir, 'blog', 'release-notes-2.1.1.mdx'), '---\ntitle: Release Notes 2.1.1\n---\nThis is a release note.');
await fs.writeFile(
join(tempDir, 'blog', 'release-notes-2.1.1.mdx'),
'---\ntitle: Release Notes 2.1.1\n---\nThis is a release note.',
);

await buildPostList(postDirectories, tempDir, writeFilePath);

const output = JSON.parse(await fs.readFile(writeFilePath, 'utf-8'));

const firstReleaseNote = output.blog.find(item => item.slug === '/blog/release-notes-2.1.0');
const secondReleaseNote = output.blog.find(item => item.slug === '/blog/release-notes-2.1.1');
const firstReleaseNote = output.blog.find(
(item) => item.slug === '/blog/release-notes-2.1.0',
);
const secondReleaseNote = output.blog.find(
(item) => item.slug === '/blog/release-notes-2.1.1',
);

expect(firstReleaseNote).toBeDefined();
expect(firstReleaseNote.title).toBe('Release Notes 2.1.0');
Expand All @@ -129,65 +146,96 @@ describe('buildPostList', () => {

it('throws an error when accessing non-existent directory', async () => {
const invalidDir = [join(tempDir, 'non-existent-dir'), '/invalid'];
await expect(buildPostList([invalidDir], tempDir, writeFilePath)).rejects.toThrow();
await expect(
buildPostList([invalidDir], tempDir, writeFilePath),
).rejects.toThrow();
});

it('does not process specification files without a title', async () => {
const specDir = join(tempDir, 'docs', 'reference', 'specification');
await fs.writeFile(join(specDir, 'v2.1.0-no-title.mdx'), '---\n---\nContent of specification without a title.');
await fs.writeFile(
join(specDir, 'v2.1.0-no-title.mdx'),
'---\n---\nContent of specification without a title.',
);

await buildPostList(postDirectories, tempDir, writeFilePath);

const output = JSON.parse(await fs.readFile(writeFilePath, 'utf-8'));
const noTitleEntry = output.docs.find(item => item.slug.includes('/reference/specification/v2.1.0-no-title'));
const noTitleEntry = output.docs.find((item) =>
item.slug.includes('/reference/specification/v2.1.0-no-title'),
);

expect(noTitleEntry).toBeUndefined();
});

it('does not process specification files with "next-spec" in the filename', async () => {
const specDir = join(tempDir, 'docs', 'reference', 'specification');
await fs.writeFile(join(specDir, 'v2.1.0-next-spec.1.mdx'), '---\n---\nContent of pre-release specification v2.1.0-next-spec.1.');
await fs.writeFile(
join(specDir, 'v2.1.0-next-spec.1.mdx'),
'---\n---\nContent of pre-release specification v2.1.0-next-spec.1.',
);

await buildPostList(postDirectories, tempDir, writeFilePath);

const output = JSON.parse(await fs.readFile(writeFilePath, 'utf-8'));
const nextSpecEntry = output.docs.find(item => item.slug.includes('/reference/specification/v2.1.0-next-spec.1'));
const nextSpecEntry = output.docs.find((item) =>
item.slug.includes('/reference/specification/v2.1.0-next-spec.1'),
);

expect(nextSpecEntry).toBeUndefined();
});

it('does not process specification files with "explorer" in the filename', async () => {
const specDir = join(tempDir, 'docs', 'reference', 'specification');
await fs.writeFile(join(specDir, 'explorer.mdx'), '---\n---\nContent of explorer specification.');
await fs.writeFile(
join(specDir, 'explorer.mdx'),
'---\n---\nContent of explorer specification.',
);

await buildPostList(postDirectories, tempDir, writeFilePath);

const output = JSON.parse(await fs.readFile(writeFilePath, 'utf-8'));
const explorerEntry = output.docs.find(item => item.slug.includes('/reference/specification/explorer'));
const explorerEntry = output.docs.find((item) =>
item.slug.includes('/reference/specification/explorer'),
);

expect(explorerEntry).toBeUndefined();
});

it('throws "Error while building post list" when front matter is invalid', async () => {
await fs.writeFile(join(tempDir, 'docs', 'invalid.mdx'), '---\ninvalid front matter\n---\nContent');
await fs.writeFile(
join(tempDir, 'docs', 'invalid.mdx'),
'---\ninvalid front matter\n---\nContent',
);

await expect(buildPostList(postDirectories, tempDir, writeFilePath)).rejects.toThrow(/Error while building post list/);
await expect(
buildPostList(postDirectories, tempDir, writeFilePath),
).rejects.toThrow(/Error while building post list/);
});

it('throws an error if no post directories are provided', async () => {
await expect(buildPostList([], tempDir, writeFilePath)).rejects.toThrow(/Error while building post list/);
await expect(buildPostList([], tempDir, writeFilePath)).rejects.toThrow(
/Error while building post list/,
);
});

it('throws specific error message when basePath parameter is undefined', async () => {
await expect(buildPostList(postDirectories, undefined, writeFilePath)).rejects.toThrow(/Error while building post list: basePath and writeFilePath are required/);
await expect(
buildPostList(postDirectories, undefined, writeFilePath),
).rejects.toThrow(
/Error while building post list: basePath and writeFilePath are required/,
);
});

it('throws specific error message when writeFilePath parameter is undefined', async () => {
await expect(buildPostList(postDirectories, tempDir, undefined)).rejects.toThrow(/Error while building post list: basePath and writeFilePath are required/);
await expect(
buildPostList(postDirectories, tempDir, undefined),
).rejects.toThrow(
/Error while building post list: basePath and writeFilePath are required/,
);
});

describe('slugifyToC', () => {

it('handles heading ids like {# myHeadingId}', () => {
const input = '## My Heading {#custom-id}';
expect(slugifyToC(input)).toBe('custom-id');
Expand Down

0 comments on commit f8e7dfd

Please sign in to comment.