docs: convert to typescript (#658)

6 files changed, 13 insertions, 8 deletions

diff --git a/docs/.vitepress/.gitignore b/docs/.vitepress/.gitignore
index 1af560a8..3b0c8abc 100644
--- a/docs/.vitepress/.gitignore
+++ b/docs/.vitepress/.gitignore
@@ -1 +1 @@
-api-pages.mjs
+api-pages.ts
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.ts
index 8c15b49d..ade58400 100644
--- a/docs/.vitepress/config.mjs
+++ b/docs/.vitepress/config.ts
@@ -1,7 +1,8 @@
+import type { DefaultTheme } from 'vitepress';
 import { defineConfig } from 'vitepress';
-import { apiPages } from './api-pages.mjs';
+import { apiPages } from './api-pages';
 
-const nav = [
+const nav: DefaultTheme.NavItem[] = [
   { text: 'Guide', link: '/guide/' },
   {
     text: 'Ecosystem',
@@ -14,7 +15,7 @@ const nav = [
   // { text: 'Playground', link: '/playground/' },
 ];
 
-const sidebar = {
+const sidebar: DefaultTheme.MultiSideBarConfig = {
   '/': [
     {
       text: 'Guide',
@@ -40,7 +41,7 @@ const sidebar = {
   ],
 };
 
-const algolia = {
+const algolia: DefaultTheme.AlgoliaSearchOptions = {
   apiKey: process.env.API_KEY,
   appId: process.env.APP_ID,
   indexName: 'fakerjs',
diff --git a/docs/.vitepress/theme/components/index.mjs b/docs/.vitepress/theme/components/index.ts
index 4b77998a..4b77998a 100644
--- a/docs/.vitepress/theme/components/index.mjs
+++ b/docs/.vitepress/theme/components/index.ts
diff --git a/docs/.vitepress/theme/components/vue.d.ts b/docs/.vitepress/theme/components/vue.d.ts
new file mode 100644
index 00000000..939fef48
--- /dev/null
+++ b/docs/.vitepress/theme/components/vue.d.ts
@@ -0,0 +1,4 @@
+declare module '*.vue' {
+  const component: any;
+  export default component;
+}
diff --git a/docs/.vitepress/theme/index.mjs b/docs/.vitepress/theme/index.ts
index e4f3534f..e4f3534f 100644
--- a/docs/.vitepress/theme/index.mjs
+++ b/docs/.vitepress/theme/index.ts
diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts
index 1282ad4c..5d37585d 100644
--- a/scripts/apidoc/apiDocsWriter.ts
+++ b/scripts/apidoc/apiDocsWriter.ts
@@ -7,7 +7,7 @@ import type { Method } from '../../docs/.vitepress/components/api-docs/method';
 import type { PageIndex } from './utils';
 import { pathDocsDir, pathOutputDir } from './utils';
 
-const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.mjs');
+const pathDocsApiPages = resolve(pathDocsDir, '.vitepress', 'api-pages.ts');
 
 const scriptCommand = 'pnpm run generate:api-docs';
 
@@ -133,8 +133,8 @@ export const ${lowerModuleName}: Method[] = ${JSON.stringify(
  * @param pages The pages to write into the index.
  */
 export function writeApiPagesIndex(pages: PageIndex): void {
-  // Write api-pages.mjs
-  console.log('Updating api-pages.mjs');
+  // Write api-pages.ts
+  console.log('Updating api-pages.ts');
   pages.sort((a, b) => a.text.localeCompare(b.text));
   let apiPagesContent = `
     // This file is automatically generated.