Fix typo.

longbridgeapp · Nov 14, 2023 · 80db5d4 · 80db5d4
1 parent 39f7268
commit 80db5d4
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/feishu-pages/src/doc.ts b/feishu-pages/src/doc.ts
@@ -66,13 +66,13 @@ export const fetchDocBody = async (fileDoc: Doc) => {
 };
 
 /**
- * Generate a Markdown frontmater.
+ * Generate a Markdown Frontmatter.
  * @param doc
  * @param urlPath
  * @param position
  * @returns
  */
-export const generateFrontmater = (
+export const generateFrontmatter = (
   doc: Doc,
   urlPath: string,
   position: number

diff --git a/feishu-pages/src/index.ts b/feishu-pages/src/index.ts
@@ -2,7 +2,7 @@
 import { FileToken } from 'feishu-docx';
 import fs from 'fs';
 import path from 'path';
-import { fetchDocBody, generateFrontmater } from './doc';
+import { fetchDocBody, generateFrontmatter } from './doc';
 import {
   BASE_URL,
   DOCS_DIR,
@@ -99,7 +99,7 @@ const fetchDocAndWriteFile = async (
       }
     }
 
-    const metaInfo = generateFrontmater(doc, doc.slug, doc.position);
+    const metaInfo = generateFrontmatter(doc, doc.slug, doc.position);
 
     let out = '';
     out += metaInfo + '\n\n';

diff --git a/feishu-pages/tests/doc.test.ts b/feishu-pages/tests/doc.test.ts
@@ -1,9 +1,9 @@
 import { describe, test } from '@jest/globals';
 import assert from 'node:assert';
-import { generateFrontmater } from '../src/doc';
+import { generateFrontmatter } from '../src/doc';
 
 describe('Doc', () => {
-  test('generateFrontmater', () => {
+  test('generateFrontmatter', () => {
     let doc: any = {
       title: 'Docs: "hello world"',
     };
@@ -18,7 +18,7 @@ sidebar_position: 1
 ---
 `;
 
-    assert.equal(generateFrontmater(doc, urlPath, position), expected);
+    assert.equal(generateFrontmatter(doc, urlPath, position), expected);
 
     doc = {
       title: `Docs: 'Test single quote'`,
@@ -30,7 +30,7 @@ slug: /hello/world
 sidebar_position: 1
 ---
 `;
-    assert.equal(generateFrontmater(doc, urlPath, position), expected);
+    assert.equal(generateFrontmatter(doc, urlPath, position), expected);
 
     doc = {
       title: null,
@@ -41,7 +41,7 @@ sidebar_position: 1
 ---
 `;
 
-    assert.equal(generateFrontmater(doc, urlPath, position), expected);
+    assert.equal(generateFrontmatter(doc, urlPath, position), expected);
 
     let doc1 = {
       title: null,
@@ -66,7 +66,7 @@ tools:
 `;
 
     assert.equal(
-      generateFrontmater(
+      generateFrontmatter(
         doc1 as any,
         'https://github.com/foo/bar?dar=A+B&key=#hash1',
         3