docs: generate docs for fake() and unique() (#564)

1 files changed, 135 insertions, 0 deletions

diff --git a/scripts/apidoc/apiDocsWriter.ts b/scripts/apidoc/apiDocsWriter.ts
new file mode 100644
index 00000000..e2b42816
--- /dev/null
+++ b/scripts/apidoc/apiDocsWriter.ts
@@ -0,0 +1,135 @@
+import { writeFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import type { Options } from 'prettier';
+import { format } from 'prettier';
+import prettierConfig from '../../.prettierrc.cjs';
+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 scriptCommand = 'pnpm run generate:api-docs';
+
+const prettierMarkdown: Options = {
+  ...prettierConfig,
+  parser: 'markdown',
+};
+
+const prettierTypescript: Options = {
+  ...prettierConfig,
+  parser: 'typescript',
+};
+
+const prettierBabel: Options = {
+  ...prettierConfig,
+  parser: 'babel',
+};
+
+/**
+ * Writes the api page for the given module to the correct location.
+ *
+ * @param moduleName The name of the module to write the docs for.
+ * @param lowerModuleName The lowercase name of the module.
+ * @param comment The module comments.
+ */
+export function writeApiDocsModulePage(
+  moduleName: string,
+  lowerModuleName: string,
+  comment: string
+): void {
+  // Write api docs page
+  let content = `
+  <script setup>
+  import ApiDocsMethod from '../.vitepress/components/api-docs/method.vue'
+  import { ${lowerModuleName} } from './${lowerModuleName}'
+  import { ref } from 'vue';
+
+  const methods = ref(${lowerModuleName});
+  </script>
+
+  # ${moduleName}
+
+  <!-- This file is automatically generated. -->
+  <!-- Run '${scriptCommand}' to update -->
+
+  ::: v-pre
+
+  ${comment}
+
+  :::
+
+  <ApiDocsMethod v-for="method of methods" :key="method.name" :method="method" v-once />
+  `.replace(/\n +/g, '\n');
+
+  content = format(content, prettierMarkdown);
+
+  writeFileSync(resolve(pathOutputDir, lowerModuleName + '.md'), content);
+}
+
+/**
+ * Writes the api page for the given method to the correct location.
+ *
+ * @param methodName The name of the method to write the docs for.
+ */
+export function writeApiDocsDirectPage(methodName: string): void {
+  let content = `
+  <script setup>
+  import ApiDocsMethod from '../.vitepress/components/api-docs/method.vue'
+  import { ${methodName} } from './${methodName}'
+  import { ref } from 'vue';
+
+  const methods = ref(${methodName});
+  </script>
+
+  <ApiDocsMethod v-for="method of methods" :key="method.name" :method="method" v-once />
+  `.replace(/\n +/g, '\n');
+
+  content = format(content, prettierMarkdown);
+
+  writeFileSync(resolve(pathOutputDir, methodName + '.md'), content);
+}
+
+/**
+ * Writes the api docs data to correct location.
+ *
+ * @param lowerModuleName The lowercase name of the module.
+ * @param methods The methods data to save.
+ */
+export function writeApiDocsData(
+  lowerModuleName: string,
+  methods: Method[]
+): void {
+  let contentTs = `
+import type { Method } from '../.vitepress/components/api-docs/method';
+
+export const ${lowerModuleName}: Method[] = ${JSON.stringify(
+    methods,
+    null,
+    2
+  )}`;
+
+  contentTs = format(contentTs, prettierTypescript);
+
+  writeFileSync(resolve(pathOutputDir, lowerModuleName + '.ts'), contentTs);
+}
+
+/**
+ * Writes the api docs index to correct location.
+ *
+ * @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');
+  pages.sort((a, b) => a.text.localeCompare(b.text));
+  let apiPagesContent = `
+    // This file is automatically generated.
+    // Run '${scriptCommand}' to update
+    export const apiPages = ${JSON.stringify(pages)};
+    `.replace(/\n +/, '\n');
+
+  apiPagesContent = format(apiPagesContent, prettierBabel);
+
+  writeFileSync(pathDocsApiPages, apiPagesContent);
+}