next-staticblog 0.1.4 → 0.2.0-beta.1

package/index.ts

@@ -1,25 +1,25 @@
 import fs from "fs";
 import path from "path";
-import matter from "gray-matter";
+import { matter } from "gray-matter-es";
 
-const postsDirectory = path.join(process.cwd(), "posts");
-
-export function getAllPostSlugs() {
+export function getAllPostSlugs(directory: string = "posts/") {
+  const postsDirectory = path.join(process.cwd(), directory);
   return fs.readdirSync(postsDirectory);
 }
 
-export function getAllPosts() {
-  const slugs = getAllPostSlugs();
-  return slugs.map((slug) => getPostBySlug(slug));
+export function getAllPosts(directory: string = "posts/") {
+  const slugs = getAllPostSlugs(directory);
+  return slugs.map((slug) => getPostBySlug(slug, directory));
 }
 
-export function getAllPostParams(){
-  const slugs = getAllPostSlugs();
+export function getAllPostParams(directory: string = "posts/") {
+  const slugs = getAllPostSlugs(directory);
   return slugs.map((slug) => ({ slug: slug.replace(/\.md$/, "") }));
 }
 
-export function getPostBySlug(slug: string) {
+export function getPostBySlug(slug: string, directory: string = "posts/") {
   const realSlug = slug.replace(/\.md$/, "");
+  const postsDirectory = path.join(process.cwd(), directory);
   const fullPath = path.join(postsDirectory, `${realSlug}.md`);
   const fileContents = fs.readFileSync(fullPath, "utf8");
   const { data, content } = matter(fileContents);

package/package.json

@@ -1,26 +1,29 @@
-{
-  "name": "next-staticblog",
-  "version": "0.1.4",
-  "description": "Quickly configure the markdown component in the Next.js project and create a blog page!",
-  "homepage": "https://github.com/yd-tw/next-staticblog",
-  "license": "MIT",
-  "author": "twyd",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "keywords": [
-    "next.js",
-    "markdown",
-    "blog"
-  ],
-  "scripts": {
-    "build": "tsc"
-  },
-  "dependencies": {
-    "gray-matter": "^4.0.3"
-  },
-  "devDependencies": {
-    "@types/node": "^22.13.1",
-    "typescript": "^5.7.3"
-  }
-}
+{
+  "name": "next-staticblog",
+  "version": "0.2.0-beta.1",
+  "description": "Quickly configure the markdown component in the Next.js project and create a blog page!",
+  "homepage": "https://github.com/yd-tw/next-staticblog",
+  "license": "MIT",
+  "author": "twyd",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "next.js",
+    "markdown",
+    "blog"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "gray-matter-es": "^0.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^24.10.13",
+    "@vitest/coverage-v8": "^4.0.18",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}

package/tests/fixtures/custom-posts/custom.md

@@ -0,0 +1,6 @@
+---
+title: Custom Post
+date: 2024-06-01
+---
+
+Content from custom directory.

package/tests/fixtures/posts/hello-world.md

@@ -0,0 +1,6 @@
+---
+title: Hello World
+date: 2024-01-01
+---
+
+This is the content of the hello world post.

package/tests/fixtures/posts/second-post.md

@@ -0,0 +1,9 @@
+---
+title: Second Post
+date: 2024-01-02
+tags:
+  - test
+  - blog
+---
+
+This is the second post content.

package/tests/index.test.ts

@@ -0,0 +1,157 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { fileURLToPath } from "url";
+import path from "path";
+import {
+  getAllPostSlugs,
+  getAllPosts,
+  getAllPostParams,
+  getPostBySlug,
+} from "../index.ts";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const FIXTURES_DIR = path.join(__dirname, "fixtures");
+
+beforeEach(() => {
+  vi.spyOn(process, "cwd").mockReturnValue(FIXTURES_DIR);
+});
+
+afterEach(() => {
+  vi.restoreAllMocks();
+});
+
+describe("getAllPostSlugs", () => {
+  // 回傳預設 posts 目錄中的所有檔名
+  it("returns filenames from default posts directory", () => {
+    const slugs = getAllPostSlugs();
+    expect(slugs).toEqual(
+      expect.arrayContaining(["hello-world.md", "second-post.md"])
+    );
+  });
+
+  // 回傳自訂目錄中的所有檔名
+  it("returns filenames from custom directory", () => {
+    const slugs = getAllPostSlugs("custom-posts/");
+    expect(slugs).toEqual(["custom.md"]);
+  });
+
+  // 回傳目錄中所有檔案（數量正確）
+  it("returns all files in directory", () => {
+    const slugs = getAllPostSlugs();
+    expect(slugs).toHaveLength(2);
+  });
+});
+
+describe("getAllPostParams", () => {
+  // 回傳不含 .md 副檔名的 slug 參數物件
+  it("returns slug params without .md extension", () => {
+    const params = getAllPostParams();
+    expect(params).toEqual(
+      expect.arrayContaining([{ slug: "hello-world" }, { slug: "second-post" }])
+    );
+  });
+
+  // 回傳自訂目錄中的 slug 參數
+  it("returns slug params from custom directory", () => {
+    const params = getAllPostParams("custom-posts/");
+    expect(params).toEqual([{ slug: "custom" }]);
+  });
+
+  // 確保所有 slug 都已移除 .md 副檔名
+  it("strips .md extension from all slugs", () => {
+    const params = getAllPostParams();
+    for (const param of params) {
+      expect(param.slug).not.toMatch(/\.md$/);
+    }
+  });
+});
+
+describe("getPostBySlug", () => {
+  // 使用不含副檔名的 slug 取得文章資料
+  it("returns post data for slug without extension", () => {
+    const post = getPostBySlug("hello-world");
+    expect(post.slug).toBe("hello-world");
+    expect(post.metadata.title).toBe("Hello World");
+    expect(post.content).toContain("This is the content of the hello world post.");
+  });
+
+  // 使用含 .md 副檔名的 slug 取得文章資料
+  it("returns post data for slug with .md extension", () => {
+    const post = getPostBySlug("hello-world.md");
+    expect(post.slug).toBe("hello-world");
+    expect(post.metadata.title).toBe("Hello World");
+  });
+
+  // 正確解析 frontmatter 中的 metadata
+  it("parses frontmatter metadata correctly", () => {
+    const post = getPostBySlug("second-post");
+    expect(post.metadata.title).toBe("Second Post");
+    expect(post.metadata.tags).toEqual(["test", "blog"]);
+  });
+
+  // 回傳內容不包含 frontmatter 區塊
+  it("returns content without frontmatter", () => {
+    const post = getPostBySlug("second-post");
+    expect(post.content).toContain("This is the second post content.");
+    expect(post.content).not.toContain("---");
+  });
+
+  // 可從自訂目錄中取得文章
+  it("returns post from custom directory", () => {
+    const post = getPostBySlug("custom", "custom-posts/");
+    expect(post.slug).toBe("custom");
+    expect(post.metadata.title).toBe("Custom Post");
+    expect(post.content).toContain("Content from custom directory.");
+  });
+
+  // 回傳的 slug 永遠不包含 .md 副檔名
+  it("returned slug never has .md extension", () => {
+    const postWithExt = getPostBySlug("hello-world.md");
+    const postWithoutExt = getPostBySlug("hello-world");
+    expect(postWithExt.slug).toBe("hello-world");
+    expect(postWithoutExt.slug).toBe("hello-world");
+  });
+});
+
+describe("getAllPosts", () => {
+  // 回傳預設目錄中的所有文章
+  it("returns all posts from default directory", () => {
+    const posts = getAllPosts();
+    expect(posts).toHaveLength(2);
+  });
+
+  // 回傳的文章物件結構正確
+  it("returns posts with correct structure", () => {
+    const posts = getAllPosts();
+    for (const post of posts) {
+      expect(post).toHaveProperty("slug");
+      expect(post).toHaveProperty("metadata");
+      expect(post).toHaveProperty("content");
+    }
+  });
+
+  // 所有文章的 slug 都不包含 .md 副檔名
+  it("returns posts with slugs without .md extension", () => {
+    const posts = getAllPosts();
+    for (const post of posts) {
+      expect(post.slug).not.toMatch(/\.md$/);
+    }
+  });
+
+  // 可從自訂目錄取得文章列表
+  it("returns posts from custom directory", () => {
+    const posts = getAllPosts("custom-posts/");
+    expect(posts).toHaveLength(1);
+    expect(posts[0].slug).toBe("custom");
+    expect(posts[0].metadata.title).toBe("Custom Post");
+  });
+
+  // 所有回傳的文章內容都不是空字串
+  it("all returned posts have non-empty content", () => {
+    const posts = getAllPosts();
+    for (const post of posts) {
+      expect(post.content.trim().length).toBeGreaterThan(0);
+    }
+  });
+});

package/tsconfig.json

@@ -1,6 +1,7 @@
 {
+  "exclude": ["tests/**", "node_modules"],
   "compilerOptions": {
-    "target": "es2016",
+    "target": "es2017",
     "module": "esnext",
     "moduleResolution": "bundler",
     "outDir": "./dist",

package/dist/index.d.ts

@@ -1,18 +0,0 @@
-export declare function getAllPostSlugs(): string[];
-export declare function getAllPosts(): {
-    slug: string;
-    metadata: {
-        [key: string]: any;
-    };
-    content: string;
-}[];
-export declare function getAllPostParams(): {
-    slug: string;
-}[];
-export declare function getPostBySlug(slug: string): {
-    slug: string;
-    metadata: {
-        [key: string]: any;
-    };
-    content: string;
-};

package/dist/index.js

@@ -1,22 +0,0 @@
-import fs from "fs";
-import path from "path";
-import matter from "gray-matter";
-const postsDirectory = path.join(process.cwd(), "posts");
-export function getAllPostSlugs() {
-    return fs.readdirSync(postsDirectory);
-}
-export function getAllPosts() {
-    const slugs = getAllPostSlugs();
-    return slugs.map((slug) => getPostBySlug(slug));
-}
-export function getAllPostParams() {
-    const slugs = getAllPostSlugs();
-    return slugs.map((slug) => ({ slug: slug.replace(/\.md$/, "") }));
-}
-export function getPostBySlug(slug) {
-    const realSlug = slug.replace(/\.md$/, "");
-    const fullPath = path.join(postsDirectory, `${realSlug}.md`);
-    const fileContents = fs.readFileSync(fullPath, "utf8");
-    const { data, content } = matter(fileContents);
-    return { slug: realSlug, metadata: data, content };
-}